Merge pull request #81172 from abrennan89/OSDOCS-11819-bm

abrennan89 · web-flow · commit 4690a03ab541 · 2024-09-09T09:27:22.000-05:00
OSDOCS-11819: Move bare metal config docs to bare metal install section
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -602,8 +602,6 @@ Topics:
 - Name: Configuring a private cluster
   Distros: openshift-enterprise,openshift-origin
   File: configuring-private-cluster
-- Name: Bare metal configuration
-  File: post-install-bare-metal-configuration
 - Name: Configuring multi-architecture compute machines on an OpenShift cluster
   Dir: configuring-multi-arch-compute-machines
   Distros: openshift-enterprise
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
@@ -30,7 +30,7 @@ include::modules/ipi-install-replacing-a-bare-metal-control-plane-node.adoc[leve
 
 * xref:../../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backing-up-etcd-data_backup-etcd[Backing up etcd]
 
-* xref:../../post_installation_configuration/post-install-bare-metal-configuration.adoc#post-install-bare-metal-configuration[Bare metal configuration]
+* 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_ipi/ipi-install-installation-workflow.adoc#bmc-addressing_ipi-install-installation-workflow[BMC addressing]
 
diff --git a/installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc b/installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc
@@ -68,7 +68,7 @@ include::modules/ipi-install-bmc-addressing.adoc[leveloffset=+2]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../post_installation_configuration/post-install-bare-metal-configuration.adoc#editing-a-baremetalhost-resource_post-install-bare-metal-configuration[Editing a BareMetalHost resource]
+* 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]
 
 // Verifying support for the Redfish API
 include::modules/ipi-install-verifying-support-for-redfish-apis.adoc[leveloffset=+2]
@@ -139,7 +139,7 @@ include::modules/ipi-install-configuring-the-bios.adoc[leveloffset=+2]
 [id="additional-resources_bare_metal_config"]
 .Additional resources
 
-* xref:../../post_installation_configuration/post-install-bare-metal-configuration.adoc#post-install-bare-metal-configuration[Bare metal configuration]
+* 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]
 
 // Optional: Configuring the RAID
 include::modules/ipi-install-configuring-the-raid.adoc[leveloffset=+2]
@@ -151,7 +151,7 @@ include::modules/ipi-install-configuring-storage-on-nodes.adoc[leveloffset=+2]
 [id="additional-resources_raid_config"]
 .Additional resources
 
-* xref:../../post_installation_configuration/post-install-bare-metal-configuration.adoc#post-install-bare-metal-configuration[Bare metal configuration]
+* 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]
 
 * 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]
 
@@ -175,4 +175,3 @@ include::modules/ipi-modify-install-config-for-a-disconnected-registry.adoc[leve
 
 // Validation checklist for installation
 include::modules/ipi-install-validation-checklist-for-installation.adoc[leveloffset=+1]
-
diff --git a/installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc b/installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
@@ -15,3 +15,33 @@ include::modules/nw-enabling-a-provisioning-network-after-installation.adoc[leve
 // Creating a manifest object that includes a customized `br-ex` bridge
 include::modules/creating-manifest-file-customized-br-ex-bridge.adoc[leveloffset=+1]
 
+// Using the Bare Metal Operator
+include::modules/bmo-config-using-bare-metal-operator.adoc[leveloffset=+1]
+// Bare Metal Operator architecture
+include::modules/bmo-bare-metal-operator-architecture.adoc[leveloffset=+2]
+// About the BareMetalHost resource
+include::modules/bmo-about-the-baremetalhost-resource.adoc[leveloffset=+2]
+// Getting the BareMetalHost resource
+include::modules/bmo-getting-the-baremetalhost-resource.adoc[leveloffset=+2]
+// Editing a BareMetalHost resource
+include::modules/bmo-editing-a-baremetalhost-resource.adoc[leveloffset=+2]
+// Attaching a non-bootable ISO to a bare-metal node
+include::modules/bmo-attaching-a-non-bootable-iso-to-a-bare-metal-node.adoc[leveloffset=+2]
+// About the HostFirmwareSettings resource
+include::modules/bmo-about-the-hostfirmwaresettings-resource.adoc[leveloffset=+2]
+// Getting the HostFirmwareSettings resource
+include::modules/bmo-getting-the-hostfirmwaresettings-resource.adoc[leveloffset=+2]
+// Editing the HostFirmwareSettings resource
+include::modules/bmo-editing-the-hostfirmwaresettings-resource.adoc[leveloffset=+2]
+// Verifying the HostFirmware Settings resource is valid
+include::modules/bmo-verifying-the-hostfirmware-settings-resource-is-valid.adoc[leveloffset=+2]
+// About the FirmwareSchema resource
+include::modules/bmo-about-the-firmwareschema-resource.adoc[leveloffset=+2]
+// Getting the FirmwareSchema resource
+include::modules/bmo-getting-the-firmwareschema-resource.adoc[leveloffset=+2]
+// About the HostFirmwareComponents resource
+include::modules/bmo-about-the-hostfirmwarecomponents-resource.adoc[leveloffset=+2]
+// Getting the HostFirmwareComponents resource
+include::modules/bmo-getting-the-hostfirmwarecomponents-resource.adoc[leveloffset=+2]
+// Editing the HostFirmwareComponents resource
+include::modules/bmo-editing-the-hostfirmwarecomponents-resource.adoc[leveloffset=+2]
diff --git a/installing/overview/cluster-capabilities.adoc b/installing/overview/cluster-capabilities.adoc
@@ -35,7 +35,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:../../post_installation_configuration/post-install-bare-metal-configuration.adoc#post-install-bare-metal-configuration[Bare metal configuration]
+* 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]
 
 // Build capability
 include::modules/build-config-capability.adoc[leveloffset=+2]
diff --git a/installing/overview/index.adoc b/installing/overview/index.adoc
@@ -8,7 +8,6 @@ toc::[]
 
 include::modules/installation-overview.adoc[leveloffset=+1]
 
-
 include::modules/install-openshift-common-terms.adoc[leveloffset=+2]
 
 include::modules/installation-process.adoc[leveloffset=+2]
@@ -23,7 +22,7 @@ include::modules/ipi-verifying-nodes-after-installation.adoc[leveloffset=+2]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../post_installation_configuration/post-install-bare-metal-configuration.adoc#getting-the-baremetalhost-resource_post-install-bare-metal-configuration[Getting the BareMetalHost resource]
+* 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_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/bmo-about-the-baremetalhost-resource.adoc b/modules/bmo-about-the-baremetalhost-resource.adoc
@@ -1,9 +1,9 @@
 // This is included in the following assemblies:
 //
-// post_installation_configuration/post-install-bare-metal-configuration.adoc
+// * installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
 
 :_mod-docs-content-type: REFERENCE
-[id="about-the-baremetalhost-resource_{context}"]
+[id="bmo-about-the-baremetalhost-resource_{context}"]
 = About the BareMetalHost resource
 
 Metal^3^ introduces the concept of the `BareMetalHost` resource, which defines a physical host and its properties. The `BareMetalHost` resource contains two sections:
diff --git a/modules/bmo-about-the-firmwareschema-resource.adoc b/modules/bmo-about-the-firmwareschema-resource.adoc
@@ -1,9 +1,9 @@
 // This is included in the following assemblies:
 //
-// post_installation_configuration/post-install-bare-metal-configuration.adoc
+// * installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
 
 :_mod-docs-content-type: REFERENCE
-[id="about-the-firmwareschema-resource_{context}"]
+[id="bmo-about-the-firmwareschema-resource_{context}"]
 = About the FirmwareSchema resource
 
 BIOS settings vary among hardware vendors and host models. A `FirmwareSchema` resource is a read-only resource that contains the types and limits for each BIOS setting on each host model. The data comes directly from the BMC through Ironic. The `FirmwareSchema` enables you to identify valid values you can specify in the `spec` field of the `HostFirmwareSettings` resource. The `FirmwareSchema` resource has a unique identifier derived from its settings and limits. Identical host models use the same `FirmwareSchema` identifier. It is likely that multiple instances of `HostFirmwareSettings` use the same `FirmwareSchema`.
diff --git a/modules/bmo-about-the-hostfirmwarecomponents-resource.adoc b/modules/bmo-about-the-hostfirmwarecomponents-resource.adoc
@@ -1,9 +1,9 @@
 // This is included in the following assemblies:
 //
-// post_installation_configuration/post-install-bare-metal-configuration.adoc
+// * installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
 
 :_mod-docs-content-type: REFERENCE
-[id="about-the-hostfirmwarecomponents-resource_{context}"]
+[id="bmo-about-the-hostfirmwarecomponents-resource_{context}"]
 = About the HostFirmwareComponents resource
 
 Metal^3^ provides the `HostFirmwareComponents` resource, which describes BIOS and baseboard management controller (BMC) firmware versions. The `HostFirmwareComponents` resource contains two sections:
@@ -75,4 +75,4 @@ a| The `updates` configuration setting contains the updated components. The fiel
 * `component`: The name of the component.
 
 * `url`: The URL to the component's firmware specification and version.
-|====
+|====
diff --git a/modules/bmo-about-the-hostfirmwaresettings-resource.adoc b/modules/bmo-about-the-hostfirmwaresettings-resource.adoc
@@ -1,9 +1,9 @@
 // This is included in the following assemblies:
 //
-// post_installation_configuration/post-install-bare-metal-configuration.adoc
+// * installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
 
 :_mod-docs-content-type: REFERENCE
-[id="about-the-hostfirmwaresettings-resource_{context}"]
+[id="bmo-about-the-hostfirmwaresettings-resource_{context}"]
 = About the HostFirmwareSettings resource
 
 You can use the `HostFirmwareSettings` resource to retrieve and manage the BIOS settings for a host. When a host moves to the `Available` state, Ironic reads the host's BIOS settings and creates the `HostFirmwareSettings` resource. The resource contains the complete BIOS configuration returned from the baseboard management controller (BMC). Whereas, the `firmware` field in the `BareMetalHost` resource returns three vendor-independent fields, the `HostFirmwareSettings` resource typically comprises many BIOS settings of vendor-specific fields per host.
diff --git a/modules/bmo-attaching-a-non-bootable-iso-to-a-bare-metal-node.adoc b/modules/bmo-attaching-a-non-bootable-iso-to-a-bare-metal-node.adoc
@@ -1,9 +1,9 @@
 // This module is included in the following assemblies:
 //
-// * post_installation_configuration/post-install-bare-metal-configuration.adoc
+// * installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
 
 :_mod-docs-content-type: PROCEDURE
-[id="attaching-a-non-bootable-iso-to-a-bare-metal-node_{context}"]
+[id="bmo-attaching-a-non-bootable-iso-to-a-bare-metal-node_{context}"]
 = Attaching a non-bootable ISO to a bare-metal node
 
 You can attach a generic, non-bootable ISO virtual media image to a provisioned node by using the `DataImage` resource. After you apply the resource, the ISO image becomes accessible to the operating system after it has booted. This is useful for configuring a node after provisioning the operating system and before the node boots for the first time.
diff --git a/modules/bmo-bare-metal-operator-architecture.adoc b/modules/bmo-bare-metal-operator-architecture.adoc
@@ -1,6 +1,7 @@
 // This is included in the following assemblies:
 //
-// post_installation_configuration/post-install-bare-metal-configuration.adoc
+// * installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
+
 :_mod-docs-content-type: CONCEPT
 [id="bmo-bare-metal-operator-architecture_{context}"]
 = Bare Metal Operator architecture
diff --git a/modules/bmo-config-using-bare-metal-operator.adoc b/modules/bmo-config-using-bare-metal-operator.adoc
@@ -1,12 +1,21 @@
 // This is included in the following assemblies:
 //
-// post_installation_configuration/post-install-bare-metal-configuration.adoc
+// * installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
 
-:_module-type: CONCEPT
-[id="bmo-about-the-bare-metal-operator_{context}"]
-= About the Bare Metal Operator
+:_mod-docs-content-type: CONCEPT
+[id="bmo-config-using-bare-metal-operator_{context}"]
+= Configuration using the Bare Metal Operator
 
-Use the Bare Metal Operator (BMO) to provision, manage, and inspect bare-metal hosts in your cluster.
+When deploying {product-title} on bare-metal hosts, there are times when you need to make changes to the host either before or after provisioning. This can include inspecting the host's hardware, firmware, and firmware details. It can also include formatting disks or changing modifiable firmware settings.
+
+You can use the Bare Metal Operator (BMO) to provision, manage, and inspect bare-metal hosts in your cluster. The BMO can complete the following operations:
+
+* Provision bare-metal hosts to the cluster with a specific image.
+* Turn on or off a host.
+* Inspect hardware details of the host and report them to the bare-metal host.
+* Upgrade or downgrade a host's firmware to a specific version.
+* Inspect firmware and configure BIOS settings.
+* Clean disk contents for the host before or after provisioning the host.
 
 The BMO uses the following resources to complete these tasks:
 
@@ -20,12 +29,3 @@ The BMO maintains an inventory of the physical hosts in the cluster by mapping e
 The BMO also uses the `HostFirmwareSettings` resource, the `FirmwareSchema` resource, and the `HostFirmwareComponents` resource to detail firmware specifications and upgrade or downgrade firmware for the bare-metal host.
 
 The BMO interfaces with bare-metal hosts in the cluster by using the Ironic API service. The Ironic service uses the Baseboard Management Controller (BMC) on the host to interface with the machine.
-
-Some common tasks you can complete by using the BMO include the following:
-
-* Provision bare-metal hosts to the cluster with a specific image
-* Format a host's disk contents before provisioning or after deprovisioning
-* Turn on or off a host
-* Change firmware settings
-* View the host's hardware details
-* Upgrade or downgrade a host's firmware to a specific version
diff --git a/modules/bmo-editing-a-baremetalhost-resource.adoc b/modules/bmo-editing-a-baremetalhost-resource.adoc
@@ -1,9 +1,9 @@
 // This module is included in the following assemblies:
 //
-// post_installation_configuration/post-install-bare-metal-configuration.adoc
+// * installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
 
 :_mod-docs-content-type: PROCEDURE
-[id="editing-a-baremetalhost-resource_{context}"]
+[id="bmo-editing-a-baremetalhost-resource_{context}"]
 = Editing a BareMetalHost resource
 
 After you deploy an {product-title} cluster on bare metal, you might need to edit a node's `BareMetalHost` resource. Consider the following examples:
diff --git a/modules/bmo-editing-the-hostfirmwarecomponents-resource.adoc b/modules/bmo-editing-the-hostfirmwarecomponents-resource.adoc
@@ -1,8 +1,8 @@
 // This is included in the following assemblies:
 //
-// post_installation_configuration/post-install-bare-metal-configuration.adoc
+// * installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
 
-[id="editing-the-hostfirmwarecomponents-resource_{context}"]
+[id="bmo-editing-the-hostfirmwarecomponents-resource_{context}"]
 = Editing the HostFirmwareComponents resource
 
 You can edit the `HostFirmwareComponents` resource of a node.
diff --git a/modules/bmo-editing-the-hostfirmwaresettings-resource.adoc b/modules/bmo-editing-the-hostfirmwaresettings-resource.adoc
@@ -1,9 +1,9 @@
 // This is included in the following assemblies:
 //
-// post_installation_configuration/post-install-bare-metal-configuration.adoc
+// * installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
 
 :_mod-docs-content-type: PROCEDURE
-[id="editing-the-hostfirmwaresettings-resource_{context}"]
+[id="bmo-editing-the-hostfirmwaresettings-resource_{context}"]
 = Editing the HostFirmwareSettings resource
 
 You can edit the `HostFirmwareSettings` of provisioned hosts.
diff --git a/modules/bmo-getting-the-baremetalhost-resource.adoc b/modules/bmo-getting-the-baremetalhost-resource.adoc
@@ -1,9 +1,9 @@
 // This is included in the following assemblies:
 //
-// post_installation_configuration/post-install-bare-metal-configuration.adoc
+// * installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
 
 :_mod-docs-content-type: PROCEDURE
-[id="getting-the-baremetalhost-resource_{context}"]
+[id="bmo-getting-the-baremetalhost-resource_{context}"]
 = Getting the BareMetalHost resource
 
 The `BareMetalHost` resource contains the properties of a physical host. You must get the `BareMetalHost` resource for a physical host to review its properties.
diff --git a/modules/bmo-getting-the-firmwareschema-resource.adoc b/modules/bmo-getting-the-firmwareschema-resource.adoc
@@ -1,9 +1,9 @@
 // This is included in the following assemblies:
 //
-// post_installation_configuration/post-install-bare-metal-configuration.adoc
+// * installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
 
 :_mod-docs-content-type: PROCEDURE
-[id="getting-the-firmwareschema-resource_{context}"]
+[id="bmo-getting-the-firmwareschema-resource_{context}"]
 = Getting the FirmwareSchema resource
 
 Each host model from each vendor has different BIOS settings. When editing the `HostFirmwareSettings` resource's `spec` section, the name/value pairs you set must conform to that host's firmware schema. To ensure you are setting valid name/value pairs, get the `FirmwareSchema` for the host and review it.
diff --git a/modules/bmo-getting-the-hostfirmwarecomponents-resource.adoc b/modules/bmo-getting-the-hostfirmwarecomponents-resource.adoc
@@ -1,8 +1,8 @@
 // This is included in the following assemblies:
 //
-// post_installation_configuration/post-install-bare-metal-configuration.adoc
+// * installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
 
-[id="getting-the-hostfirmwarecomponents-resource_{context}"]
+[id="bmo-getting-the-hostfirmwarecomponents-resource_{context}"]
 = Getting the HostFirmwareComponents resource
 
 The `HostFirmwareComponents` resource contains the specific firmware version of the BIOS and baseboard management controller (BMC) of a physical host. You must get the `HostFirmwareComponents` resource for a physical host to review the firmware version and status.
@@ -77,4 +77,4 @@ status:
     type: ChangeDetected
   lastUpdated: "2024-04-25T20:32:06Z"
   updates: []
-----
+----
diff --git a/modules/bmo-getting-the-hostfirmwaresettings-resource.adoc b/modules/bmo-getting-the-hostfirmwaresettings-resource.adoc
@@ -1,8 +1,8 @@
 // This is included in the following assemblies:
 //
-// post_installation_configuration/post-install-bare-metal-configuration.adoc
+// * installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
 
-[id="getting-the-hostfirmwaresettings-resource_{context}"]
+[id="bmo-getting-the-hostfirmwaresettings-resource_{context}"]
 = Getting the HostFirmwareSettings resource
 
 The `HostFirmwareSettings` resource contains the vendor-specific BIOS properties of a physical host. You must get the `HostFirmwareSettings` resource for a physical host to review its BIOS properties.
diff --git a/modules/bmo-verifying-the-hostfirmware-settings-resource-is-valid.adoc b/modules/bmo-verifying-the-hostfirmware-settings-resource-is-valid.adoc
@@ -1,9 +1,9 @@
 // This is included in the following assemblies:
 //
-// post_installation_configuration/post-install-bare-metal-configuration.adoc
+// * installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
 
 :_mod-docs-content-type: PROCEDURE
-[id="verifying-the-hostfirmware-settings-resource-is-valid_{context}"]
+[id="bmo-verifying-the-hostfirmware-settings-resource-is-valid_{context}"]
 = Verifying the HostFirmware Settings resource is valid
 
 When the user edits the `spec.settings` section to make a change to the `HostFirmwareSetting`(HFS) resource, the Bare Metal Operator (BMO) validates the change against the `FimwareSchema` resource, which is a read-only resource. If the setting is invalid, the BMO will set the `Type` value of the `status.Condition` setting to `False` and also generate an event and store it in the HFS resource. Use the following procedure to verify that the resource is valid.
diff --git a/modules/creating-manifest-file-customized-br-ex-bridge.adoc b/modules/creating-manifest-file-customized-br-ex-bridge.adoc
diff --git a/post_installation_configuration/index.adoc b/post_installation_configuration/index.adoc
diff --git a/post_installation_configuration/post-install-bare-metal-configuration.adoc b/post_installation_configuration/post-install-bare-metal-configuration.adoc
