Merge pull request #45058 from johnwilkins/BZ2004210-3

kalexand-rh · web-flow · commit dd4350f6252c · 2022-04-28T13:05:04.000-04:00
BZ2004210: Minor edits as part of top-to-bottom review.
diff --git a/installing/installing_bare_metal_ipi/ipi-install-prerequisites.adoc b/installing/installing_bare_metal_ipi/ipi-install-prerequisites.adoc
@@ -11,7 +11,7 @@ Installer-provisioned installation of {product-title} requires:
 ifdef::openshift-origin[. One provisioner node with {op-system-first} installed. The provisioning node can be removed after installation.]
 ifndef::openshift-origin[. One provisioner node with {op-system-base-full} 8.x installed. The provisioning node can be removed after installation.]
 . Three control plane nodes.
-. Baseboard Management Controller (BMC) access to each node.
+. Baseboard management controller (BMC) access to each node.
 . At least one network:
 .. One required routable network
 .. One optional network for provisioning nodes; and,
diff --git a/modules/ipi-install-configuring-nodes.adoc b/modules/ipi-install-configuring-nodes.adoc
@@ -80,7 +80,7 @@ Red Hat only supports manually configured Secure Boot when deploying with Redfis
 To enable Secure Boot manually, refer to the hardware guide for the node and execute the following:
 
 . Boot the node and enter the BIOS menu.
-. Set the node's boot mode to UEFI Enabled.
+. Set the node's boot mode to `UEFI Enabled`.
 . Enable Secure Boot.
 
 [IMPORTANT]
diff --git a/modules/ipi-install-configuring-the-install-config-file.adoc b/modules/ipi-install-configuring-the-install-config-file.adoc
@@ -96,24 +96,30 @@ ifndef::upstream[]
 endif::[]
 
 
-. Create a directory to store cluster configs.
+. Create a directory to store cluster configs:
 +
 [source,terminal]
 ----
 $ mkdir ~/clusterconfigs
+----
+
+. Copy the `install-config.yaml` file to the new directory:
++
+[source,terminal]
+----
 $ cp install-config.yaml ~/clusterconfigs
 ----
 
-. Ensure all bare metal nodes are powered off prior to installing the {product-title} cluster.
+. Ensure all bare metal nodes are powered off prior to installing the {product-title} cluster:
 +
 [source,terminal]
 ----
 $ ipmitool -I lanplus -U <user> -P <password> -H <management-server-ip> power off
 ----
 
-. Remove old bootstrap resources if any are left over from a previous deployment attempt.
+. Remove old bootstrap resources if any are left over from a previous deployment attempt:
 +
-[source,terminal]
+[source,bash]
 ----
 for i in $(sudo virsh list | tail -n +3 | grep bootstrap | awk {'print $2'});
 do
diff --git a/modules/ipi-install-creating-an-rhcos-images-cache.adoc b/modules/ipi-install-creating-an-rhcos-images-cache.adoc
@@ -6,7 +6,7 @@
 [id="ipi-install-creating-an-rhcos-images-cache_{context}"]
 = (Optional) Creating an {op-system} images cache
 
-To employ image caching, you must download the {op-system-first} image used by the bootstrap VM to provision the different nodes. Image caching is optional, but especially useful when running the installation program on a network with limited bandwidth.
+To employ image caching, you must download the {op-system-first} image used by the bootstrap VM to provision the cluster nodes. Image caching is optional, but it is especially useful when running the installation program on a network with limited bandwidth.
 
 [NOTE]
 ====
@@ -103,7 +103,7 @@ quay.io/centos7/httpd-24-centos7:latest
 ----
 ifndef::upstream[]
 +
-<1> Creates a caching webserver with the name `rhcos_image_cache`. This pod serves the `bootstrapOSImage` image in the `install-config.yaml` file for deployment.   
+<1> Creates a caching webserver with the name `rhcos_image_cache`. This pod serves the `bootstrapOSImage` image in the `install-config.yaml` file for deployment.
 endif::[]
 
 . Generate the `bootstrapOSImage` configuration:
diff --git a/modules/ipi-install-deploying-routers-on-worker-nodes.adoc b/modules/ipi-install-deploying-routers-on-worker-nodes.adoc
@@ -21,7 +21,7 @@ If the cluster has no worker nodes, the installer deploys the two routers on the
 
 .Procedure
 
-. Create a `router-replicas.yaml` file.
+. Create a `router-replicas.yaml` file:
 +
 [source,yaml]
 ----
@@ -45,7 +45,7 @@ spec:
 Replace `<num-of-router-pods>` with an appropriate value. If working with just one worker node, set `replicas:` to `1`. If working with more than 3 worker nodes, you can increase `replicas:` from the default value `2` as appropriate.
 ====
 
-. Save and copy the `router-replicas.yaml` file to the `clusterconfigs/openshift` directory.
+. Save and copy the `router-replicas.yaml` file to the `clusterconfigs/openshift` directory:
 +
 [source,terminal]
 ----
diff --git a/modules/ipi-install-extracting-the-openshift-installer.adoc b/modules/ipi-install-extracting-the-openshift-installer.adoc
@@ -15,10 +15,19 @@ After retrieving the installer, the next step is to extract it.
 [source,terminal]
 ----
 $ export cmd=openshift-baremetal-install
+----
++
+[source,terminal]
+----
 $ export pullsecret_file=~/pull-secret.txt
+----
++
+[source,terminal]
+----
 $ export extract_dir=$(pwd)
 ----
 
+
 . Get the `oc` binary:
 +
 [source,terminal]
@@ -31,6 +40,14 @@ $ curl -s https://mirror.openshift.com/pub/openshift-v4/clients/ocp/$VERSION/ope
 [source,terminal]
 ----
 $ sudo cp oc /usr/local/bin
+----
++
+[source,terminal]
+----
 $ oc adm release extract --registry-config "${pullsecret_file}" --command=$cmd --to "${extract_dir}" ${RELEASE_IMAGE}
+----
++
+[source,terminal]
+----
 $ sudo cp openshift-baremetal-install /usr/local/bin
 ----
diff --git a/modules/ipi-install-following-the-installation.adoc b/modules/ipi-install-following-the-installation.adoc
@@ -6,7 +6,7 @@
 [id="ipi-install-troubleshooting-following-the-installation_{context}"]
 = Following the installation
 
-During the deployment process, you can check the installation's overall status by issuing the `tail` command to the `.openshift_install.log` log file in the install directory folder.
+During the deployment process, you can check the installation's overall status by issuing the `tail` command to the `.openshift_install.log` log file in the install directory folder:
 
 [source,terminal]
 ----
diff --git a/modules/ipi-install-installing-rhel-on-the-provisioner-node.adoc b/modules/ipi-install-installing-rhel-on-the-provisioner-node.adoc
@@ -7,4 +7,4 @@
 [id="installing-rhel-on-the-provisioner-node_{context}"]
 = Installing {op-system-base} on the provisioner node
 
-With the networking configuration complete, the next step is to install {op-system-base} {op-system-version} on the provisioner node. The installer uses the provisioner node as the orchestrator while installing the {product-title} cluster. For the purposes of this document, installing {op-system-base} on the provisioner node is out of scope. However, options include but are not limited to using a RHEL Satellite server, PXE, or installation media.
+With the configuration of the prerequisites complete, the next step is to install {op-system-base} {op-system-version} on the provisioner node. The installer uses the provisioner node as the orchestrator while installing the {product-title} cluster. For the purposes of this document, installing {op-system-base} on the provisioner node is out of scope. However, options include but are not limited to using a RHEL Satellite server, PXE, or installation media.
diff --git a/modules/ipi-install-network-requirements.adoc b/modules/ipi-install-network-requirements.adoc
@@ -14,7 +14,7 @@ image::210_OpenShift_Baremetal_IPI_Deployment_updates_0122_2.png[Installer-provi
 [id="network-requirements-increase-mtu_{context}"]
 == Increase the network MTU
 
-Before deploying {product-title}, increase the network maximum transmission unit (MTU) to 1500 or more. If the MTU is lower than 1500, the Ironic image that is used to boot the node might fail to communicate with the Ironic inspector pod, and inspection will fail. If this occurs, installation stops because the nodes are not available for installation. 
+Before deploying {product-title}, increase the network maximum transmission unit (MTU) to 1500 or more. If the MTU is lower than 1500, the Ironic image that is used to boot the node might fail to communicate with the Ironic inspector pod, and inspection will fail. If this occurs, installation stops because the nodes are not available for installation.
 
 [id='network-requirements-config-nics_{context}']
 == Configuring NICs
@@ -70,9 +70,9 @@ Installer-provisioned installation includes functionality that uses cluster memb
 |Record
 |Description
 
-.2+a|Kubernetes API
+|Kubernetes API
 |`api.<cluster_name>.<base_domain>.`
-|An A/AAAA record, and a PTR record, identify the API load balancer. These records must be resolvable by both clients external to the cluster and from all the nodes within the cluster.
+|An A/AAAA record and a PTR record identify the API load balancer. These records must be resolvable by both clients external to the cluster and from all the nodes within the cluster.
 
 |Routes
 |`*.apps.<cluster_name>.<base_domain>.`
diff --git a/modules/ipi-install-node-requirements.adoc b/modules/ipi-install-node-requirements.adoc
@@ -36,7 +36,7 @@ Do not deploy a cluster with only one worker node, because the cluster will depl
 
 * *Network interfaces:* Each node must have at least one network interface for the routable `baremetal` network. Each node must have one network interface for a `provisioning` network when using the `provisioning` network for deployment. Using the `provisioning` network is the default configuration.
 
-* *Unified Extensible Firmware Interface (UEFI):* Installer-provisioned installation requires UEFI boot on all {product-title} nodes when using IPv6 addressing on the `provisioning` network. In addition, UEFI Device PXE Settings must be set to use the IPv6 protocol on the `provisioning` network NIC, but omitting the `provisioning` network removes this requirement.
+* *Unified extensible firmware interface (UEFI):* Installer-provisioned installation requires UEFI boot on all {product-title} nodes when using IPv6 addressing on the `provisioning` network. In addition, UEFI Device PXE Settings must be set to use the IPv6 protocol on the `provisioning` network NIC, but omitting the `provisioning` network removes this requirement.
 
 * *Secure Boot:* Many production scenarios require nodes with Secure Boot enabled to verify the node only boots with trusted software, such as UEFI firmware drivers, EFI applications, and the operating system. You may deploy with Secure Boot manually or managed.
 +
diff --git a/modules/ipi-install-out-of-band-management.adoc b/modules/ipi-install-out-of-band-management.adoc
@@ -6,8 +6,8 @@
 [id="out-of-band-management_{context}"]
 = Out-of-band management
 
-Nodes will typically have an additional NIC used by the Baseboard Management Controllers (BMCs). These BMCs must be accessible from the provisioner node.
+Nodes will typically have an additional NIC used by the baseboard management controllers (BMCs). These BMCs must be accessible from the provisioner node.
 
-Each node must be accessible via out-of-band management. When using an out-of-band management network, the provisioner node requires access to the out-of-band management network for a successful {product-title} 4 installation.
+Each node must be accessible via out-of-band management. When using an out-of-band management network, the provisioner node requires access to the out-of-band management network for a successful {product-title} installation.
 
 The out-of-band management setup is out of scope for this document. We recommend setting up a separate management network for out-of-band management. However, using the provisioning network or the baremetal network are valid options.
diff --git a/modules/ipi-install-preparing-the-provisioner-node-for-openshift-install.adoc b/modules/ipi-install-preparing-the-provisioner-node-for-openshift-install.adoc
@@ -17,11 +17,24 @@ Perform the following steps to prepare the environment.
 [source,terminal]
 ----
 # useradd kni
+----
++
+[source,terminal]
+----
 # passwd kni
+----
++
+[source,terminal]
+----
 # echo "kni ALL=(root) NOPASSWD:ALL" | tee -a /etc/sudoers.d/kni
+----
++
+[source,terminal]
+----
 # chmod 0440 /etc/sudoers.d/kni
 ----
 
+
 . Create an `ssh` key for the new user:
 +
 [source,terminal]
@@ -34,7 +47,6 @@ Perform the following steps to prepare the environment.
 [source,terminal]
 ----
 # su - kni
-$
 ----
 
 ifndef::openshift-origin[]
@@ -71,7 +83,15 @@ $ sudo usermod --append --groups libvirt <user>
 [source,terminal]
 ----
 $ sudo systemctl start firewalld
+----
++
+[source,terminal]
+----
 $ sudo firewall-cmd --zone=public --add-service=http --permanent
+----
++
+[source,terminal]
+----
 $ sudo firewall-cmd --reload
 ----
 
@@ -87,7 +107,15 @@ $ sudo systemctl enable libvirtd --now
 [source,terminal]
 ----
 $ sudo virsh pool-define-as --name default --type dir --target /var/lib/libvirt/images
+----
++
+[source,terminal]
+----
 $ sudo virsh pool-start default
+----
++
+[source,terminal]
+----
 $ sudo virsh pool-autostart default
 ----
 
@@ -152,21 +180,21 @@ The IPv6 address can be any address as long as it is not routable via the `barem
 Ensure that UEFI is enabled and UEFI PXE settings are set to the IPv6 protocol when using IPv6 addressing.
 ====
 
-. Configure the IPv4 address on the `provisioning` network connection.
+. Configure the IPv4 address on the `provisioning` network connection:
 +
 [source,terminal]
 ----
 $ nmcli connection modify provisioning ipv4.addresses 172.22.0.254/24 ipv4.method manual
 ----
 
-. `ssh` back into the `provisioner` node (if required).
+. `ssh` back into the `provisioner` node (if required):
 +
 [source,terminal]
 ----
 # ssh kni@provisioner.<cluster-name>.<domain>
 ----
 
-. Verify the connection bridges have been properly created.
+. Verify the connection bridges have been properly created:
 +
 [source,terminal]
 ----
@@ -183,11 +211,11 @@ bridge-slave-eno1  76a8ed50-c7e5-4999-b4f6-6d9014dd0812  ethernet  eno1
 bridge-slave-eno2  f31c3353-54b7-48de-893a-02d2b34c4736  ethernet  eno2
 ----
 
-. Create a `pull-secret.txt` file.
+. Create a `pull-secret.txt` file:
 +
 [source,terminal]
 ----
 $ vim pull-secret.txt
 ----
 +
-In a web browser, navigate to link:https://console.redhat.com/openshift/install/metal/user-provisioned[Install on Bare Metal with user-provisioned infrastructure], and scroll down to the **Downloads** section. Click **Copy pull secret**. Paste the contents into the `pull-secret.txt` file and save the contents in the `kni` user's home directory.
+In a web browser, navigate to link:https://console.redhat.com/openshift/install/metal/user-provisioned[Install on Bare Metal with user-provisioned infrastructure]. Click **Copy pull secret**. Paste the contents into the `pull-secret.txt` file and save the contents in the `kni` user's home directory.
diff --git a/modules/ipi-install-validation-checklist-for-installation.adoc b/modules/ipi-install-validation-checklist-for-installation.adoc
@@ -12,6 +12,7 @@
 * [ ] The `hosts` parameter for the `install-config.yaml` has been configured.
 * [ ] The `bmc` parameter for the `install-config.yaml` has been configured.
 * [ ] Conventions for the values configured in the `bmc` `address` field have been applied.
+* [ ] Created the {product-title} manifests.
 * [ ] Created a disconnected registry (optional).
 * [ ] (optional) Validate disconnected registry settings if in use.
 * [ ] (optional) Deployed routers on worker nodes.

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ If the cluster has no worker nodes, the installer deploys the two routers on the`
`21`	`21`
`22`	`22`	`.Procedure`
`23`	`23`
`24`		-. Create a `router-replicas.yaml` file.
	`24`	+. Create a `router-replicas.yaml` file:
`25`	`25`	`+`
`26`	`26`	`[source,yaml]`
`27`	`27`	`----`
`@@ -45,7 +45,7 @@ spec:`
`45`	`45`	Replace `<num-of-router-pods>` with an appropriate value. If working with just one worker node, set `replicas:` to `1`. If working with more than 3 worker nodes, you can increase `replicas:` from the default value `2` as appropriate.
`46`	`46`	`====`
`47`	`47`
`48`		-. Save and copy the `router-replicas.yaml` file to the `clusterconfigs/openshift` directory.
	`48`	+. Save and copy the `router-replicas.yaml` file to the `clusterconfigs/openshift` directory:
`49`	`49`	`+`
`50`	`50`	`[source,terminal]`
`51`	`51`	`----`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ Do not deploy a cluster with only one worker node, because the cluster will depl`
`36`	`36`
`37`	`37`	* Network interfaces: Each node must have at least one network interface for the routable `baremetal` network. Each node must have one network interface for a `provisioning` network when using the `provisioning` network for deployment. Using the `provisioning` network is the default configuration.
`38`	`38`
`39`		-* Unified Extensible Firmware Interface (UEFI): Installer-provisioned installation requires UEFI boot on all {product-title} nodes when using IPv6 addressing on the `provisioning` network. In addition, UEFI Device PXE Settings must be set to use the IPv6 protocol on the `provisioning` network NIC, but omitting the `provisioning` network removes this requirement.
	`39`	+* Unified extensible firmware interface (UEFI): Installer-provisioned installation requires UEFI boot on all {product-title} nodes when using IPv6 addressing on the `provisioning` network. In addition, UEFI Device PXE Settings must be set to use the IPv6 protocol on the `provisioning` network NIC, but omitting the `provisioning` network removes this requirement.
`40`	`40`
`41`	`41`	`* Secure Boot: Many production scenarios require nodes with Secure Boot enabled to verify the node only boots with trusted software, such as UEFI firmware drivers, EFI applications, and the operating system. You may deploy with Secure Boot manually or managed.`
`42`	`42`	`+`