Skip to content

Commit 260c57f

Browse files
author
Michael Burke
committed
proofread
1 parent 435c8cb commit 260c57f

4 files changed

Lines changed: 21 additions & 35 deletions

File tree

machine_configuration/mco-update-boot-images.adoc

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,3 @@ include::modules/mco-update-boot-images-openstack.adoc[leveloffset=+2]
3131
* xref:../installing/installing_aws/ipi/ipi-aws-preparing-to-install.adoc#installation-obtaining-installer_ipi-aws-preparing-to-install[Obtaining the installation program]
3232
3333
include::modules/mco-update-boot-images-disable.adoc[leveloffset=+1]
34-
35-
include::modules/mco-update-boot-skew-mgmt-about.adoc[leveloffset=+1]
36-
37-
include::modules/mco-update-boot-skew-mgmt-configuring.adoc[leveloffset=+2]
38-
39-
[role="_additional-resources"]
40-
[id="additional-resources_{context}"]
41-
== Additional resources
42-
43-
* [Manually updating the boot image forthcoming after https://github.com/openshift/openshift-docs/pull/108014 merges]
44-
45-
* xref:../machine_configuration/mco-update-boot-skew-mgmt.adoc#mco-update-boot-skew-mgmt[Boot image skew enforcement]

modules/mco-update-boot-skew-mgmt-about.adoc

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
// * machine-configuration/mco-update-boot-skew-mgmt.adoc
44

55
:_mod-docs-content-type: CONCEPT
6-
[id="mco-update-boot-skew-mgmt-about.adoc_{context}"]
6+
[id="mco-update-boot-skew-mgmt-about_{context}"]
77
= About boot image skew enforcement
88

99
[role="_abstract"]
10-
Using boot image skew enforcement you can ensure that the boot images in a cluster are up-to-date with the {product-title} and {op-system} version being used in the cluster. Making sure that your boot images are current can help you avoid the problems associated with running older images.
10+
Using boot image skew enforcement, you can ensure that the boot images in a cluster are up-to-date with the {product-title} and {op-system} version being used in the cluster. Making sure that your boot images are current can help you avoid the problems associated with running older images.
1111

12-
When boot image skew enforcement is active in a cluster, the Machine Config Operator (MCO) examines the boot image version reported in the `MachineConfiguration` object to determine if that boot image is appropriate for the cluster. If the boot image version is too old, the Operator reports that _boot image version skew_ is detected and blocks cluster updates until you manually update the boot image or set boot image skew enforcement to the `None` mode, as described in this section.
12+
When boot image skew enforcement is active in a cluster, the Machine Config Operator (MCO) examines the boot image version reported in the `MachineConfiguration` object to determine if that boot image is appropriate for the cluster. If the boot image version is too old, the Operator reports that _boot image version skew_ is detected and blocks cluster updates until you manually update the boot image or disable boot image skew enforcement by setting the `None` mode, as described in this section.
1313

1414
The limit for boot image version skew is set within the MCO and cannot be modified.
1515

@@ -21,7 +21,7 @@ include::snippets/technology-preview.adoc[]
2121
Boot image skew enforcement operates in one of the following modes:
2222

2323
Automatic::
24-
In automatic mode, when the cluster is updated from one {product-title} version to the next, with boot image management also enabled, the MCO automatically updates the boot image version in the `MachineConfiguration` object and tests the boot image version for skew. Boot image management must be enabled in the node to use the automatic mode.
24+
When set to `Automatic`, if the cluster is updated from one {product-title} version to the next, with boot image management also enabled, the MCO automatically updates the boot image version in the `MachineConfiguration` object and tests the boot image version for skew.
2525
+
2626
[NOTE]
2727
====
@@ -52,9 +52,8 @@ status:
5252
+
5353
The MCO examines the boot image reported in the `ocpVersion` parameter to determine if the cluster is violating the boot image version skew limits.
5454

55-
Manual:: In manual mode, when the boot image version is updated, a cluster administrator is responsible to manually update the `MachneConfiguration` object with the {op-system} version of the boot image or the {product-title} associated with the boot image. The MCO then tests the boot image version for skew.
56-
+
57-
For information on boot image management, see "Boot image management".
55+
Manual::
56+
When set to `Manual`, if the boot image version is updated, a cluster administrator is responsible to manually update the `MachneConfiguration` object with the {op-system} version of the new boot image or the {product-title} version associated with the new boot image. The MCO then tests the boot image version for skew.
5857
+
5958
.Example `MachineConfiguration` object with skew enforcement based on an {op-system} version
6059
[source,yaml]
@@ -102,10 +101,10 @@ status:
102101
mode: Manual
103102
----
104103
+
105-
The MCO examines the boot image reported in the `rhcosVersion` or `ocpVersion` parameters to determine if the cluster is violating the boot image version skew limits.
104+
The MCO examines the boot image reported in the `rhcosVersion` or `ocpVersion` parameter to determine if the cluster is violating the boot image version skew limits.
106105

107106
None::
108-
In None mode, boot image management is disabled. When disabled, the MCO does not monitor for boot image skew and does not report if new nodes are provisioned with older boot images that could introduce compatibility issues. This can affect the cluster's ability to scale.
107+
When set to `None`, boot image skew enforcement is disabled. When disabled, the MCO does not monitor for boot image skew and does not report if new nodes are provisioned with older boot images that could introduce compatibility issues.
109108
+
110109
.Example `MachineConfiguration` object with skew enforcement disabled
111110
[source,yaml]

modules/mco-update-boot-skew-mgmt-configuring.adoc

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
// * machine-configuration/mco-update-boot-skew-mgmt.adoc
44

55
:_mod-docs-content-type: PROCEDURE
6-
[id="mco-update-boot-skew-mgmt-configuring.adoc_{context}"]
6+
[id="mco-update-boot-skew-mgmt-configuring_{context}"]
77
= Configuring boot image skew enforcement
88

99
[role="_abstract"]
10-
You can configure the current boot image skew enforcement mode that the Machine Config Operator (MCO) uses. By configuring the boot image skew enforcement level, you specify the current boot image version used in the cluster, which the MCO uses to determine boot image skew compliance in your cluster.
10+
You can configure the current boot image skew enforcement mode that the Machine Config Operator (MCO) uses. By configuring the boot image skew enforcement mode, you can determine if the boot image boot image version in the `MachineConfiguration` object is updated automatically or manaully.
1111

12-
Alternatively, you can disable boot image skew enforcement by setting the `mode` to `None`. When disabled, the MCO does not monitor for boot image skew and older boot images could be used, possibly introducing compatibility issues on new nodes.
12+
Alternatively, you can disable boot image skew enforcement by setting the `mode` to `None`. When disabled, the MCO does not monitor for boot image skew, and older boot images could be used, possibly introducing compatibility issues on new nodes.
1313

14-
In {product-title} 4.22, the automatic mode is available only for {aws-short}, {gcp-short}, {azure-short}, and {vmw-short} clusters and is the default for these platforms. All other platforms default to manual mode. If you modify a cluster from automatic mode to manual or none, you can revert a cluster to automatic mode only by removing the `bootImageSkewEnforcement` stanza from the `MachineConfiguration` object.
14+
In {product-title} 4.22, the automatic mode is available only for {aws-short}, {gcp-short}, {azure-short}, and {vmw-short} clusters and is the default for these platforms. All other platforms default to manual mode. If you modify a cluster from automatic to manual or none, you can revert a cluster to automatic mode only by removing the `bootImageSkewEnforcement` stanza from the `MachineConfiguration` object.
1515

1616
.Prerequisites
1717

@@ -53,22 +53,21 @@ spec:
5353
mode: Manual
5454
manual:
5555
mode: RHCOSVersion
56-
rhcosVersion: 9.0.20251023-0
56+
rhcosVersion: 9.6.20251023-0
5757
# ...
5858
----
5959
where:
6060

61-
`spec.bootImageSkewEnforcement.mode`:: Specifies the boot image management mode, one of the following values:
61+
`spec.bootImageSkewEnforcement.mode`:: Specifies the boot image enforcement mode, one of the following values:
6262
+
6363
--
64-
* `Manual`. The cluster admin is responsible to manually configure the boot image version based on the `ocpVersion` or `rhcosVersion` parameter. You must specify the `spec.bootImageSkewEnforcement.manual` parameters.
65-
* `None`. Boot image management is disabled. You do not need to specify the `spec.bootImageSkewEnforcement.manual` parameters.
64+
* `Manual`. Specifies that boot image skew management is in manual mode. You must specify the `spec.bootImageSkewEnforcement.manual` parameters.
65+
* `None`. Specifies that boot image skew management is disabled. You do not need to specify the `spec.bootImageSkewEnforcement.manual` parameters.
6666
--
67-
+
68-
`spec.bootImageSkewEnforcement.manual`:: For the `Manual` mode, specifies that the minimum boot image is based on the specific {product-title} or {op-system} version. This example configures an {op-system} version. You must include the following parameters:
67+
68+
`spec.bootImageSkewEnforcement.manual.mode`:: Specifies the version you want to represent the current boot image, either `OCPVersion` or `RHCOSVersion`. You must include the following parameters:
6969
+
7070
--
71-
* `spec.bootImageSkewEnforcement.manual.mode`. Specifies the version you want to represent the current boot image, either `OCPVersion` or `RHCOSVersion`. You must include one of the following parameters:
7271
** For `RHCOSVersion`, use `spec.bootImageSkewEnforcement.manual.rhcosVersion` to specify the {op-system} version that is being used as a boot image in the `[major].[minor].[datestamp(YYYYMMDD)]-[buildnumber]` or `[major].[minor].[timestamp(YYYYMMDDHHmm)]-[buildnumber]` format. This field must be between 14 and 21 characters long.
73-
** For `OCPVersion`, use `spec.bootImageSkewEnforcement.manual.ocpVersion` to specify the {product-title} version associated with the boot image that is being used in the `x.y.z` format. This field must be between 5 and 10 characters long.
72+
** For `OCPVersion`, use `spec.bootImageSkewEnforcement.manual.ocpVersion` to specify the {product-title} version associated with the boot image that is being used in the `x.y.z` format. This field must be between 5 and 10 characters long.
7473
--

modules/mco-update-boot-skew-mgmt-updating.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
= Updating the boot image skew enforcement version
99

1010
[role="_abstract"]
11-
If you a running boot image skew enforcement in the manual mode, you must manually update the boot image version in the `MachineConfiguration` object each time you update the boot image. With the boot image updated in the `MachineConfiguration` object, the Machine Config Operator (MCO) can properly perform boot image skew enforcement to keep your node up-to-date.
11+
If you running boot image skew enforcement in the manual mode, you must manually update the boot image version in the `MachineConfiguration` object each time you update the boot image in your cluster. With the boot image updated in the `MachineConfiguration` object, the Machine Config Operator (MCO) can properly perform boot image skew enforcement to ensure that your nodes are up-to-date.
1212

1313
.Prerequisites
1414

@@ -76,7 +76,7 @@ spec:
7676
mode: Manual
7777
manual:
7878
mode: OCPVersion
79-
ocpVersion: 4.22.1
79+
ocpVersion: 4.22.0
8080
# ...
8181
status:
8282
bootImageSkewEnforcementStatus:

0 commit comments

Comments
 (0)