diff --git a/machine_configuration/mco-update-boot-images.adoc b/machine_configuration/mco-update-boot-images.adoc index fb6bec136ddf..207613cec9ed 100644 --- a/machine_configuration/mco-update-boot-images.adoc +++ b/machine_configuration/mco-update-boot-images.adoc @@ -6,14 +6,9 @@ include::_attributes/common-attributes.adoc[] toc::[] -include::snippets/mco-update-boot-images-intro.adoc[] - -:FeatureName: Boot image management on {vmw-short} -include::snippets/technology-preview.adoc[] +For clusters on specific {product-title} clusters, the Machine Config Operator (MCO) manages and updates the boot image that is used to scale up your nodes by default. This means that by default, the MCO updates the boot images whenever you upgrade your cluster. -[role="_additional-resources"] -.Additional resources -* xref:../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[Enabling features using feature gates] +include::snippets/mco-update-boot-images-intro.adoc[] include::modules/mco-update-boot-images-about.adoc[leveloffset=+1] diff --git a/modules/mco-update-boot-images-about.adoc b/modules/mco-update-boot-images-about.adoc index 4ee639662712..9475de9579d2 100644 --- a/modules/mco-update-boot-images-about.adoc +++ b/modules/mco-update-boot-images-about.adoc @@ -7,15 +7,13 @@ [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. - -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". - -:FeatureName: Boot image management on {vmw-short} -include::snippets/technology-preview.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. +[NOTE] +==== +include::snippets/mco-update-boot-images-intro.adoc[] +==== + However, using an older boot image could cause the following issues: * Extra time to start nodes diff --git a/modules/mco-update-boot-images-configuring.adoc b/modules/mco-update-boot-images-configuring.adoc index fb0d0033a135..97f240bf0400 100644 --- a/modules/mco-update-boot-images-configuring.adoc +++ b/modules/mco-update-boot-images-configuring.adoc @@ -7,44 +7,16 @@ [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. +For clusters on specific {product-title} clusters, the Machine Config Operator (MCO) manages and updates the boot image that is used to scale up your nodes by default. This means that by default, the MCO updates the boot images whenever you upgrade your cluster. -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. - -For {vmw-first}, you can enable boot image management as a Technology Preview feature. - -:FeatureName: Boot image management on {vmw-short} -include::snippets/technology-preview.adoc[] - -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. - -.Prerequisites - -* For {vmw-short}, enable the `TechPreviewNoUpgrade` feature set on the cluster. For more information, see "Enabling features using feature gates". -+ [NOTE] ==== -Enabling the `TechPreviewNoUpgrade` feature set cannot be undone and prevents minor version updates. These feature sets are not recommended on production clusters. +include::snippets/mco-update-boot-images-intro.adoc[] ==== -+ -Wait until the `managedBootImagesStatus` stanza displays in the `MachineConfiguration` object. -+ -[source,yaml] ----- -apiVersion: operator.openshift.io/v1 -kind: MachineConfiguration -metadata: - name: cluster -# ... -status: -# ... - managedBootImagesStatus: - machineManagers: - - apiGroup: machine.openshift.io - resource: machinesets - selection: - mode: None ----- + +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. + +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. .Procedure diff --git a/modules/mco-update-boot-images-disable.adoc b/modules/mco-update-boot-images-disable.adoc index cecbb5748839..4aaa708e0801 100644 --- a/modules/mco-update-boot-images-disable.adoc +++ b/modules/mco-update-boot-images-disable.adoc @@ -7,10 +7,13 @@ [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. - 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. +[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. After disabling the feature, you can re-enable the feature at any time. For more information, see "Enabling updated boot images". diff --git a/nodes/nodes/nodes-update-boot-images.adoc b/nodes/nodes/nodes-update-boot-images.adoc index 67801c6eaf4d..ca39cd641d8a 100644 --- a/nodes/nodes/nodes-update-boot-images.adoc +++ b/nodes/nodes/nodes-update-boot-images.adoc @@ -6,6 +6,8 @@ include::_attributes/common-attributes.adoc[] toc::[] +For clusters on specific {product-title} clusters, the Machine Config Operator (MCO) manages and updates the boot image that is used to scale up your nodes by default. This means that by default, the MCO updates the boot images whenever you upgrade your cluster. + include::snippets/mco-update-boot-images-intro.adoc[] :FeatureName: Boot image management on {vmw-short} diff --git a/snippets/mco-update-boot-images-intro.adoc b/snippets/mco-update-boot-images-intro.adoc index be3264b82ecd..a0b87872471f 100644 --- a/snippets/mco-update-boot-images-intro.adoc +++ b/snippets/mco-update-boot-images-intro.adoc @@ -5,8 +5,11 @@ :_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. +Boot image updating is available on the following platforms: -For {vmw-first}, you can enable boot image management as a Technology Preview feature. +* {gcp-first}, enabled by default +* {aws-first}, enabled by default +* {vmw-first}, disabled by default +* {azure-first}, disabled by default For all other platforms, the MCO does not update the boot image with each cluster update.