mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OCDOCS 15797 OCPSTRAT-2182 Updated boot images: Phase 5 (vsphere, Azure TP)
This commit is contained in:
Michael Burke
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
5afd24db25
commit
81e7d46c1a
@@ -6,15 +6,13 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
include::snippets/mco-update-boot-images-abstract.adoc[]
|
||||
|
||||
include::snippets/mco-update-boot-images-intro.adoc[]
|
||||
|
||||
:FeatureName: Boot image management on {vmw-short}
|
||||
:FeatureName: Boot image management for control plane nodes
|
||||
include::snippets/technology-preview.adoc[]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling-features[Enabling features using feature gates]
|
||||
|
||||
include::modules/mco-update-boot-images-about.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
@@ -22,6 +20,6 @@ include::modules/mco-update-boot-images-about.adoc[leveloffset=+1]
|
||||
* xref:../machine_configuration/mco-update-boot-images.adoc#mco-update-boot-images-disable_machine-configs-configure[Disabling boot image management]
|
||||
* xref:../machine_configuration/mco-update-boot-images.adoc#mco-update-boot-images-configuring_machine-configs-configure[Enabling boot image management]
|
||||
|
||||
include::modules/mco-update-boot-images-disable.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/mco-update-boot-images-configuring.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/mco-update-boot-images-disable.adoc[leveloffset=+1]
|
||||
|
||||
@@ -3,31 +3,29 @@
|
||||
// * nodes/nodes/nodes-update-boot-images.adoc
|
||||
// * machine_configuration/mco-update-boot-images.adoc
|
||||
|
||||
:_mod-docs-content-type: PROCEDURE
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="mco-update-boot-images_{context}"]
|
||||
= About boot image management
|
||||
|
||||
By default, for {gcp-first} and {aws-first} clusters, the Machine Config Operator (MCO) updates the boot image in the machine sets in your cluster whenever you update your cluster.
|
||||
[role="_abstract"]
|
||||
With boot image management enabled, the Machine Config Operator (MCO) manages and updates the {op-system-first} version of the boot image in the machine sets for your control plane or worker nodes. This means that the MCO updates the boot image whenever you update your cluster. Without boot image management enabled, if your cluster was originally created with an older {product-title} version, the boot image that the MCO would use to create new nodes is an older {op-system-first} version, even if your cluster is at a later {product-title} version.
|
||||
|
||||
For {vmw-first}, you can enable boot image management as a Technology Preview feature. For information on how to enable this feature, see "Enabling boot image management".
|
||||
New nodes created after enabling the feature use the updated boot image. This feature has no effect on existing nodes.
|
||||
|
||||
:FeatureName: Boot image management on {vmw-short}
|
||||
include::snippets/technology-preview.adoc[]
|
||||
[NOTE]
|
||||
====
|
||||
include::snippets/mco-update-boot-images-intro.adoc[]
|
||||
====
|
||||
|
||||
You can disable the boot image management feature, if needed. When the feature is disabled, the boot image no longer updates with the cluster. For example, with the feature disabled, if your cluster was originally created with {product-title} 4.16, the boot image that the MCO would use to create nodes is the same 4.16 version, even if your cluster is at a later version.
|
||||
For example, with the feature disabled, if your cluster was originally created with {product-title} 4.16, the boot image that the MCO would use to create new nodes is the same {op-system} version that was installed for the cluster, even if your cluster is currently at a later {product-title} version.
|
||||
|
||||
However, using an older boot image could cause the following issues:
|
||||
Using an older boot image could cause the following issues:
|
||||
|
||||
* Extra time to start nodes
|
||||
* Certificate expiration issues
|
||||
* Version skew issues
|
||||
|
||||
For information on how to disable this feature, see "Disabling boot image management". If you disable this feature, you can re-enable the feature at any time. For information, see "Enabling boot image management".
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
The ability to configure boot image management is available for only {gcp-short} and {aws-short} clusters. It is not supported for clusters managed by the {cluster-capi-operator}.
|
||||
====
|
||||
You can disable the boot image management feature, if needed. When the feature is disabled, the boot image version no longer updates with the cluster. For example, you could disable the boot image management feature in order to use a custom boot image that you do not want changed. For information on how to disable this feature, see "Disabling boot image management". If you disable this feature, you can re-enable the feature at any time. For information, see "Enabling boot image management".
|
||||
|
||||
How the cluster behaves after disabling or re-enabling the feature, depends upon when you made the change, including the following scenarios:
|
||||
|
||||
@@ -49,78 +47,20 @@ How the cluster behaves after disabling or re-enabling the feature, depends upon
|
||||
Because a boot image is used only when a node is scaled up, this feature has no effect on existing nodes.
|
||||
====
|
||||
|
||||
To view the current boot image used in your cluster, use one of the following methods, based on your platform:
|
||||
|
||||
* For {gcp-short} and {aws-short}, you can examine a machine set.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
The location and format of the boot image within the machine set differs, based on the platform. However, the boot image is always listed in the `spec.template.spec.providerSpec.` parameter.
|
||||
====
|
||||
+
|
||||
.Example {gcp-short} machine set with the boot image reference
|
||||
To view the current {op-system-first} boot image version used in your cluster, you can view the `/sysroot/.coreos-aleph-version.json` file on that node.
|
||||
|
||||
.Example coreos-aleph-version.json file with an older boot image
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: machine.openshift.io/v1beta1
|
||||
kind: MachineSet
|
||||
metadata:
|
||||
name: ci-ln-hmy310k-72292-5f87z-worker-a
|
||||
namespace: openshift-machine-api
|
||||
spec:
|
||||
# ...
|
||||
template:
|
||||
# ...
|
||||
spec:
|
||||
# ...
|
||||
providerSpec:
|
||||
# ...
|
||||
value:
|
||||
disks:
|
||||
- autoDelete: true
|
||||
boot: true
|
||||
image: projects/rhcos-cloud/global/images/rhcos-412-85-202203181601-0-gcp-x86-64 <1>
|
||||
{
|
||||
# ...
|
||||
"ref": "docker://ostree-image-signed:oci-archive:/rhcos-418.94.202511191518-0-ostree.x86_64.ociarchive",
|
||||
"version": "418.94.202511191518-0"
|
||||
}
|
||||
----
|
||||
<1> This boot image is the same as the originally-installed {product-title} version, in this example {product-title} 4.12, regardless of the current version of the cluster. The way that the boot image is represented in the machine set depends on the platform, as the structure of the `providerSpec` field differs from platform to platform.
|
||||
+
|
||||
.Example {aws-short} machine set with the boot image reference
|
||||
where:
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: machine.openshift.io/v1beta1
|
||||
kind: MachineSet
|
||||
metadata:
|
||||
name: ci-ln-hmy310k-72292-5f87z-worker-a
|
||||
namespace: openshift-machine-api
|
||||
spec:
|
||||
# ...
|
||||
template:
|
||||
# ...
|
||||
spec:
|
||||
# ...
|
||||
providerSpec:
|
||||
value:
|
||||
ami:
|
||||
id: ami-0e8fd9094e487d1ff
|
||||
# ...
|
||||
----
|
||||
|
||||
* For {vmw-first}, examine an affected node by opening an `oc debug` session to the node and using the `rpm-ostree status` command.
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
sh-5.1# rpm-ostree status
|
||||
----
|
||||
+
|
||||
.Example {aws-short} node with the boot image reference
|
||||
+
|
||||
----
|
||||
State: idle
|
||||
Deployments:
|
||||
* ostree-unverified-registry:quay.io/my-registry/...
|
||||
Digest: sha256:...
|
||||
----
|
||||
`<version>`:: Specifies the {op-system-first} boot image version. In this example, the boot image is from the originally-installed {product-title} 4.18 version, regardless of the current version of the cluster.
|
||||
|
||||
// The following admonition is intended to address https://issues.redhat.com/browse//OSDOCS-14592
|
||||
[IMPORTANT]
|
||||
|
||||
@@ -7,78 +7,60 @@
|
||||
[id="mco-update-boot-images-configuring_{context}"]
|
||||
= Enabling boot image management
|
||||
|
||||
By default, for {gcp-first} and {aws-first} clusters, the Machine Config Operator (MCO) updates the boot image in the machine sets in your cluster whenever you update your cluster.
|
||||
include::snippets/mco-update-boot-images-abstract.adoc[]
|
||||
|
||||
If you disabled the boot image management feature, so that the boot images are not updated, you can re-enable the feature by editing the `MachineConfiguration` object.
|
||||
[NOTE]
|
||||
====
|
||||
include::snippets/mco-update-boot-images-intro.adoc[]
|
||||
====
|
||||
|
||||
For {vmw-first}, you can enable boot image management as a Technology Preview feature.
|
||||
To enable the boot image management feature for control plane machine sets or to re-enable the boot image management feature for worker machine sets where it was disabled, edit the `MachineConfiguration` object. You can enable the feature for all of the machine sets in the cluster or specific machine sets.
|
||||
|
||||
:FeatureName: Boot image management on {vmw-short}
|
||||
include::snippets/technology-preview.adoc[]
|
||||
[NOTE]
|
||||
====
|
||||
Because the boot image management feature for worker nodes is default for the {gcp-short} and {aws-short} platforms, the `managedBootImages` configuration does not appear in the machine configuration object. To enable the feature for control plane machine sets without disabling the feature for worker machine sets, you must expressly add the configuration for both the control plane and worker machine sets, as shown in the following procedure. If you add only the configuration for control plane machine sets, due to default behavior, the Machine Config Operator (MCO) overwrites the configuration for the worker machine sets.
|
||||
====
|
||||
|
||||
Enabling the feature updates the boot image to the current {product-title} version. If the cluster is again updated to a new {product-title} version in the future, the boot image is updated again. New nodes created after enabling the feature use the updated boot image. This feature has no effect on existing nodes.
|
||||
Enabling the feature updates the boot image to the {op-system-first} boot image version appropriate for your cluster. If the cluster is again updated to a new {product-title} version in the future, the boot image is updated again. New nodes created after enabling the feature use the updated boot image. This feature has no effect on existing nodes.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* For {vmw-short}, enable the `TechPreviewNoUpgrade` feature set on the cluster. For more information, see "Enabling features using feature gates".
|
||||
* If you are enabling boot image management for control plane machine sets, you enabled the required Technology Preview features for your cluster by editing the `FeatureGate` CR named `cluster`:
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
Enabling the `TechPreviewNoUpgrade` feature set cannot be undone and prevents minor version updates. These feature sets are not recommended on production clusters.
|
||||
====
|
||||
+
|
||||
Wait until the `managedBootImagesStatus` stanza displays in the `MachineConfiguration` object.
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc edit featuregate cluster
|
||||
----
|
||||
+
|
||||
.Example `FeatureGate` CR
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: operator.openshift.io/v1
|
||||
kind: MachineConfiguration
|
||||
apiVersion: config.openshift.io/v1
|
||||
kind: FeatureGate
|
||||
metadata:
|
||||
name: cluster
|
||||
# ...
|
||||
status:
|
||||
# ...
|
||||
managedBootImagesStatus:
|
||||
machineManagers:
|
||||
- apiGroup: machine.openshift.io
|
||||
resource: machinesets
|
||||
selection:
|
||||
mode: None
|
||||
spec:
|
||||
featureSet: TechPreviewNoUpgrade <1>
|
||||
----
|
||||
<1> Enables the required `ManagedBootImagesCPMS` feature gate.
|
||||
+
|
||||
[WARNING]
|
||||
====
|
||||
Do not enable this feature set on production clusters. Enabling the `TechPreviewNoUpgrade` feature set on your cluster cannot be undone and prevents minor version updates. This feature set allows you to enable these Technology Preview features on test clusters, where you can fully test them. Do not enable this feature set on production clusters.
|
||||
====
|
||||
|
||||
.Procedure
|
||||
|
||||
. Edit the `MachineConfiguration` object, named `cluster`, to enable the boot image management feature for some or all of your machine sets:
|
||||
. Edit the `MachineConfiguration` object, named `cluster`, by using the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc edit MachineConfiguration cluster
|
||||
----
|
||||
|
||||
* Optional: Enable the boot image management feature for all machine sets:
|
||||
+
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: operator.openshift.io/v1
|
||||
kind: MachineConfiguration
|
||||
metadata:
|
||||
name: cluster
|
||||
namespace: openshift-machine-config-operator
|
||||
spec:
|
||||
# ...
|
||||
managedBootImages: <1>
|
||||
machineManagers:
|
||||
- apiGroup: machine.openshift.io <2>
|
||||
resource: machinesets <3>
|
||||
selection:
|
||||
mode: All <4>
|
||||
----
|
||||
<1> Configures the boot image management feature.
|
||||
<2> Specifies the API group. This must be `machine.openshift.io`.
|
||||
<3> Specifies the resource within the specified API group to apply the change. This must be `machinesets`.
|
||||
<4> Specifies that the feature is enabled for all machine sets in the cluster.
|
||||
. Enable the boot image management feature for some or all of your machine sets:
|
||||
|
||||
* Optional: Enable the boot image management feature for specific machine sets:
|
||||
* Enable the boot image management feature for all machine sets:
|
||||
+
|
||||
[source,yaml]
|
||||
----
|
||||
@@ -89,31 +71,157 @@ metadata:
|
||||
namespace: openshift-machine-config-operator
|
||||
spec:
|
||||
# ...
|
||||
managedBootImages: <1>
|
||||
managedBootImages:
|
||||
machineManagers:
|
||||
- apiGroup: machine.openshift.io <2>
|
||||
resource: machinesets <3>
|
||||
- apiGroup: machine.openshift.io
|
||||
resource: controlplanemachinesets
|
||||
selection:
|
||||
mode: Partial <4>
|
||||
mode: All
|
||||
- apiGroup: machine.openshift.io
|
||||
resource: machinesets
|
||||
selection:
|
||||
mode: All
|
||||
----
|
||||
+
|
||||
--
|
||||
where:
|
||||
|
||||
`spec.managedBootImages`:: Configures the boot image management feature.
|
||||
|
||||
`spec.managedBootImages.machineManagers.apiGroup`:: Specifies the API group. This must be `machine.openshift.io`.
|
||||
|
||||
`spec.managedBootImages.machineManagers.resource`:: Specifies the resource within the specified API group to apply the change. Use one or both of the following parameters. You must add the full stanza, as shown, if you want to enable the feature for control plane and worker machine sets.
|
||||
|
||||
* `controlplanemachinesets`: Enables boot image management for control plane machine sets.
|
||||
* `machinesets`: Enables boot image management for worker machine sets.
|
||||
|
||||
`spec.managedBootImages.machineManagers.selection.mode`:: Specifies that the feature is enabled for all machine sets in the cluster.
|
||||
--
|
||||
|
||||
* Enable the boot image management feature for specific worker machine sets:
|
||||
+
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: operator.openshift.io/v1
|
||||
kind: MachineConfiguration
|
||||
metadata:
|
||||
name: cluster
|
||||
namespace: openshift-machine-config-operator
|
||||
spec:
|
||||
# ...
|
||||
managedBootImages:
|
||||
machineManagers:
|
||||
- apiGroup: machine.openshift.io
|
||||
resource: machinesets
|
||||
selection:
|
||||
mode: Partial
|
||||
partial:
|
||||
machineResourceSelector:
|
||||
matchLabels:
|
||||
region: "east"
|
||||
----
|
||||
<1> Configures the boot image update feature.
|
||||
<2> Specifies the API group. This must be `machine.openshift.io`.
|
||||
<3> Specifies the resource within the specified API group to apply the change. This must be `machinesets`.
|
||||
<4> Specifies that the feature is enabled for machine sets with the specified label.
|
||||
+
|
||||
[TIP]
|
||||
====
|
||||
If an appropriate label is not present on the machine set, add a key-value pair by running a command similar to following:
|
||||
--
|
||||
where:
|
||||
|
||||
----
|
||||
$ oc label machineset.machine ci-ln-hmy310k-72292-5f87z-worker-a region="east" -n openshift-machine-api
|
||||
----
|
||||
====
|
||||
`spec.managedBootImages`:: Configures the boot image management feature.
|
||||
|
||||
`spec.managedBootImages.machineManagers.apiGroup`:: Specifies the API group. This must be `machine.openshift.io`.
|
||||
|
||||
`spec.managedBootImages.machineManagers.resource`:: Specifies the resource within the specified API group to apply the change. This must be `machinesets`. Partial boot image management for control plane machine sets is not supported.
|
||||
|
||||
`spec.managedBootImages.machineManagers.selection.mode`:: Specifies that the feature is enabled for specific machine sets in the cluster. This must be `Partial`.
|
||||
|
||||
`spec.managedBootImages.machineManagers.selection.partial`:: Specifies that the feature is enabled for machine sets with the specified label in their `MachineSet` object.
|
||||
--
|
||||
|
||||
.Verification
|
||||
|
||||
include::snippets/mco-update-boot-images-verification.adoc[]
|
||||
. View the current state of the boot image management feature by using the following command to view the machine configuration object:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc get machineconfiguration cluster -o yaml
|
||||
----
|
||||
+
|
||||
.Example machine set with the boot image reference
|
||||
+
|
||||
[source,yaml]
|
||||
----
|
||||
kind: MachineConfiguration
|
||||
metadata:
|
||||
name: cluster
|
||||
# ...
|
||||
status:
|
||||
conditions:
|
||||
- lastTransitionTime: "2025-05-01T20:11:49Z"
|
||||
message: Reconciled 2 of 4 MAPI MachineSets | Reconciled 0 of 0 CAPI MachineSets
|
||||
| Reconciled 0 of 0 CAPI MachineDeployments
|
||||
reason: BootImageUpdateConfigurationUpdated
|
||||
status: "True"
|
||||
type: BootImageUpdateProgressing
|
||||
- lastTransitionTime: "2025-05-01T19:30:13Z"
|
||||
message: 0 Degraded MAPI MachineSets | 0 Degraded CAPI MachineSets | 0 CAPI MachineDeployments
|
||||
reason: BootImageUpdateConfigurationUpdated
|
||||
status: "False"
|
||||
type: BootImageUpdateDegraded
|
||||
managedBootImagesStatus:
|
||||
machineManagers:
|
||||
- apiGroup: machine.openshift.io
|
||||
resource: controlplanemachinesets
|
||||
selection:
|
||||
mode: All
|
||||
- apiGroup: machine.openshift.io
|
||||
resource: machinesets
|
||||
selection:
|
||||
mode: All
|
||||
----
|
||||
+
|
||||
--
|
||||
where:
|
||||
|
||||
`status.managedBootImagesStatus.machineManagers.selection.mode`:: Specifies that the boot image management feature is enabled when set to `All`.
|
||||
--
|
||||
|
||||
. Scale a machine set to create a new node by using a command similar to the following. The boot image is updated only for new nodes.
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc scale --replicas=2 machinesets.machine.openshift.io <machineset> -n openshift-machine-api
|
||||
----
|
||||
|
||||
. If your cluster was using an older boot image version, you can see the new boot image version when the new node reaches the `READY` state. View the {op-system-first} version on a nodes:
|
||||
|
||||
.. Log in to the node by using a command similar to the following:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc debug node/<node_name>
|
||||
----
|
||||
|
||||
.. Set `/host` as the root directory within the debug shell by using the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
sh-5.1# chroot /host
|
||||
----
|
||||
|
||||
.. View the `/sysroot/.coreos-aleph-version.json` file by using a command similar to the following:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
sh-5.1# cat /sysroot/.coreos-aleph-version.json
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
[source,yaml]
|
||||
----
|
||||
{
|
||||
# ...
|
||||
"ref": "docker://ostree-image-signed:oci-archive:/rhcos-9.6.20251015-1-ostree.x86_64.ociarchive",
|
||||
"version": "9.6.20251015-1"
|
||||
}
|
||||
----
|
||||
where:
|
||||
|
||||
`<version>`:: Specifies the boot image version.
|
||||
|
||||
@@ -7,9 +7,15 @@
|
||||
[id="mco-update-boot-images-disable_{context}"]
|
||||
= Disabling boot image management
|
||||
|
||||
By default, for {gcp-first} and {aws-first} clusters, the Machine Config Operator (MCO) manages and updates the boot image in the machine sets in your cluster whenever you update your cluster. For {vmw-first}, you can enable boot image management as a Technology Preview feature.
|
||||
[role="_abstract"]
|
||||
You can disable the boot image management feature so that the Machine Config Operator (MCO) no longer manages or updates the boot image in the affected machine sets. For example, you could disable this feature for the worker nodes in order to use a custom boot image that you do not want changed.
|
||||
|
||||
You can disable the boot image management feature for your cluster by editing the `MachineConfiguration` object. When disabled, the Machine Config Operator (MCO) no longer manages the boot image in your cluster and no longer updates the boot image with each cluster update.
|
||||
You disable the boot image management feature for the control plane or worker machine sets in your cluster by editing the `MachineConfiguration` object.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
include::snippets/mco-update-boot-images-intro.adoc[]
|
||||
====
|
||||
|
||||
Disabling this feature does not rollback the nodes or machine sets to the originally-installed boot image. The machine sets retain the boot image version that was present when the feature was disabled and is not updated if the cluster is upgraded to a new {product-title} version in the future. This feature has no effect on existing nodes.
|
||||
|
||||
@@ -17,14 +23,14 @@ After disabling the feature, you can re-enable the feature at any time. For more
|
||||
|
||||
.Procedure
|
||||
|
||||
. Edit the `MachineConfiguration` object to disable the boot image management feature for some or all of your machine sets:
|
||||
. Edit the `MachineConfiguration` object, named `cluster`, by using the following command::
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc edit MachineConfiguration cluster
|
||||
----
|
||||
|
||||
* Optional: Disable the feature for all machine sets:
|
||||
. Disable the feature for some or all of your machine sets:
|
||||
+
|
||||
[source,yaml]
|
||||
----
|
||||
@@ -35,19 +41,28 @@ metadata:
|
||||
namespace: openshift-machine-config-operator
|
||||
spec:
|
||||
# ...
|
||||
managedBootImages: <1>
|
||||
managedBootImages:
|
||||
machineManagers:
|
||||
- apiGroup: machine.openshift.io <2>
|
||||
resource: machinesets <3>
|
||||
- apiGroup: machine.openshift.io
|
||||
resource: machinesets
|
||||
selection:
|
||||
mode: None <4>
|
||||
mode: None
|
||||
- apiGroup: machine.openshift.io
|
||||
resource: controlplanemachinesets
|
||||
selection:
|
||||
mode: None
|
||||
----
|
||||
+
|
||||
--
|
||||
<1> Configures the boot image management feature.
|
||||
<2> Specifies an API group. This must be `machine.openshift.io`.
|
||||
<3> Specifies the resource within the specified API group to apply the change. This must be `machinesets`.
|
||||
<4> Specifies that the feature is disabled for all machine sets in the cluster.
|
||||
where:
|
||||
|
||||
`spec.managedBootImages`:: Configures the boot image management feature.
|
||||
|
||||
`spec.managedBootImages.machineManagers.selection.mode.None`:: Specifies that the feature is disabled for all machine sets in the cluster. Set the selection mode to `None` for one or both of the following resources to disable the feature for that resource.
|
||||
|
||||
* `controlplanemachinesets`: Disable boot image management for control plane machine sets.
|
||||
|
||||
* `machinesets`: Disables boot image management for worker machine sets.
|
||||
--
|
||||
|
||||
////
|
||||
@@ -83,4 +98,48 @@ spec:
|
||||
|
||||
.Verification
|
||||
|
||||
include::snippets/mco-update-boot-images-verification.adoc[]
|
||||
* View the current state of the boot image management feature by using the following command to view the machine configuration object:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc get machineconfiguration cluster -o yaml
|
||||
----
|
||||
+
|
||||
.Example machine set with the boot image reference
|
||||
+
|
||||
[source,yaml]
|
||||
----
|
||||
kind: MachineConfiguration
|
||||
metadata:
|
||||
name: cluster
|
||||
# ...
|
||||
status:
|
||||
conditions:
|
||||
- lastTransitionTime: "2025-05-01T20:11:49Z"
|
||||
message: Reconciled 2 of 4 MAPI MachineSets | Reconciled 0 of 0 CAPI MachineSets
|
||||
| Reconciled 0 of 0 CAPI MachineDeployments
|
||||
reason: BootImageUpdateConfigurationUpdated
|
||||
status: "True"
|
||||
type: BootImageUpdateProgressing
|
||||
- lastTransitionTime: "2025-05-01T19:30:13Z"
|
||||
message: 0 Degraded MAPI MachineSets | 0 Degraded CAPI MachineSets | 0 CAPI MachineDeployments
|
||||
reason: BootImageUpdateConfigurationUpdated
|
||||
status: "False"
|
||||
type: BootImageUpdateDegraded
|
||||
managedBootImagesStatus:
|
||||
machineManagers:
|
||||
- apiGroup: machine.openshift.io
|
||||
resource: controlplanemachinesets
|
||||
selection:
|
||||
mode: None
|
||||
- apiGroup: machine.openshift.io
|
||||
resource: machinesets
|
||||
selection:
|
||||
mode: All
|
||||
----
|
||||
+
|
||||
--
|
||||
where:
|
||||
|
||||
`status.managedBootImagesStatus.machineManagers.selection.mode`:: Specifies that the boot image management feature is disabled when set to `None`. In this example, the boot image management feature is disabled for control plane machine sets and enabled for worker machine sets.
|
||||
--
|
||||
|
||||
@@ -6,15 +6,10 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
include::snippets/mco-update-boot-images-abstract.adoc[]
|
||||
|
||||
include::snippets/mco-update-boot-images-intro.adoc[]
|
||||
|
||||
:FeatureName: Boot image management on {vmw-short}
|
||||
include::snippets/technology-preview.adoc[]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling-features[Enabling features using feature gates]
|
||||
|
||||
include::modules/mco-update-boot-images-about.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
|
||||
8
snippets/mco-update-boot-images-abstract.adoc
Normal file
8
snippets/mco-update-boot-images-abstract.adoc
Normal file
@@ -0,0 +1,8 @@
|
||||
//
|
||||
// * machine_configuration/mco-update-boot-images.adoc
|
||||
// * nodes/nodes/nodes-update-boot-images.adoc
|
||||
|
||||
:_mod-docs-content-type: SNIPPET
|
||||
|
||||
[role="_abstract"]
|
||||
For supported platforms, the Machine Config Operator (MCO) can manage and update the boot image on each node to ensure the {op-system-first} version of the boot image matches the {op-system-first} version appropriate for your cluster.
|
||||
@@ -5,8 +5,27 @@
|
||||
|
||||
:_mod-docs-content-type: SNIPPET
|
||||
|
||||
For {gcp-first} and {aws-first} clusters, by default the Machine Config Operator (MCO) manages and updates the boot image that is used to scale up your nodes. This means that by default, the MCO updates the boot images whenever you upgrade your cluster.
|
||||
The following table lists the platforms on which boot image management is available:
|
||||
|
||||
For {vmw-first}, you can enable boot image management as a Technology Preview feature.
|
||||
|===
|
||||
|Platform |Worker machine sets |Control plane machine sets
|
||||
|
||||
|{gcp-first}
|
||||
|Enabled by default
|
||||
|Disabled by default
|
||||
|
||||
|{aws-first}
|
||||
|Enabled by default
|
||||
|Disabled by default
|
||||
|
||||
|{azure-first}
|
||||
|Enabled by default
|
||||
|Disabled by default
|
||||
|
||||
|{vmw-first}
|
||||
|Enabled by default
|
||||
|Not supported
|
||||
|
||||
|===
|
||||
|
||||
For all other platforms, the MCO does not update the boot image with each cluster update.
|
||||
|
||||
@@ -1,112 +0,0 @@
|
||||
// Text snippet included in the following modules:
|
||||
//
|
||||
// * modules/mco-update-boot-images-configuring.adoc
|
||||
// * modules/mco-update-boot-images-disable.adoc
|
||||
|
||||
:_mod-docs-content-type: SNIPPET
|
||||
|
||||
* When the affected nodes return to the `READY` state, view the current state of the boot image management feature by viewing the machine configuration object:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc get machineconfiguration cluster -o yaml
|
||||
----
|
||||
+
|
||||
.Example machine set with the boot image reference
|
||||
+
|
||||
[source,yaml]
|
||||
----
|
||||
kind: MachineConfiguration
|
||||
metadata:
|
||||
name: cluster
|
||||
# ...
|
||||
status:
|
||||
conditions:
|
||||
- lastTransitionTime: "2025-05-01T20:11:49Z"
|
||||
message: Reconciled 2 of 4 MAPI MachineSets | Reconciled 0 of 0 CAPI MachineSets
|
||||
| Reconciled 0 of 0 CAPI MachineDeployments
|
||||
reason: BootImageUpdateConfigurationUpdated
|
||||
status: "True"
|
||||
type: BootImageUpdateProgressing
|
||||
- lastTransitionTime: "2025-05-01T19:30:13Z"
|
||||
message: 0 Degraded MAPI MachineSets | 0 Degraded CAPI MachineSets | 0 CAPI MachineDeployments
|
||||
reason: BootImageUpdateConfigurationUpdated
|
||||
status: "False"
|
||||
type: BootImageUpdateDegraded
|
||||
managedBootImagesStatus:
|
||||
machineManagers:
|
||||
- apiGroup: machine.openshift.io
|
||||
resource: machinesets
|
||||
selection:
|
||||
mode: All
|
||||
----
|
||||
|
||||
* When the affected nodes return to the `READY` state, check the current boot image by using one of the following methods:
|
||||
|
||||
** For {gcp-short} and {aws-short}, get the boot image version by running the following command. The location and format of the boot image within the machine set differs, based on the platform. However, the boot image is always listed in the `spec.template.spec.providerSpec.` parameter.
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc get machinesets <machineset_name> -n openshift-machine-api -o yaml
|
||||
----
|
||||
+
|
||||
.Example machine set with the boot image reference
|
||||
+
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: machine.openshift.io/v1beta1
|
||||
kind: MachineSet
|
||||
metadata:
|
||||
labels:
|
||||
machine.openshift.io/cluster-api-cluster: ci-ln-77hmkpt-72292-d4pxp
|
||||
update-boot-image: "true"
|
||||
name: ci-ln-77hmkpt-72292-d4pxp-worker-a
|
||||
namespace: openshift-machine-api
|
||||
spec:
|
||||
# ...
|
||||
template:
|
||||
# ...
|
||||
spec:
|
||||
# ...
|
||||
providerSpec:
|
||||
# ...
|
||||
value:
|
||||
disks:
|
||||
- autoDelete: true
|
||||
boot: true
|
||||
image: projects/rhcos-cloud/global/images/<boot_image> <1>
|
||||
# ...
|
||||
----
|
||||
<1> This boot image is the same as the current {product-title} version.
|
||||
|
||||
** For {vmw-first}, get the boot image version from an affected node:
|
||||
|
||||
.. Open an `oc debug` session to the node by running a command similar to the following:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc debug node/<node_name>
|
||||
----
|
||||
|
||||
.. Set `/host` as the root directory within the debug shell by running the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
sh-5.1# chroot /host
|
||||
----
|
||||
|
||||
.. Run the `rpm-ostree status` command to view that the custom layered image is in use:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
sh-5.1# rpm-ostree status
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
+
|
||||
----
|
||||
State: idle
|
||||
Deployments:
|
||||
* ostree-unverified-registry:quay.io/my-registry/...
|
||||
Digest: sha256:...
|
||||
----
|
||||
Reference in New Issue
Block a user