fix-for-29155: The curl commands failed because a directory was specified as the output. Instructions were missing for downloading or otherwise generating the checksums and configuration needed for the install-config.yaml leaving the user uncertain as to how to use the rhcos_image_cache pod or directory to make the cache usable, especially required for air-gapped deployments. 29155 was supposed to fix the issue, but had a few errors itself. This resolves #29155 as well

Author: johnwilkins

installing/installing_bare_metal_ipi/ipi-install-configuration-files.adoc

@@ -4,17 +4,9 @@
 
 include::modules/ipi-install-configuring-the-install-config-file.adoc[leveloffset=+1]
 
-ifeval::[{product-version} <= 4.3]
-include::modules/ipi-install-configuring-the-metal3-config-file.adoc[leveloffset=+1]
-endif::[]
-
-ifeval::[{product-version} >= 4.4]
 include::modules/ipi-install-setting-proxy-settings-within-install-config.adoc[leveloffset=+1]
-endif::[]
 
-ifeval::[{product-version} >= 4.6]
 include::modules/ipi-install-modifying-install-config-for-no-provisioning-network.adoc[leveloffset=+1]
-endif::[]
 
 ifeval::[{product-version} > 4.7]
 include::modules/ipi-install-modifying-install-config-for-dual-stack-network.adoc[leveloffset=+1]

installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc

@@ -11,15 +11,17 @@ include::modules/ipi-install-preparing-the-provisioner-node-for-openshift-instal
 
 include::modules/ipi-install-retrieving-the-openshift-installer.adoc[leveloffset=+1]
 
-.Additional resources
-
-* See xref:../../updating/updating-cluster-between-minor.adoc#understanding-upgrade-channels_updating-cluster-between-minor[{product-title} upgrade channels and releases] for an explanation of the different release channels.
-
 include::modules/ipi-install-extracting-the-openshift-installer.adoc[leveloffset=+1]
 
 include::modules/ipi-install-creating-an-rhcos-images-cache.adoc[leveloffset=+1]
 
+ifdef::upstream[]
+include::ipi-install-configuration-files.adoc[leveloffset=+1]
+endif::[]
+
+ifndef::upstream[]
 include::installing/installing_bare_metal_ipi/ipi-install-configuration-files.adoc[leveloffset=+1]
+endif::[]
 
 include::modules/ipi-install-creating-a-disconnected-registry.adoc[leveloffset=+1]
 
@@ -30,3 +32,9 @@ include::modules/ipi-install-validation-checklist-for-installation.adoc[leveloff
 include::modules/ipi-install-deploying-the-cluster-via-the-openshift-installer.adoc[leveloffset=+1]
 
 include::modules/ipi-install-following-the-installation.adoc[leveloffset=+1]
+
+include::modules/ipi-install-verifying-static-ip-address-configuration.adoc[leveloffset=+1]
+
+.Additional resources
+
+* See xref:../../updating/updating-cluster-between-minor.adoc#understanding-upgrade-channels_updating-cluster-between-minor[{product-title} upgrade channels and releases] for an explanation of the different release channels.

installing/installing_bare_metal_ipi/ipi-install-prerequisites.adoc

@@ -27,16 +27,8 @@ endif::[]
 Before starting an installer-provisioned installation of {product-title}, ensure the hardware environment meets the following requirements.
 
 include::modules/ipi-install-node-requirements.adoc[leveloffset=+1]
-ifeval::[{product-version} >= 4.6]
 include::modules/ipi-install-firmware-requirements-for-installing-with-virtual-media.adoc[leveloffset=+1]
-endif::[]
 include::modules/ipi-install-network-requirements.adoc[leveloffset=+1]
-ifdef::upstream[]
-ifeval::[{product-version} >= 4.5]
-// Include IPv6 information only in DRAFT documentation
-include::modules/ipi-install-ipv6-network-requirements.adoc[leveloffset=+1]
-endif::[]
-endif::[]
 include::modules/ipi-install-configuring-nodes.adoc[leveloffset=+1]
 include::modules/ipi-install-out-of-band-management.adoc[leveloffset=+1]
 include::modules/ipi-install-required-data-for-installation.adoc[leveloffset=+1]

modules/ipi-install-creating-an-rhcos-images-cache.adoc

@@ -3,23 +3,24 @@
 //  *installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc
 
 [id="ipi-install-creating-an-rhcos-images-cache_{context}"]
-
 = Creating an {op-system} images cache (optional)
 
 To employ image caching, you must download two images: the {op-system-first} image used by the bootstrap VM and the {op-system} image used by the installer to provision the different nodes. Image caching is optional, but especially useful when running the installer on a network with limited bandwidth.
 
 If you are running the installer on a network with limited bandwidth and the {op-system} images download takes more than 15 to 20 minutes, the installer will timeout. Caching images on a web server will help in such scenarios.
 
-Use the following steps to install a container that contains the images.
+Install a container that contains the images.
+
+.Procedure
 
-. Install `podman`.
+. Install `podman`:
 +
 [source,terminal]
 ----
 $ sudo dnf install -y podman
 ----
 
-. Open firewall port `8080` to be used for {op-system} image caching.
+. Open firewall port `8080` to be used for {op-system} image caching:
 +
 [source,terminal]
 ----
@@ -31,79 +32,91 @@ $ sudo firewall-cmd --add-port=8080/tcp --zone=public --permanent
 $ sudo firewall-cmd --reload
 ----
 
-. Create a directory to store the `bootstraposimage` and `clusterosimage`.
+
+. Create a directory to store the `bootstraposimage` and `clusterosimage`:
 +
 [source,terminal]
 ----
 $ mkdir /home/kni/rhcos_image_cache
 ----
 
-. Set the appropriate SELinux context for the newly created directory.
+. Set the appropriate SELinux context for the newly created directory:
 +
 [source,terminal]
 ----
 $ sudo semanage fcontext -a -t httpd_sys_content_t "/home/kni/rhcos_image_cache(/.*)?"
+----
++
+[source,terminal]
+----
 $ sudo restorecon -Rv rhcos_image_cache/
 ----
 
-. Get the commit ID from the installer. The ID determines which images the installer needs to download.
+
+. Get the commit ID from the installer:
 +
 [source,terminal]
 ----
 $ export COMMIT_ID=$(/usr/local/bin/openshift-baremetal-install version | grep '^built from commit' | awk '{print $4}')
 ----
++
+The ID determines which images the installer needs to download.
 
-. Get the URI for the {op-system} image that the installer will deploy on the nodes.
+. Get the URI for the {op-system} image that the installer will deploy on the nodes:
 +
 [source,terminal]
 ----
 $ export RHCOS_OPENSTACK_URI=$(curl -s -S https://raw.githubusercontent.com/openshift/installer/$COMMIT_ID/data/data/rhcos.json  | jq .images.openstack.path | sed 's/"//g')
 ----
 
-. Get the URI for the {op-system} image that the installer will deploy on the bootstrap VM.
+. Get the URI for the {op-system} image that the installer will deploy on the bootstrap VM:
 +
 [source,terminal]
 ----
 $ export RHCOS_QEMU_URI=$(curl -s -S https://raw.githubusercontent.com/openshift/installer/$COMMIT_ID/data/data/rhcos.json  | jq .images.qemu.path | sed 's/"//g')
 ----
 
-. Get the path where the images are published.
+. Get the path where the images are published:
 +
 [source,terminal]
 ----
 $ export RHCOS_PATH=$(curl -s -S https://raw.githubusercontent.com/openshift/installer/$COMMIT_ID/data/data/rhcos.json | jq .baseURI | sed 's/"//g')
 ----
 
-. Get the SHA hash for the {op-system} image that will be deployed on the bootstrap VM.
+. Get the SHA hash for the {op-system} image that will be deployed on the bootstrap VM:
 +
 [source,terminal]
 ----
 $ export RHCOS_QEMU_SHA_UNCOMPRESSED=$(curl -s -S https://raw.githubusercontent.com/openshift/installer/$COMMIT_ID/data/data/rhcos.json  | jq -r '.images.qemu["uncompressed-sha256"]')
 ----
 
-. Get the SHA hash for the {op-system} image that will be deployed on the nodes.
+. Get the SHA hash for the {op-system} image that will be deployed on the nodes:
 +
 [source,terminal]
 ----
 $ export RHCOS_OPENSTACK_SHA_COMPRESSED=$(curl -s -S https://raw.githubusercontent.com/openshift/installer/$COMMIT_ID/data/data/rhcos.json  | jq -r '.images.openstack.sha256')
 ----
 
-. Download the images and place them in the `/home/kni/rhcos_image_cache` directory.
+. Download the images and place them in the `/home/kni/rhcos_image_cache` directory:
 +
 [source,terminal]
 ----
 $ curl -L ${RHCOS_PATH}${RHCOS_QEMU_URI} -o /home/kni/rhcos_image_cache/${RHCOS_QEMU_URI}
+----
++
+[source,terminal]
+----
 $ curl -L ${RHCOS_PATH}${RHCOS_OPENSTACK_URI} -o /home/kni/rhcos_image_cache/${RHCOS_OPENSTACK_URI}
 ----
 
-. Confirm SELinux type is of `httpd_sys_content_t` for the newly created files.
+. Confirm SELinux type is of `httpd_sys_content_t` for the newly created files:
 +
 [source,terminal]
 ----
 $ ls -Z /home/kni/rhcos_image_cache
 ----
 
-. Create the pod.
+. Create the pod:
 +
 [source,terminal]
 ----
@@ -112,3 +125,61 @@ $ podman run -d --name rhcos_image_cache \
 -p 8080:8080/tcp \
 registry.centos.org/centos/httpd-24-centos7:latest
 ----
+ifndef::upstream[]
++
+The above command creates a caching webserver with the name `rhcos_image_cache`, which serves the images for deployment. The first image `${RHCOS_PATH}${RHCOS_QEMU_URI}?sha256=${RHCOS_QEMU_SHA_UNCOMPRESSED}` is the `bootstrapOSImage` and the second image `${RHCOS_PATH}${RHCOS_OPENSTACK_URI}?sha256=${RHCOS_OPENSTACK_SHA_COMPRESSED}` is the `clusterOSImage` in the `install-config.yaml` file.
+endif::[]
+
+. Generate the `bootstrapOSImage` and `clusterOSImage` configuration:
++
+[source,terminal]
+----
+$ export BAREMETAL_IP=$(ip addr show dev baremetal | awk '/inet /{print $2}' | cut -d"/" -f1)
+----
++
+[source,terminal]
+----
+$ export RHCOS_OPENSTACK_SHA256=$(zcat /home/kni/rhcos_image_cache/${RHCOS_OPENSTACK_URI} | sha256sum | awk '{print $1}')
+----
++
+[source,terminal]
+----
+$ export RHCOS_QEMU_SHA256=$(zcat /home/kni/rhcos_image_cache/${RHCOS_QEMU_URI} | sha256sum | awk '{print $1}')
+----
++
+[source,terminal]
+----
+$ export CLUSTER_OS_IMAGE="http://${BAREMETAL_IP}:8080/${RHCOS_OPENSTACK_URI}?sha256=${RHCOS_OPENSTACK_SHA256}"
+----
++
+[source,terminal]
+----
+$ export BOOTSTRAP_OS_IMAGE="http://${BAREMETAL_IP}:8080/${RHCOS_QEMU_URI}?sha256=${RHCOS_QEMU_SHA256}"
+----
++
+[source,terminal]
+----
+$ echo "${RHCOS_OPENSTACK_SHA256}  ${RHCOS_OPENSTACK_URI}" > /home/kni/rhcos_image_cache/rhcos-ootpa-latest.qcow2.md5sum
+----
++
+[source,terminal]
+----
+$ echo "    bootstrapOSImage=${BOOTSTRAP_OS_IMAGE}"
+----
++
+[source,terminal]
+----
+$ echo "    clusterOSImage=${CLUSTER_OS_IMAGE}"
+----
+
+. Add the required configuration to the `install-config.yaml` file under `platform.baremetal`:
++
+[source,terminal]
+----
+platform:
+  baremetal:
+    bootstrapOSImage: http://<BAREMETAL_IP>:8080/<RHCOS_QEMU_URI>?sha256=<RHCOS_QEMU_SHA256>
+    clusterOSImage: http://<BAREMETAL_IP>:8080/<RHCOS_OPENSTACK_URI>?sha256=<RHCOS_OPENSTACK_SHA256>
+----
++
+See the "Configuration files" section for additional details.

modules/ipi-install-verifying-static-ip-address-configuration.adoc

@@ -0,0 +1,21 @@
+// This is included in the following assemblies:
+//
+// installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc
+
+[id="verifying-static-ip-address-configuration_{context}"]
+= Verifying static IP address configuration
+
+If the DHCP reservation for a cluster node specifies an infinite lease, after the installer successfully provisions the node, the dispatcher script checks the node's network configuration. If the script determines that the network configuration contains an infinite DHCP lease, it creates a new connection using the IP address of the DHCP lease as a static IP address.
+
+[NOTE]
+====
+The dispatcher script might run on successfully provisioned nodes while the provisioning of other nodes in the cluster is ongoing.
+====
+
+Verify the network configuration is working properly.
+
+.Procedure
+
+. Check the network interface configuration on the node.
+
+. Turn off the DHCP server and reboot the {product-title} node and ensure that the network configuration works properly.