Merge pull request #78326 from skopacz1/OSDOCS-11056

OSDOCS#11056: Agent docs cleanup

Author: skopacz1

installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc

@@ -8,7 +8,7 @@ toc::[]
 
 Use the following procedures to install an {product-title} cluster using the Agent-based Installer.
 
-[id="prerequisites_installing-with-agent-based-installer"]
+[id="prerequisites_installing-with-agent-based-installer_{context}"]
 == Prerequisites
 
 * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
@@ -17,15 +17,15 @@ Use the following procedures to install an {product-title} cluster using the Age
 
 
 // This anchor ID is extracted/replicated from the former installing-ocp-agent.adoc module to preserve links.
-[id="installing-ocp-agent_installing-with-agent-based-installer"]
+[id="installing-ocp-agent_installing-with-agent-based-installer_{context}"]
 == Installing {product-title} with the Agent-based Installer
 
 The following procedures deploy a single-node {product-title} in a disconnected environment. You can use these procedures as a basis and modify according to your requirements.
 
 // Downloading the Agent-based Installer
 include::modules/installing-ocp-agent-download.adoc[leveloffset=+2]
 
-//Verifying architectures
+// Verifying the supported architecture for an Agent-based installation
 include::modules/agent-installer-architectures.adoc[leveloffset=+2]
 
 // Creating the preferred configuration inputs
@@ -38,9 +38,9 @@ include::modules/installing-ocp-agent-inputs.adoc[leveloffset=+2]
 * xref:../../installing/installing_with_agent_based_installer/understanding-disconnected-installation-mirroring.adoc#configuring-the-agent-based-installer-to-use-mirrored-images[Configuring the Agent-based Installer to use mirrored images]
 
 [id="installing-ocp-agent-opt-manifests_{context}"]
-=== Optional: Creating additional manifest files
+=== Creating additional manifest files
 
-You can create additional manifests to further configure your cluster beyond the configurations available in the `install-config.yaml` and `agent-config.yaml` files.
+As an optional task, you can create additional manifests to further configure your cluster beyond the configurations available in the `install-config.yaml` and `agent-config.yaml` files.
 
 // Creating a directory to contain additional manifests
 include::modules/installing-ocp-agent-manifest-folder.adoc[leveloffset=+3]
@@ -52,7 +52,7 @@ include::modules/installing-ocp-agent-manifest-folder.adoc[leveloffset=+3]
 // Partitioning the disk
 include::modules/installation-user-infra-machines-advanced.adoc[leveloffset=+3]
 
-// Optional: Using ZTP manifests
+// Using ZTP manifests
 include::modules/installing-ocp-agent-ZTP.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
@@ -61,7 +61,7 @@ include::modules/installing-ocp-agent-ZTP.adoc[leveloffset=+2]
 
 * See xref:../../edge_computing/ztp-deploying-far-edge-clusters-at-scale.adoc#ztp-deploying-far-edge-clusters-at-scale[Challenges of the network far edge] to learn more about {ztp-first}.
 
-// Optional: Encrypting the disk
+// Encrypting the disk
 include::modules/installing-ocp-agent-encrypt.adoc[leveloffset=+2]
 
 [role="_additional-resources"]

installing/installing_with_agent_based_installer/prepare-pxe-assets-agent.adoc

@@ -10,7 +10,9 @@ Use the following procedures to create the assets needed to PXE boot an {product
 
 The assets you create in these procedures will deploy a single-node {product-title} installation. You can use these procedures as a basis and modify configurations according to your requirements.
 
-[id="prerequisites_prepare-pxe-assets-agent"]
+See xref:../../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-with-agent-based-installer[Installing an {product-title} cluster with the Agent-based Installer] to learn about more configurations available with the Agent-based Installer.
+
+[id="prerequisites_prepare-pxe-assets-agent_{context}"]
 == Prerequisites
 
 * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
@@ -39,10 +41,10 @@ include::modules/installing-ocp-agent-ibm-z.adoc[leveloffset=+1]
 // Adding {ibm-z-title} agents with z/VM
 include::modules/installing-ocp-agent-ibm-z-zvm.adoc[leveloffset=+2]
 
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../installing/installing_ibm_z/installing-ibm-z.adoc#installing-ibm-z[Installing a cluster with z/VM on {ibm-z-title} and {ibm-linuxone-title}]
+
 // Adding {ibm-z-name} agents with {op-system-base} KVM
 include::modules/installing-ocp-agent-ibm-z-kvm.adoc[leveloffset=+2]
-
-[role="_additional-resources"]
-[id="additional-resources_prepare-pxe-assets-agent"]
-== Additional resources
-* See xref:../../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-with-agent-based-installer[Installing an {product-title} cluster with the Agent-based Installer] to learn about more configurations available with the Agent-based Installer.

modules/agent-installer-architectures.adoc

@@ -4,7 +4,7 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="agent-install-verifying-architectures_{context}"]
-= Verifying the supported architecture for installing an Agent-based Installer cluster
+= Verifying the supported architecture for an Agent-based installation
 
 Before installing an {product-title} cluster using the Agent-based Installer, you can verify the supported architecture on which you can install the cluster. This procedure is optional.
 

modules/installing-ocp-agent-ZTP.adoc

@@ -4,9 +4,9 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="installing-ocp-agent-ztp_{context}"]
-= Optional: Using ZTP manifests
+= Using ZTP manifests
 
-You can use {ztp-first} manifests to configure your installation beyond the options available through the `install-config.yaml` and `agent-config.yaml` files.
+As an optional task, you can use {ztp-first} manifests to configure your installation beyond the options available through the `install-config.yaml` and `agent-config.yaml` files.
 
 [NOTE]
 ====
@@ -22,7 +22,7 @@ If you chose to configure the `install-config.yaml` and `agent-config.yaml` file
 
 .Procedure
 
-. Use the following command to generate ZTP cluster manifests:
+. Generate ZTP cluster manifests by running the following command:
 +
 [source,terminal]
 ----
@@ -36,7 +36,7 @@ If you have created the `install-config.yaml` and `agent-config.yaml` files, tho
 Any configurations made to the `install-config.yaml` and `agent-config.yaml` files are imported to the ZTP cluster manifests when you run the `openshift-install agent create cluster-manifests` command.
 ====
 
-. Navigate to the `cluster-manifests` directory:
+. Navigate to the `cluster-manifests` directory by running the following command:
 +
 [source,terminal]
 ----
@@ -48,7 +48,7 @@ For sample files, see the "Sample GitOps ZTP custom resources" section.
 
 . Disconnected clusters: If you did not define mirror configuration in the `install-config.yaml` file before generating the ZTP manifests, perform the following steps:
 
-.. Navigate to the `mirror` directory:
+.. Navigate to the `mirror` directory by running the following command:
 +
 [source,terminal]
 ----

modules/installing-ocp-agent-download.adoc

@@ -21,6 +21,6 @@ Use this procedure to download the Agent-based Installer and the CLI needed for
 
 . Click *Download Installer* to download and extract the install program.
 
-. You can either download or copy the pull secret by clicking on *Download pull secret* or *Copy pull secret*.
+. Download or copy the pull secret by clicking on *Download pull secret* or *Copy pull secret*.
 
 . Click *Download command-line tools* and place the `openshift-install` binary in a directory that is on your `PATH`.

modules/installing-ocp-agent-encrypt.adoc

@@ -4,9 +4,9 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="installing-ocp-agent-encrypt_{context}"]
-= Optional: Encrypting the disk
+= Encrypting the disk
 
-Use this procedure to encrypt your disk or partition while installing {product-title} with the Agent-based Installer.
+As an optional task, you can use this procedure to encrypt your disk or partition while installing {product-title} with the Agent-based Installer.
 
 .Prerequisites
 
@@ -16,7 +16,7 @@ Use this procedure to encrypt your disk or partition while installing {product-t
 
 .Procedure
 
-. Use the following command to generate ZTP cluster manifests:
+. Generate ZTP cluster manifests by running the following command:
 +
 [source,terminal]
 ----
@@ -35,7 +35,7 @@ Any configurations made to the `install-config.yaml` and `agent-config.yaml` fil
 If you have already generated ZTP manifests, skip this step.
 ====
 
-. Navigate to the `cluster-manifests` directory:
+. Navigate to the `cluster-manifests` directory by running the following command:
 +
 [source,terminal]
 ----
@@ -51,6 +51,6 @@ diskEncryption:
     mode: tang <2>
     tangServers: "server1": "http://tang-server-1.example.com:7500" <3>
 ----
-<1> Specify which nodes to enable disk encryption on. Valid values are 'none', 'all', 'master', and 'worker'.
-<2> Specify which disk encryption mode to use. Valid values are 'tpmv2' and 'tang'.
+<1> Specify which nodes to enable disk encryption on. Valid values are `none`, `all`, `master`, and `worker`.
+<2> Specify which disk encryption mode to use. Valid values are `tpmv2` and `tang`.
 <3> Optional: If you are using Tang, specify the Tang servers.

modules/installing-ocp-agent-gather-log.adoc

@@ -18,7 +18,7 @@ Use the following procedure to gather log data about a failed Agent-based instal
 +
 [source,terminal]
 ----
-$ ./openshift-install --dir <install_directory> agent wait-for bootstrap-complete --log-level=debug
+$ ./openshift-install --dir <installation_directory> agent wait-for bootstrap-complete --log-level=debug
 ----
 +
 .Example error message
@@ -56,7 +56,7 @@ $ ./openshift-install --dir <install_directory> agent wait-for install-complete
 $ export KUBECONFIG=<install_directory>/auth/kubeconfig
 ----
 
-.. To gather information for debugging, run the following command:
+.. Gather information for debugging by running the following command:
 +
 [source,terminal]
 ----
@@ -70,6 +70,6 @@ $ oc adm must-gather
 $ tar cvaf must-gather.tar.gz <must_gather_directory>
 ----
 
-. Excluding the `/auth` subdirectory, attach the installation directory used during the deployment to your support case on the link:https://access.redhat.com[Red Hat Customer Portal].
+. Excluding the `/auth` subdirectory, attach the installation directory used during the deployment to your support case on the link:https://access.redhat.com[Red{nbsp}Hat Customer Portal].
 
 . Attach all other data gathered from this procedure to your support case.

modules/installing-ocp-agent-ibm-z-kvm.adoc

@@ -12,6 +12,7 @@ endif::[]
 = Adding {ibm-z-name} agents with {op-system-base} KVM
 
 Use the following procedure to manually add {ibm-z-name} agents with {op-system-base} KVM.
+Only use this procedure for {ibm-z-name} clusters with {op-system-base} KVM.
 
 [NOTE]
 ====
@@ -62,7 +63,7 @@ $ virt-install
     --memory=<memory> \
     --cpu host \
     --vcpus=<vcpus> \
-    --cdrom <agent.iso_image> \ <1>
+    --cdrom <agent_iso_image> \ <1>
     --disk pool=default,size=<disk_pool_size> \
     --network network:default,mac=<mac_address> \
     --graphics none \

modules/installing-ocp-agent-ibm-z-zvm.adoc

@@ -7,6 +7,7 @@
 = Adding {ibm-z-title} agents with z/VM
 
 Use the following procedure to manually add {ibm-z-name} agents with z/VM.
+Only use this procedure for {ibm-z-name} clusters with with z/VM.
 
 .Procedure
 
@@ -39,7 +40,7 @@ Leave all other parameters unchanged.
 
 . Punch the `kernel.img`,`generic.parm`, and `initrd.img` files to the virtual reader of the z/VM guest virtual machine.
 +
-For more information, see link:https://www.ibm.com/docs/en/zvm/latest?topic=commands-punch[PUNCH] in IBM Documentation.
+For more information, see link:https://www.ibm.com/docs/en/zvm/latest?topic=commands-punch[PUNCH] ({ibm-title} Documentation).
 +
 [TIP]
 ====
@@ -55,4 +56,4 @@ You can use the `CP PUNCH` command or, if you use Linux, the `vmur` command, to
 $ ipl c
 ----
 +
-For more information, see link:https://www.ibm.com/docs/en/zvm/latest?topic=commands-ipl[IPL] in IBM Documentation.
+For more information, see link:https://www.ibm.com/docs/en/zvm/latest?topic=commands-ipl[IPL] ({ibm-title} Documentation).

modules/installing-ocp-agent-ibm-z.adoc

@@ -7,6 +7,7 @@
 = Manually adding {ibm-z-title} agents
 
 After creating the PXE assets, you can add {ibm-z-name} agents.
+Only use this procedure for {ibm-z-name} clusters.
 
 Depending on your {ibm-z-name} environment, you can choose from the following options: