Merge pull request #92567 from johnwilkins/HCIDOCS-699

jeana-redhat · web-flow · commit 1f81a0310c29 · 2025-05-13T15:17:42.000-04:00
HCIDOCS-699: Missing documentation for BMO configuration
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -469,10 +469,10 @@ Topics:
       File: ipi-install-installing-a-cluster
     - Name: Troubleshooting the installation
       File: ipi-install-troubleshooting
-    - Name: Postinstallation configuration
-      File: ipi-install-post-installation-configuration
-    - Name: Expanding the cluster
-      File: ipi-install-expanding-the-cluster
+  - Name: Postinstallation configuration
+    File: bare-metal-postinstallation-configuration
+  - Name: Expanding the cluster
+    File: bare-metal-expanding-the-cluster
 - Name: Installing IBM Cloud Bare Metal (Classic)
   Dir: installing_ibm_cloud_classic
   Distros: openshift-origin,openshift-enterprise
diff --git a/backup_and_restore/control_plane_backup_and_restore/disaster_recovery/quorum-restoration.adoc b/backup_and_restore/control_plane_backup_and_restore/disaster_recovery/quorum-restoration.adoc
@@ -16,4 +16,4 @@ include::modules/dr-restoring-etcd-quorum-ha.adoc[leveloffset=+1]
 == Additional resources
 
 * xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installing-bare-metal[Installing a user-provisioned cluster on bare metal]
-* xref:../../../installing/installing_bare_metal/ipi/ipi-install-expanding-the-cluster.adoc#replacing-a-bare-metal-control-plane-node_ipi-install-expanding[Replacing a bare-metal control plane node]
+* xref:../../../installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc#replacing-a-bare-metal-control-plane-node_bare-metal-expanding[Replacing a bare-metal control plane node]
diff --git a/backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc b/backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc
@@ -30,6 +30,6 @@ include::modules/manually-restoring-cluster-etcd-backup.adoc[leveloffset=+1]
 
 * xref:../../../networking/accessing-hosts.adoc#accessing-hosts[Creating a bastion host to access {product-title} instances and the control plane nodes with SSH]
 
-* xref:../../../installing/installing_bare_metal/ipi/ipi-install-expanding-the-cluster.adoc#replacing-a-bare-metal-control-plane-node_ipi-install-expanding[Replacing a bare-metal control plane node]
+* xref:../../../installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc#replacing-a-bare-metal-control-plane-node_bare-metal-expanding[Replacing a bare-metal control plane node]
 
 include::modules/dr-scenario-cluster-state-issues.adoc[leveloffset=+1]
diff --git a/edge_computing/image_base_install/ibi_deploying_sno_clusters/ibi-edge-image-based-install.adoc b/edge_computing/image_base_install/ibi_deploying_sno_clusters/ibi-edge-image-based-install.adoc
@@ -54,7 +54,7 @@ include::modules/ibi-extra-manifests-configmap.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../../installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc#bmo-about-the-baremetalhost-resource_ipi-install-post-installation-configuration[About the BareMetalHost resource]
+* xref:../../../installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc#bmo-about-the-baremetalhost-resource_bare-metal-postinstallation-configuration[About the BareMetalHost resource]
 
 * xref:../../../openshift_images/managing_images/using-image-pull-secrets.adoc[Using image pull secrets]
 
diff --git a/installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc b/installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc
@@ -0,0 +1,41 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="bare-metal-expanding-the-cluster"]
+= Expanding the cluster
+include::_attributes/common-attributes.adoc[]
+:context: bare-metal-expanding
+
+toc::[]
+
+After deploying a bare-metal cluster, you can use the following procedures to expand the number of worker nodes. Ensure that each prospective worker node meets the prerequisites.
+
+[NOTE]
+====
+Expanding the cluster using RedFish Virtual Media involves meeting minimum firmware requirements. See *Firmware requirements for installing with virtual media* in the *Prerequisites* section for additional details when expanding the cluster using RedFish Virtual Media.
+====
+
+include::modules/ipi-install-preparing-the-bare-metal-node.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+* See xref:../../installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc#configuring-host-network-interfaces-in-the-install-config-yaml-file_ipi-install-installation-workflow[Optional: Configuring host network interfaces in the install-config.yaml file] for details on configuring the NMState syntax.
+* See xref:../../scalability_and_performance/managing-bare-metal-hosts.adoc#automatically-scaling-machines-to-available-bare-metal-hosts_managing-bare-metal-hosts[Automatically scaling machines to the number of available bare-metal hosts] for details on automatically scaling machines.
+
+include::modules/ipi-install-replacing-a-bare-metal-control-plane-node.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../backup_and_restore/control_plane_backup_and_restore/replacing-unhealthy-etcd-member.adoc#replacing-the-unhealthy-etcd-member[Replacing an unhealthy etcd member]
+
+* xref:../../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backing-up-etcd-data_backup-etcd[Backing up etcd]
+
+* xref:../../installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc#bmo-config-using-bare-metal-operator_bare-metal-postinstallation-configuration[Configuration using the Bare Metal Operator]                                                                      
+
+* xref:../../installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc#bmc-addressing_ipi-install-installation-workflow[BMC addressing]
+
+include::modules/ipi-install-preparing-to-deploy-with-virtual-media-on-the-baremetal-network.adoc[leveloffset=+1]
+
+include::modules/ipi-install-diagnosing-duplicate-mac-address.adoc[leveloffset=+1]
+
+include::modules/ipi-install-provisioning-the-bare-metal-node.adoc[leveloffset=+1]
diff --git a/installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc b/installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc
@@ -1,12 +1,12 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="ipi-install-post-installation-configuration"]
-= Installer-provisioned postinstallation configuration
+[id="bare-metal-post-installation-configuration"]
+= Postinstallation configuration
 include::_attributes/common-attributes.adoc[]
-:context: ipi-install-post-installation-configuration
+:context: bare-metal-postinstallation-configuration
 
 toc::[]
 
-After successfully deploying an installer-provisioned cluster, consider the following postinstallation procedures.
+After successfully deploying a bare-metal cluster, consider the following postinstallation procedures.
 
 // Configuring NTP for disconnected clusters
 include::modules/ipi-install-configuring-ntp-for-disconnected-clusters.adoc[leveloffset=+1]
@@ -39,11 +39,6 @@ include::modules/bmo-troubleshooting-latency-when-deleting-a-baremetalhost-resou
 include::modules/bmo-attaching-a-non-bootable-iso-to-a-bare-metal-node.adoc[leveloffset=+2]
 // Configuring NC-SI and DisablePowerOff for shared NICs
 include::modules/bmo-configuring-ncsi-disable-poweroff.adoc[leveloffset=+2]
-[role="_additional-resources"]
-.Additional resources
-
-* xref:../../../installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc#bmc-addressing_ipi-install-installation-workflow[BMC addressing]
-
 // About the HostFirmwareSettings resource
 include::modules/bmo-about-the-hostfirmwaresettings-resource.adoc[leveloffset=+2]
 // Getting the HostFirmwareSettings resource
diff --git a/installing/installing_bare_metal/ipi/ipi-install-expanding-the-cluster.adoc b/installing/installing_bare_metal/ipi/ipi-install-expanding-the-cluster.adoc
diff --git a/installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc b/installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc
@@ -73,7 +73,7 @@ include::modules/ipi-install-bmc-addressing.adoc[leveloffset=+2]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../../installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc#bmo-editing-a-baremetalhost-resource_ipi-install-post-installation-configuration[Editing a BareMetalHost resource]
+* xref:../../../installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc#bmo-editing-a-baremetalhost-resource_bare-metal-postinstallation-configuration[Editing a BareMetalHost resource]
 
 // Verifying support for the Redfish API
 include::modules/ipi-install-verifying-support-for-redfish-apis.adoc[leveloffset=+2]
@@ -147,7 +147,7 @@ include::modules/ipi-install-configuring-the-bios.adoc[leveloffset=+2]
 [id="additional-resources_bare_metal_config"]
 .Additional resources
 
-* xref:../../../installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc#bmo-config-using-bare-metal-operator_ipi-install-post-installation-configuration[Configuration using the Bare Metal Operator]
+* xref:../../../installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc#bmo-config-using-bare-metal-operator_bare-metal-postinstallation-configuration[Configuration using the Bare Metal Operator]
 
 // Optional: Configuring the RAID
 include::modules/ipi-install-configuring-the-raid.adoc[leveloffset=+2]
@@ -159,7 +159,7 @@ include::modules/ipi-install-configuring-storage-on-nodes.adoc[leveloffset=+2]
 [id="additional-resources_raid_config"]
 .Additional resources
 
-* xref:../../../installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc#bmo-config-using-bare-metal-operator_ipi-install-post-installation-configuration[Configuration using the Bare Metal Operator]
+* xref:../../../installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc#bmo-config-using-bare-metal-operator_bare-metal-postinstallation-configuration[Configuration using the Bare Metal Operator]
 
 * link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/managing_storage_devices/index#partition-naming-scheme_disk-partitions[Partition naming scheme]
 
diff --git a/installing/installing_bare_metal/upi/scaling-a-user-provisioned-cluster-with-the-bare-metal-operator.adoc b/installing/installing_bare_metal/upi/scaling-a-user-provisioned-cluster-with-the-bare-metal-operator.adoc
@@ -17,11 +17,11 @@ include::modules/upi-provisioning-new-hosts-in-a-upi-cluster.adoc[leveloffset=+1
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../../installing/installing_bare_metal/ipi/ipi-install-expanding-the-cluster.adoc#preparing-the-bare-metal-node_ipi-install-expanding[Preparing the bare-metal node]
+* xref:../../../installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc#preparing-the-bare-metal-node_bare-metal-expanding[Preparing the bare-metal node]
 
 * xref:../../../installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc#root-device-hints_ipi-install-installation-workflow[Root device hints]
 
-* xref:../../../installing/installing_bare_metal/ipi/ipi-install-expanding-the-cluster.adoc#ipi-install-diagnosing-duplicate-mac-address_ipi-install-expanding[Diagnosing a duplicate MAC address when provisioning a new host in the cluster]
+* xref:../../../installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc#ipi-install-diagnosing-duplicate-mac-address_bare-metal-expanding[Diagnosing a duplicate MAC address when provisioning a new host in the cluster]
 
 // Managing existing hosts in a user-provisioned cluster by using the BMO
 include::modules/upi-managing-existing-hosts-in-a-upi-cluster.adoc[leveloffset=+1]
diff --git a/installing/overview/cluster-capabilities.adoc b/installing/overview/cluster-capabilities.adoc
@@ -34,7 +34,7 @@ include::modules/cluster-bare-metal-operator.adoc[leveloffset=+2]
 .Additional resources
 * xref:../../installing/installing_bare_metal/ipi/ipi-install-overview.adoc#ipi-install-overview[Deploying installer-provisioned clusters on bare metal]
 * xref:../../installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc#preparing-to-install-on-bare-metal[Preparing for bare metal cluster installation]
-* xref:../../installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc#bmo-config-using-bare-metal-operator_ipi-install-post-installation-configuration[Configuration using the Bare Metal Operator]
+* xref:../../installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc#bmo-config-using-bare-metal-operator_bare-metal-postinstallation-configuration[Configuration using the Bare Metal Operator]
 
 // Build capability
 include::modules/build-config-capability.adoc[leveloffset=+2]
diff --git a/installing/overview/index.adoc b/installing/overview/index.adoc
@@ -26,7 +26,7 @@ include::modules/ipi-verifying-nodes-after-installation.adoc[leveloffset=+2]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc#bmo-getting-the-baremetalhost-resource_ipi-install-post-installation-configuration[Getting the BareMetalHost resource]
+* xref:../../installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc#bmo-getting-the-baremetalhost-resource_bare-metal-postinstallation-configuration[Getting the BareMetalHost resource]
 
 * xref:../../installing/installing_bare_metal/ipi/ipi-install-installing-a-cluster.adoc#ipi-install-following-the-progress-of-the-installation_ipi-install-installing-a-cluster[Following the progress of the installation]
 
diff --git a/modules/ipi-install-replacing-a-bare-metal-control-plane-node.adoc b/modules/ipi-install-replacing-a-bare-metal-control-plane-node.adoc
@@ -1,18 +1,18 @@
 // This is included in the following assemblies:
 //
-// installing/installing_bare_metal/ipi/ipi-install-expanding-the-cluster.adoc
+// installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="replacing-a-bare-metal-control-plane-node_{context}"]
 = Replacing a bare-metal control plane node
 
-Use the following procedure to replace an installer-provisioned {product-title} control plane node.
+Use the following procedure to replace a {product-title} control plane node.
 
 [IMPORTANT]
 ====
 If you reuse the `BareMetalHost` object definition from an existing control plane host, do not leave the `externallyProvisioned` field set to `true`.
 
-Existing control plane `BareMetalHost` objects may have the `externallyProvisioned` flag set to `true` if they were provisioned by the {product-title} installation program.
+Existing control plane `BareMetalHost` objects might have the `externallyProvisioned` flag set to `true` if they were provisioned by the {product-title} installation program.
 ====
 
 .Prerequisites
@@ -39,7 +39,7 @@ $ oc get clusteroperator baremetal
 [source,terminal,subs="attributes+"]
 ----
 NAME        VERSION   AVAILABLE   PROGRESSING   DEGRADED   SINCE   MESSAGE
-baremetal   {product-version}   True        False         False      3d15h
+baremetal   {product-version}     True          False      False   3d15h
 ----
 
 . Remove the old `BareMetalHost` and `Machine` objects:
@@ -85,11 +85,11 @@ spec:
   online: true
 EOF
 ----
-<1> Replace `<num>` for the control plane number of the bare metal node in the `name` fields and the `credentialsName` field.
+<1> Replace `<num>` for the control plane number of the bare-metal node in the `name` fields and the `credentialsName` field.
 <2> Replace `<base64_of_uid>` with the `base64` string of the user name.
 <3> Replace `<base64_of_pwd>` with the `base64` string of the password.
-<4> Replace `<protocol>` with the BMC protocol, such as `redfish`, `redfish-virtualmedia`, `idrac-virtualmedia`, or others. Replace `<bmc_ip>` with the IP address of the bare metal node's baseboard management controller. For additional BMC configuration options, see "BMC addressing" in the _Additional resources_ section.
-<5> Replace `<NIC1_mac_address>` with the MAC address of the bare metal node's first NIC.
+<4> Replace `<protocol>` with the BMC protocol, such as `redfish`, `redfish-virtualmedia`, `idrac-virtualmedia`, or others. Replace `<bmc_ip>` with the IP address of the bare-metal node's baseboard management controller. For additional BMC configuration options, see "BMC addressing" in the _Additional resources_ section.
+<5> Replace `<NIC1_mac_address>` with the MAC address of the bare-metal node's first NIC.
 +
 After the inspection is complete, the `BareMetalHost` object is created and available to be provisioned.
 
@@ -122,12 +122,12 @@ apiVersion: machine.openshift.io/v1beta1
 kind: Machine
 metadata:
   annotations:
-    metal3.io/BareMetalHost: openshift-machine-api/control-plane-<num> <1>
+    metal3.io/BareMetalHost: openshift-machine-api/control-plane-<num>
   labels:
-    machine.openshift.io/cluster-api-cluster: control-plane-<num> <1>
+    machine.openshift.io/cluster-api-cluster: control-plane-<num>
     machine.openshift.io/cluster-api-machine-role: master
     machine.openshift.io/cluster-api-machine-type: master
-  name: control-plane-<num> <1>
+  name: control-plane-<num>
   namespace: openshift-machine-api
 spec:
   metadata: {}
@@ -147,7 +147,8 @@ spec:
         name: master-user-data-managed
 EOF
 ----
-<1> Replace `<num>` for the control plane number of the bare metal node in the `name`, `labels` and `annotations` fields.
++
+Replace `<num>` with the control plane number of the bare-metal node in the `annotations`, `labels` and `name` fields.
 +
 . To view the `BareMetalHost` objects, run the following command:
 +
diff --git a/modules/nw-enabling-a-provisioning-network-after-installation.adoc b/modules/nw-enabling-a-provisioning-network-after-installation.adoc
@@ -1,13 +1,13 @@
 // This is included in the following assemblies:
 //
-// ipi-install-post-installation-configuration.adoc
+// bare-metal-postinstallation-configuration.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="enabling-a-provisioning-network-after-installation_{context}"]
 
 = Enabling a provisioning network after installation
 
-The assisted installer and installer-provisioned installation for bare metal clusters provide the ability to deploy a cluster without a `provisioning` network. This capability is for scenarios such as proof-of-concept clusters or deploying exclusively with Redfish virtual media when each node's baseboard management controller is routable via the `baremetal` network.
+The {ai-full} and installer-provisioned installation for bare-metal clusters provide the ability to deploy a cluster without a `provisioning` network. This capability is for scenarios such as proof-of-concept clusters or deploying exclusively with Redfish virtual media when each node's baseboard management controller is routable via the `baremetal` network.
 
 You can enable a `provisioning` network after installation using the Cluster Baremetal Operator (CBO).
 
diff --git a/networking/networking_operators/k8s-nmstate-about-the-k8s-nmstate-operator.adoc b/networking/networking_operators/k8s-nmstate-about-the-k8s-nmstate-operator.adoc
diff --git a/post_installation_configuration/cluster-tasks.adoc b/post_installation_configuration/cluster-tasks.adoc
diff --git a/scalability_and_performance/managing-bare-metal-hosts.adoc b/scalability_and_performance/managing-bare-metal-hosts.adoc
