Skip to content

Commit d76a4e5

Browse files
authored
Merge pull request #94272 from mburke5678/mco-rename-updated-boot-images
MCO change Updated Boot Images to Managed Boot Images
2 parents 25f5355 + c972b39 commit d76a4e5

File tree

7 files changed

+38
-38
lines changed

7 files changed

+38
-38
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2383,7 +2383,7 @@ Topics:
23832383
File: machine-config-node-disruption
23842384
- Name: Configuring MCO-related custom resources
23852385
File: machine-configs-custom
2386-
- Name: Updated boot images
2386+
- Name: Boot image management
23872387
File: mco-update-boot-images
23882388
- Name: Managing unused rendered machine configs
23892389
File: machine-configs-garbage-collection
@@ -2814,7 +2814,7 @@ Topics:
28142814
File: nodes-remediating-fencing-maintaining-rhwa
28152815
- Name: Understanding node rebooting
28162816
File: nodes-nodes-rebooting
2817-
- Name: Updated boot images
2817+
- Name: Boot image management
28182818
File: nodes-update-boot-images
28192819
- Name: Freeing node resources using garbage collection
28202820
File: nodes-nodes-garbage-collection

machine_configuration/mco-update-boot-images.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
:context: machine-configs-configure
33
include::_attributes/common-attributes.adoc[]
44
[id="mco-update-boot-images"]
5-
= Updated boot images
5+
= Boot image management
66

77
toc::[]
88

modules/mco-update-boot-images-about.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,37 @@
55

66
:_mod-docs-content-type: PROCEDURE
77
[id="mco-update-boot-images_{context}"]
8-
= About updated boot images
8+
= About boot image management
99

1010
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.
1111

12-
For {gcp-short} and {aws-short}, you can disable this default behavior, if needed. When disabled, the boot image no longer updates with the cluster. For example, with the default behavior 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.
12+
For {gcp-short} and {aws-short}, 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.
1313

1414
However, using an older boot image could cause the following issues:
1515

1616
* Extra time to start nodes
1717
* Certificate expiration issues
1818
* Version skew issues
1919
20-
For information on how to disable the default behavior, see "Disabling updated boot images". If you disable the default behavior, you can enable the default behavior at any time. For more information, see "Enabling updated boot images".
20+
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".
2121

2222
[NOTE]
2323
====
24-
The ability to configure this behavior is available for only {gcp-short} and {aws-short} clusters. It is not supported for clusters managed by the {cluster-capi-operator}.
24+
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}.
2525
====
2626

27-
How the cluster behaves after disabling or re-enabling the default behavior, depends upon when you made the change, including the following scenarios:
27+
How the cluster behaves after disabling or re-enabling the feature, depends upon when you made the change, including the following scenarios:
2828

29-
* If you disable the behavior before updating to a new {product-title} version:
29+
* If you disable the feature before updating to a new {product-title} version:
3030
** The boot image version used by the machine sets remains the same {product-title} version as when the feature was disabled.
3131
** When you scale up nodes, the new nodes use that same {product-title} version.
3232
33-
* If you disable the behavior after updating to a new {product-title} version:
33+
* If you disable the feature after updating to a new {product-title} version:
3434
** The boot image version used by the machine sets is updated to match the updated {product-title} version.
3535
** When you scale up nodes, the new nodes use the updated {product-title} version.
3636
** If you update to a later {product-title} version, the boot image version in the machine sets remains at the current version and is not updated with the cluster.
3737
38-
* If you enable the behavior after disabling:
38+
* If you enable the feature after disabling:
3939
** The boot image version used by the machine sets is updated to the current {product-title} version, if different.
4040
** When you scale up nodes, the new nodes use the current {product-title} version in the cluster.
4141
@@ -75,9 +75,9 @@ spec:
7575
// The following admonition is intended to address https://issues.redhat.com/browse//OSDOCS-14592
7676
[IMPORTANT]
7777
====
78-
If any of the machine sets for which you want to enable updated boot images uses a `*-user-data` secret that is based on Ignition version 2.2.0, the Machine Config Operator converts the Ignition version to 3.4.0 when you enable updated boot images. {product-title} versions 4.5 and lower use Ignition version 2.2.0. If this conversion fails, the MCO or your cluster could degrade. An error message that includes _err: converting ignition stub failed: failed to parse Ignition config_ is added to the output of the `oc get ClusterOperator machine-config` command. You can use the following general steps to correct the problem:
78+
If any of the machine sets for which you want to enable boot image management use a `*-user-data` secret that is based on Ignition version 2.2.0, the Machine Config Operator converts the Ignition version to 3.4.0 when you enable the feature. {product-title} versions 4.5 and lower use Ignition version 2.2.0. If this conversion fails, the MCO or your cluster could degrade. An error message that includes _err: converting ignition stub failed: failed to parse Ignition config_ is added to the output of the `oc get ClusterOperator machine-config` command. You can use the following general steps to correct the problem:
7979
80-
. Disable updated boot images. For more information, see "Disabling updated boot images".
80+
. Disable the boot image management feature. For information, see "Disabling boot image management".
8181
. Manually update the `*-user-data` secret to use Ignition version to 3.2.0.
82-
. Enable updated boot images. For more information, see "Enabling updated boot images".
82+
. Enable the boot image management feature. For information, see "Enabling boot image management".
8383
====

modules/mco-update-boot-images-configuring.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,24 @@
55

66
:_mod-docs-content-type: PROCEDURE
77
[id="mco-update-boot-images-configuring_{context}"]
8-
= Enabling updated boot images
8+
= Enabling boot image management
99

1010
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.
1111

12-
If you disabled this default behavior, so that the boot images are not updated, you can revert to the default behavior by editing the `MachineConfiguration` object.
12+
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.
1313

14-
Enabling the default behavior 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.
14+
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.
1515

1616
.Procedure
1717

18-
. Edit the `MachineConfiguration` object, named `cluster`, to enable the default boot image update behavior for some or all of your machine sets:
18+
. Edit the `MachineConfiguration` object, named `cluster`, to enable the boot image management feature for some or all of your machine sets:
1919
+
2020
[source,terminal]
2121
----
2222
$ oc edit MachineConfiguration cluster
2323
----
2424

25-
* Optional: Enable the default behavior for all machine sets:
25+
* Optional: Enable the boot image management feature for all machine sets:
2626
+
2727
[source,yaml]
2828
----
@@ -40,12 +40,12 @@ spec:
4040
selection:
4141
mode: All <4>
4242
----
43-
<1> Configures the boot image update feature.
43+
<1> Configures the boot image management feature.
4444
<2> Specifies the API group. This must be `machine.openshift.io`.
4545
<3> Specifies the resource within the specified API group to apply the change. This must be `machinesets`.
46-
<4> Specifies that the default behavior is enabled for all machine sets in the cluster.
46+
<4> Specifies that the feature is enabled for all machine sets in the cluster.
4747
48-
* Optional: Enable the default behavior for specific machine sets:
48+
* Optional: Enable the boot image management feature for specific machine sets:
4949
+
5050
[source,yaml]
5151
----
@@ -70,7 +70,7 @@ spec:
7070
<1> Configures the boot image update feature.
7171
<2> Specifies the API group. This must be `machine.openshift.io`.
7272
<3> Specifies the resource within the specified API group to apply the change. This must be `machinesets`.
73-
<4> Specifies that the default behavior is enabled for machine sets with the specified label.
73+
<4> Specifies that the feature is enabled for machine sets with the specified label.
7474
+
7575
[TIP]
7676
====

modules/mco-update-boot-images-disable.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,26 @@
55

66
:_mod-docs-content-type: PROCEDURE
77
[id="mco-update-boot-images-disable_{context}"]
8-
= Disabling updated boot images
8+
= Disabling boot image management
99

10-
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.
10+
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.
1111

12-
You can disable this default behavior on some or all of your machine sets 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.
12+
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.
1313

1414
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.
1515

16-
After disabling a {gcp-short} and {aws-short} cluster, you can enable the default behavior at any time. For more information, see "Enabling updated boot images".
16+
After disabling the feature in a {gcp-short} or {aws-short} cluster, you can re-enable the feature at any time. For more information, see "Enabling updated boot images".
1717

1818
.Procedure
1919

20-
. Edit the `MachineConfiguration` object to disable the default boot image update behavior for some or all of your machine sets:
20+
. Edit the `MachineConfiguration` object to disable the boot image management feature for some or all of your machine sets:
2121
+
2222
[source,terminal]
2323
----
2424
$ oc edit MachineConfiguration cluster
2525
----
2626

27-
* Optional: Disable the behavior for all machine sets:
27+
* Optional: Disable the feature for all machine sets:
2828
+
2929
[source,yaml]
3030
----
@@ -44,10 +44,10 @@ spec:
4444
----
4545
+
4646
--
47-
<1> Configures the boot image update feature.
47+
<1> Configures the boot image management feature.
4848
<2> Specifies an API group. This must be `machine.openshift.io`.
4949
<3> Specifies the resource within the specified API group to apply the change. This must be `machinesets`.
50-
<4> Specifies that the default behavior is disabled for all machine sets in the cluster.
50+
<4> Specifies that the feature is disabled for all machine sets in the cluster.
5151
--
5252
5353
////
@@ -74,11 +74,11 @@ spec:
7474
matchLabels:
7575
region: "east"
7676
----
77-
<1> Configures the boot image update feature.
77+
<1> Configures the boot image management feature.
7878
<2> Specifies an API group. This must be `machine.openshift.io`.
7979
<3> Specifies the resource within the specified API group to apply the change. This must be `machinesets`.
80-
<4> Specifies that the default behavior is disabled for specific machine sets.
81-
<5> Specifies that the default behavior is enabled for only machine sets with these labels. The behavior is disabled for any machine set that does not contain the listed labels.
80+
<4> Specifies that the feature is disabled for specific machine sets.
81+
<5> Specifies that the feature is enabled only for machine sets with these labels. The feature is disabled for any machine set that does not contain the listed labels.
8282
////
8383

8484
.Verification

nodes/nodes/nodes-update-boot-images.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
:context: nodes-update-boot-images
33
include::_attributes/common-attributes.adoc[]
44
[id="nodes-update-boot-images"]
5-
= Updated boot images
5+
= Boot image management
66

77
toc::[]
88

@@ -12,8 +12,8 @@ include::modules/mco-update-boot-images-about.adoc[leveloffset=+1]
1212

1313
[role="_additional-resources"]
1414
.Additional resources
15-
* xref:../../machine_configuration/mco-update-boot-images.adoc#mco-update-boot-images-disable_machine-configs-configure[Disabling updated boot images]
16-
* xref:../../machine_configuration/mco-update-boot-images.adoc#mco-update-boot-images-configuring_machine-configs-configure[Enabling updated boot images]
15+
* xref:../../machine_configuration/mco-update-boot-images.adoc#mco-update-boot-images-disable_machine-configs-configure[Disabling boot image management]
16+
* xref:../../machine_configuration/mco-update-boot-images.adoc#mco-update-boot-images-configuring_machine-configs-configure[Enabling boot image management]
1717
1818
include::modules/mco-update-boot-images-disable.adoc[leveloffset=+1]
1919
include::modules/mco-update-boot-images-configuring.adoc[leveloffset=+1]

snippets/mco-update-boot-images-verification.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
:_mod-docs-content-type: SNIPPET
77

8-
* View the current state of the boot image updates by viewing the machine configuration object:
8+
* View the current state of the boot image management feature by viewing the machine configuration object:
99
+
1010
[source,terminal]
1111
----

0 commit comments

Comments
 (0)