Skip to content

Commit e50bee8

Browse files
authored
Merge pull request #102966 from mburke5678/mco-updated-bootimage-421
OCDOCS 15797 OCPSTRAT-2182 Updated boot images: Phase 5 (vsphere, Azure GA)/boot images for ControlPlaneMachineSets
2 parents 49a65a3 + a786004 commit e50bee8

8 files changed

+286
-271
lines changed

machine_configuration/mco-update-boot-images.adoc

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,20 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9+
include::snippets/mco-update-boot-images-abstract.adoc[]
10+
911
include::snippets/mco-update-boot-images-intro.adoc[]
1012

11-
:FeatureName: Boot image management on {vmw-short}
13+
:FeatureName: Boot image management for control plane nodes
1214
include::snippets/technology-preview.adoc[]
1315

14-
[role="_additional-resources"]
15-
.Additional resources
16-
* xref:../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling-features[Enabling features using feature gates]
17-
1816
include::modules/mco-update-boot-images-about.adoc[leveloffset=+1]
1917

2018
[role="_additional-resources"]
2119
.Additional resources
2220
* xref:../machine_configuration/mco-update-boot-images.adoc#mco-update-boot-images-disable_machine-configs-configure[Disabling boot image management]
2321
* xref:../machine_configuration/mco-update-boot-images.adoc#mco-update-boot-images-configuring_machine-configs-configure[Enabling boot image management]
2422
25-
include::modules/mco-update-boot-images-disable.adoc[leveloffset=+1]
26-
2723
include::modules/mco-update-boot-images-configuring.adoc[leveloffset=+1]
24+
25+
include::modules/mco-update-boot-images-disable.adoc[leveloffset=+1]

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

Lines changed: 19 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,29 @@
33
// * nodes/nodes/nodes-update-boot-images.adoc
44
// * machine_configuration/mco-update-boot-images.adoc
55

6-
:_mod-docs-content-type: PROCEDURE
6+
:_mod-docs-content-type: CONCEPT
77
[id="mco-update-boot-images_{context}"]
88
= About 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+
[role="_abstract"]
11+
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.
1112

12-
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".
13+
New nodes created after enabling the feature use the updated boot image. This feature has no effect on existing nodes.
1314

14-
:FeatureName: Boot image management on {vmw-short}
15-
include::snippets/technology-preview.adoc[]
15+
[NOTE]
16+
====
17+
include::snippets/mco-update-boot-images-intro.adoc[]
18+
====
1619

17-
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.
20+
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.
1821

19-
However, using an older boot image could cause the following issues:
22+
Using an older boot image could cause the following issues:
2023

2124
* Extra time to start nodes
2225
* Certificate expiration issues
2326
* Version skew issues
2427
25-
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".
26-
27-
[NOTE]
28-
====
29-
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}.
30-
====
28+
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".
3129

3230
How the cluster behaves after disabling or re-enabling the feature, depends upon when you made the change, including the following scenarios:
3331

@@ -49,78 +47,20 @@ How the cluster behaves after disabling or re-enabling the feature, depends upon
4947
Because a boot image is used only when a node is scaled up, this feature has no effect on existing nodes.
5048
====
5149

52-
To view the current boot image used in your cluster, use one of the following methods, based on your platform:
53-
54-
* For {gcp-short} and {aws-short}, you can examine a machine set.
55-
+
56-
[NOTE]
57-
====
58-
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.
59-
====
60-
+
61-
.Example {gcp-short} machine set with the boot image reference
50+
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.
6251

52+
.Example coreos-aleph-version.json file with an older boot image
6353
[source,yaml]
6454
----
65-
apiVersion: machine.openshift.io/v1beta1
66-
kind: MachineSet
67-
metadata:
68-
name: ci-ln-hmy310k-72292-5f87z-worker-a
69-
namespace: openshift-machine-api
70-
spec:
71-
# ...
72-
template:
73-
# ...
74-
spec:
75-
# ...
76-
providerSpec:
77-
# ...
78-
value:
79-
disks:
80-
- autoDelete: true
81-
boot: true
82-
image: projects/rhcos-cloud/global/images/rhcos-412-85-202203181601-0-gcp-x86-64 <1>
55+
{
8356
# ...
57+
"ref": "docker://ostree-image-signed:oci-archive:/rhcos-418.94.202511191518-0-ostree.x86_64.ociarchive",
58+
"version": "418.94.202511191518-0"
59+
}
8460
----
85-
<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.
86-
+
87-
.Example {aws-short} machine set with the boot image reference
61+
where:
8862

89-
[source,yaml]
90-
----
91-
apiVersion: machine.openshift.io/v1beta1
92-
kind: MachineSet
93-
metadata:
94-
name: ci-ln-hmy310k-72292-5f87z-worker-a
95-
namespace: openshift-machine-api
96-
spec:
97-
# ...
98-
template:
99-
# ...
100-
spec:
101-
# ...
102-
providerSpec:
103-
value:
104-
ami:
105-
id: ami-0e8fd9094e487d1ff
106-
# ...
107-
----
108-
109-
* For {vmw-first}, examine an affected node by opening an `oc debug` session to the node and using the `rpm-ostree status` command.
110-
+
111-
[source,terminal]
112-
----
113-
sh-5.1# rpm-ostree status
114-
----
115-
+
116-
.Example {aws-short} node with the boot image reference
117-
+
118-
----
119-
State: idle
120-
Deployments:
121-
* ostree-unverified-registry:quay.io/my-registry/...
122-
Digest: sha256:...
123-
----
63+
`<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.
12464

12565
// The following admonition is intended to address https://issues.redhat.com/browse//OSDOCS-14592
12666
[IMPORTANT]

0 commit comments

Comments
 (0)