Skip to content

Commit 6475def

Browse files
authored
Merge pull request #97519 from mburke5678/mco-vsphere-boot-image-tp
OSDOCS 14716 Updated boot images: vSphere opt-in (tech preview)
2 parents bb28e76 + 31457b8 commit 6475def

File tree

7 files changed

+122
-10
lines changed

7 files changed

+122
-10
lines changed

machine_configuration/mco-update-boot-images.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,19 @@ toc::[]
88

99
include::snippets/mco-update-boot-images-intro.adoc[]
1010

11+
:FeatureName: Boot image management on {vmw-short}
12+
include::snippets/technology-preview.adoc[]
13+
14+
[role="_additional-resources"]
15+
.Additional resources
16+
* xref:../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[Enabling features using feature gates]
17+
1118
include::modules/mco-update-boot-images-about.adoc[leveloffset=+1]
19+
20+
[role="_additional-resources"]
21+
.Additional resources
22+
* xref:../machine_configuration/mco-update-boot-images.adoc#mco-update-boot-images-disable_machine-configs-configure[Disabling boot image management]
23+
* xref:../machine_configuration/mco-update-boot-images.adoc#mco-update-boot-images-configuring_machine-configs-configure[Enabling boot image management]
24+
1225
include::modules/mco-update-boot-images-disable.adoc[leveloffset=+1]
1326
include::modules/mco-update-boot-images-configuring.adoc[leveloffset=+1]

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

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,12 @@
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 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.
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+
14+
:FeatureName: Boot image management on {vmw-short}
15+
include::snippets/technology-preview.adoc[]
16+
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.
1318

1419
However, using an older boot image could cause the following issues:
1520

@@ -44,13 +49,15 @@ How the cluster behaves after disabling or re-enabling the feature, depends upon
4449
Because a boot image is used only when a node is scaled up, this feature has no effect on existing nodes.
4550
====
4651

47-
To view the current boot image used in your cluster, examine a machine set.
52+
To view the current boot image used in your cluster, use one of the following methods, based on your platform:
4853

54+
* For {gcp-short} and {aws-short}, you can examine a machine set.
55+
+
4956
[NOTE]
5057
====
5158
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.
5259
====
53-
60+
+
5461
.Example {gcp-short} machine set with the boot image reference
5562
5663
[source,yaml]
@@ -76,7 +83,7 @@ spec:
7683
# ...
7784
----
7885
<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.
79-
86+
+
8087
.Example {aws-short} machine set with the boot image reference
8188

8289
[source,yaml]
@@ -99,6 +106,22 @@ spec:
99106
# ...
100107
----
101108

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+
----
124+
102125
// The following admonition is intended to address https://issues.redhat.com/browse//OSDOCS-14592
103126
[IMPORTANT]
104127
====

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

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,43 @@
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 the boot image management feature, so that the boot images are not updated, you can re-enable the feature 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.
13+
14+
For {vmw-first}, you can enable boot image management as a Technology Preview feature.
15+
16+
:FeatureName: Boot image management on {vmw-short}
17+
include::snippets/technology-preview.adoc[]
1318

1419
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.
1520

21+
.Prerequisites
22+
23+
* For {vmw-short}, enable the `TechPreviewNoUpgrade` feature set on the cluster. For more information, see "Enabling features using feature gates".
24+
+
25+
[NOTE]
26+
====
27+
Enabling the `TechPreviewNoUpgrade` feature set cannot be undone and prevents minor version updates. These feature sets are not recommended on production clusters.
28+
====
29+
+
30+
Wait until the `managedBootImagesStatus` stanza displays in the `MachineConfiguration` object.
31+
+
32+
[source,yaml]
33+
----
34+
apiVersion: operator.openshift.io/v1
35+
kind: MachineConfiguration
36+
metadata:
37+
name: cluster
38+
# ...
39+
status:
40+
# ...
41+
managedBootImagesStatus:
42+
machineManagers:
43+
- apiGroup: machine.openshift.io
44+
resource: machinesets
45+
selection:
46+
mode: None
47+
----
48+
1649
.Procedure
1750

1851
. Edit the `MachineConfiguration` object, named `cluster`, to enable the boot image management feature for some or all of your machine sets:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
[id="mco-update-boot-images-disable_{context}"]
88
= Disabling boot image management
99

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.
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. For {vmw-first}, you can enable boot image management as a Technology Preview feature.
1111

1212
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 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".
16+
After disabling the feature, you can re-enable the feature at any time. For more information, see "Enabling updated boot images".
1717

1818
.Procedure
1919

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@ toc::[]
88

99
include::snippets/mco-update-boot-images-intro.adoc[]
1010

11+
:FeatureName: Boot image management on {vmw-short}
12+
include::snippets/technology-preview.adoc[]
13+
14+
[role="_additional-resources"]
15+
.Additional resources
16+
* xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[Enabling features using feature gates]
17+
1118
include::modules/mco-update-boot-images-about.adoc[leveloffset=+1]
1219

1320
[role="_additional-resources"]
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
// Text snippet included in the following assemblies:
22
//
33
// * machine_configuration/mco-update-boot-images.adoc
4-
// * nodes/nodes/nodes-update-boot-images-disable.adoc
4+
// * nodes/nodes/nodes-update-boot-images.adoc
55

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

88
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.
99

10+
For {vmw-first}, you can enable boot image management as a Technology Preview feature.
11+
1012
For all other platforms, the MCO does not update the boot image with each cluster update.

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

Lines changed: 36 additions & 2 deletions
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 management feature by viewing the machine configuration object:
8+
* 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:
99
+
1010
[source,terminal]
1111
----
@@ -41,7 +41,9 @@ status:
4141
mode: All
4242
----
4343
44-
* 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.
44+
* When the affected nodes return to the `READY` state, check the current boot image by using one of the following methods:
45+
46+
** 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.
4547
+
4648
[source,terminal]
4749
----
@@ -76,3 +78,35 @@ spec:
7678
# ...
7779
----
7880
<1> This boot image is the same as the current {product-title} version.
81+
82+
** For {vmw-first}, get the boot image version from an affected node:
83+
84+
.. Open an `oc debug` session to the node by running a command similar to the following:
85+
+
86+
[source,terminal]
87+
----
88+
$ oc debug node/<node_name>
89+
----
90+
91+
.. Set `/host` as the root directory within the debug shell by running the following command:
92+
+
93+
[source,terminal]
94+
----
95+
sh-5.1# chroot /host
96+
----
97+
98+
.. Run the `rpm-ostree status` command to view that the custom layered image is in use:
99+
+
100+
[source,terminal]
101+
----
102+
sh-5.1# rpm-ostree status
103+
----
104+
+
105+
.Example output
106+
+
107+
----
108+
State: idle
109+
Deployments:
110+
* ostree-unverified-registry:quay.io/my-registry/...
111+
Digest: sha256:...
112+
----

0 commit comments

Comments
 (0)