HCIDOCS-652: Made updates and clarifying remarks for live updates..

johnwilkins · johnwilkins · commit 5ae5062d3670 · 2025-02-20T11:37:47.000-08:00
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
@@ -47,7 +47,7 @@ include::modules/bmo-getting-the-hostfirmwaresettings-resource.adoc[leveloffset=
 // Editing the HostFirmwareSettings resource
 include::modules/bmo-editing-the-hostfirmwaresettings-resource-of-a-provisioned-host.adoc[leveloffset=+2]
 // Patching the HostFirmawareSettings resource
-include::modules/bmo-patching-the-hostfirmwaresettings-resource.adoc[leveloffset=+2]
+include::modules/bmo-performing-a-live-update-to-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
@@ -61,7 +61,7 @@ include::modules/bmo-getting-the-hostfirmwarecomponents-resource.adoc[leveloffse
 // Editing the HostFirmwareComponents resource
 include::modules/bmo-editing-the-hostfirmwarecomponents-resource-of-a-provisioned-host.adoc[leveloffset=+2]
 // Patching the HostFirmawareComponents resource
-include::modules/bmo-patching-the-hostfirmwarecomponents-resource.adoc[leveloffset=+2]
+include::modules/bmo-performing-a-live-update-to-the-hostfirmwarecomponents-resource.adoc[leveloffset=+2]
 // About the HostUpdatePolicy resource
 include::modules/bmo-about-the-hostupdatepolicy-resource.adoc[leveloffset=+2]
 // Setting the HostUpdatePolicy resource
diff --git a/modules/bmo-editing-the-hostfirmwarecomponents-resource-of-a-provisioned-host.adoc b/modules/bmo-editing-the-hostfirmwarecomponents-resource-of-a-provisioned-host.adoc
@@ -20,9 +20,9 @@ $ oc get hostfirmwarecomponents -n openshift-machine-api -o yaml
 +
 [source,terminal]
 ----
-$ oc edit <host_name> hostfirmwarecomponents -n openshift-machine-api <1>
+$ oc edit <hostname> hostfirmwarecomponents -n openshift-machine-api <1>
 ----
-<1> Where `<host_name>` is the name of the host. The `HostFirmwareComponents` resource will open in the default editor for your terminal.
+<1> Where `<hostname>` is the name of the host. The `HostFirmwareComponents` resource will open in the default editor for your terminal.
 
 . Make the appropriate edits.
 +
diff --git a/modules/bmo-editing-the-hostfirmwaresettings-resource-of-a-provisioned-host.adoc b/modules/bmo-editing-the-hostfirmwaresettings-resource-of-a-provisioned-host.adoc
@@ -8,6 +8,7 @@
 
 To make changes to the `HostFirmwareSettings` spec for a provisioned host, perform the following actions:
 
+* Edit the host `HostFirmwareSettings` resource.
 * Delete the host from the machine set.
 * Scale down the machine set.
 * Scale up the machine set to make the changes take effect.
@@ -30,10 +31,10 @@ $ oc get hfs -n openshift-machine-api
 +
 [source,terminal]
 ----
-$ oc edit hfs <host_name> -n openshift-machine-api
+$ oc edit hfs <hostname> -n openshift-machine-api
 ----
 +
-Where `<host_name>` is the name of a provisioned host. The `HostFirmwareSettings` resource will open in the default editor for your terminal.
+Where `<hostname>` is the name of a provisioned host. The `HostFirmwareSettings` resource will open in the default editor for your terminal.
 
 . Add name and value pairs to the `spec.settings` section by running the following command:
 +
@@ -48,14 +49,14 @@ spec:
 
 . Save the changes and exit the editor.
 
-. Get the host's machine name by running the following command:
+. Get the host machine name by running the following command:
 +
 [source,terminal]
 ----
- $ oc get bmh <host_name> -n openshift-machine name
+ $ oc get bmh <hostname> -n openshift-machine name
 ----
 +
-Where `<host_name>` is the name of the host. The terminal displays the machine name under the `CONSUMER` field.
+Where `<hostname>` is the name of the host. The terminal displays the machine name under the `CONSUMER` field.
 
 . Annotate the machine to delete it from the machine set by running the following command:
 +
diff --git a/modules/bmo-patching-the-hostfirmwarecomponents-resource.adoc b/modules/bmo-patching-the-hostfirmwarecomponents-resource.adoc
diff --git a/modules/bmo-patching-the-hostfirmwaresettings-resource.adoc b/modules/bmo-patching-the-hostfirmwaresettings-resource.adoc
diff --git a/modules/bmo-performing-a-live-update-to-the-hostfirmwarecomponents-resource.adoc b/modules/bmo-performing-a-live-update-to-the-hostfirmwarecomponents-resource.adoc
@@ -0,0 +1,73 @@
+// This is included in the following assemblies:
+//
+// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+:_mod-docs-content-type: PROCEDURE
+[id="bmo-performing-a-live-update-to-the-hostfirmwarecomponents-resource_{context}"]
+= Performing a live update to the HostFirmwareComponents resource
+
+You can perform a live update to the `HostFirmwareComponents` resource on an already provisioned host. Live updates do not trigger deprovisioning and reprovisioning the host.
+
+:FeatureName: Live updating a host
+include::snippets/technology-preview.adoc[]
+:!FeatureName:
+
+[IMPORTANT]
+====
+Do not perform live updates on production hosts. You can perform live updates to the BIOS for testing purposes. We do not recommend that you perform live updates to the BMC on {product-title} {product-version} for test purposes, especially on earlier generation hardware.
+====
+
+.Prerequisites
+
+* The `HostUpdatePolicy` resource must have the `firmwareUpdates` parameter set to `onReboot`.
+
+.Procedure
+
+. Update the `HostFirmwareComponents` resource by running the following command:
++
+[source,terminal]
+----
+$ oc patch hostfirmwarecomponents <hostname> --type merge -p \// <1>
+    '{"spec": {"updates": [{"component": "<type>", \// <2>
+                        "url": "<url>"}]}}' <3>
+----
+<1> Replace `<hostname>` with the name of the host.
+<2> Replace `<type>` with the type of component. Specify `bios` or `bmc`.
+<3> Replace `<url>` with the URL for the component.
++
+[NOTE]
+====
+You can also use the `oc edit <hostname> hostfirmwarecomponents -n openshift-machine-api` command to update the resource.
+====
+
+. Cordon and drain the node by running the following command:
++
+[source,terminal]
+----
+$ oc drain <node_name> --force <1> 
+----
+<1> Replace `<node_name>` with the name of the node.
+
+. Power off the host for a period of 5 minutes by running the following command:
++
+[source,terminal]
+----
+$ oc patch bmh <hostname> --type merge -p '{"spec": {"online": false}}'
+----
++
+This step ensures that daemonsets or controllers mark any infrastructure pods that might be running on the node as offline, while the remaining nodes handle incoming requests.
+
+. After 5 minutes, power on the host by running the following command:
++
+[source,terminal]
+----
+$ oc patch bmh <hostname> --type merge -p '{"spec": {"online": true}}'
+----
++
+The servicing operation commences and the Bare Metal Operator (BMO) sets the `operationalStatus` parameter of the `BareMetalHost` to `servicing`. The BMO updates the `operationalStatus` parameter to `OK` after updating the resource. If an error occurs, the BMO updates the `operationalStatus` parameter to `error` and retries the operation.
+
+. Uncordon the node by running the following command:
++
+[source,terminal]
+----
+$ oc uncordon <node_name>
+----
diff --git a/modules/bmo-performing-a-live-update-to-the-hostfirmwaresettings-resource.adoc b/modules/bmo-performing-a-live-update-to-the-hostfirmwaresettings-resource.adoc
@@ -0,0 +1,66 @@
+// This is included in the following assemblies:
+//
+// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+:_mod-docs-content-type: PROCEDURE
+[id="bmo-performing-a-live-update-to-the-hostfirmwaresettings-resource_{context}"]
+= Performing a live update to the HostFirmwareSettings resource
+
+You can perform a live update to the `HostFirmareSettings` resource after it has begun running workloads. Live updates do not trigger deprovisioning and reprovisioning the host.
+
+:FeatureName: Live updating a host
+include::snippets/technology-preview.adoc[]
+:!FeatureName:
+
+.Prerequisites
+
+* The `HostUpdatePolicy` resource must the have `firmwareSettings` parameter set to `onReboot`.
+
+.Procedure
+
+. Update the `HostFirmwareSettings` resource by running the following command:
++
+[source,terminal]
+----
+$ oc patch hostfirmwaresettings <hostname> --type merge -p \// <1>
+    '{"spec": {"settings": {"<name>": "<value>"}}}' <2>
+----
+<1> Replace `<hostname>` with the name of the host.
+<2> Replace `<name>` with the name of the setting. Replace `<value>` with the value of the setting. You can set multiple name-value pairs.
++
+[NOTE]
+====
+Get the `FirmwareSchema` resource to determine which settings the hardware supports and what settings and values you can update. You cannot update read-only values and you cannot update the `FirmwareSchema` resource. You can also use the `oc edit <hostname> hostfirmwaresettings -n openshift-machine-api` command to update the `HostFirmwareSettings` resource.
+====
+
+. Cordon and drain the node by running the following command:
++
+[source,terminal]
+----
+$ oc drain <node_name> --force <1>
+----
+<1> Replace `<node_name>` with the name of the node.
+
+. Power off the host for a period of 5 minutes by running the following command:
++
+[source,terminal]
+----
+$ oc patch bmh <hostname> --type merge -p '{"spec": {"online": false}}'
+----
++
+This step ensures that daemonsets or controllers can mark any infrastructure pods that might be running on the host as offline, while the remaining hosts handle incoming requests.
+
+. After 5 minutes, power on the host by running the following command:
++
+[source,terminal]
+----
+$ oc patch bmh <hostname> --type merge -p '{"spec": {"online": true}}'
+----
++
+The servicing operation commences and the Bare Metal Operator (BMO) sets the `operationalStatus` parameter of the `BareMetalHost` to `servicing`. The BMO updates the `operationalStatus` parameter to `OK` after updating the resource. If an error occurs, the BMO updates the `operationalStatus` parameter to `error` and retries the operation.
+
+. Once Ironic completes the update and the host powers up, uncordon the node by running the following command:
++
+[source,terminal]
+----
+$ oc uncordon <node_name>
+----
diff --git a/modules/bmo-setting-the-hostupdatepolicy-resource.adoc b/modules/bmo-setting-the-hostupdatepolicy-resource.adoc
@@ -8,6 +8,10 @@
 
 By default, the `HostUpdatePolicy` disables live updates. To enable live updates, use the following procedure.
 
+:FeatureName: Setting the `HostUpdatePolicy` resource
+include::snippets/technology-preview.adoc[]
+:!FeatureName:
+
 .Procedure
 
 . Create the `HostUpdatePolicy` resource by running the following command:

Original file line number	Diff line number	Diff line change
`@@ -20,9 +20,9 @@ $ oc get hostfirmwarecomponents -n openshift-machine-api -o yaml`
`20`	`20`	`+`
`21`	`21`	`[source,terminal]`
`22`	`22`	`----`
`23`		`-$ oc edit <host_name> hostfirmwarecomponents -n openshift-machine-api <1>`
	`23`	`+$ oc edit <hostname> hostfirmwarecomponents -n openshift-machine-api <1>`
`24`	`24`	`----`
`25`		-<1> Where `<host_name>` is the name of the host. The `HostFirmwareComponents` resource will open in the default editor for your terminal.
	`25`	+<1> Where `<hostname>` is the name of the host. The `HostFirmwareComponents` resource will open in the default editor for your terminal.
`26`	`26`
`27`	`27`	`. Make the appropriate edits.`
`28`	`28`	`+`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`
`9`	`9`	To make changes to the `HostFirmwareSettings` spec for a provisioned host, perform the following actions:
`10`	`10`
	`11`	+* Edit the host `HostFirmwareSettings` resource.
`11`	`12`	`* Delete the host from the machine set.`
`12`	`13`	`* Scale down the machine set.`
`13`	`14`	`* Scale up the machine set to make the changes take effect.`
`@@ -30,10 +31,10 @@ $ oc get hfs -n openshift-machine-api`
`30`	`31`	`+`
`31`	`32`	`[source,terminal]`
`32`	`33`	`----`
`33`		`-$ oc edit hfs <host_name> -n openshift-machine-api`
	`34`	`+$ oc edit hfs <hostname> -n openshift-machine-api`
`34`	`35`	`----`
`35`	`36`	`+`
`36`		-Where `<host_name>` is the name of a provisioned host. The `HostFirmwareSettings` resource will open in the default editor for your terminal.
	`37`	+Where `<hostname>` is the name of a provisioned host. The `HostFirmwareSettings` resource will open in the default editor for your terminal.
`37`	`38`
`38`	`39`	. Add name and value pairs to the `spec.settings` section by running the following command:
`39`	`40`	`+`
`@@ -48,14 +49,14 @@ spec:`
`48`	`49`
`49`	`50`	`. Save the changes and exit the editor.`
`50`	`51`
`51`		`-. Get the host's machine name by running the following command:`
	`52`	`+. Get the host machine name by running the following command:`
`52`	`53`	`+`
`53`	`54`	`[source,terminal]`
`54`	`55`	`----`
`55`		`- $ oc get bmh <host_name> -n openshift-machine name`
	`56`	`+ $ oc get bmh <hostname> -n openshift-machine name`
`56`	`57`	`----`
`57`	`58`	`+`
`58`		-Where `<host_name>` is the name of the host. The terminal displays the machine name under the `CONSUMER` field.
	`59`	+Where `<hostname>` is the name of the host. The terminal displays the machine name under the `CONSUMER` field.
`59`	`60`
`60`	`61`	`. Annotate the machine to delete it from the machine set by running the following command:`
`61`	`62`	`+`