Skip to content

Commit 7f527a5

Browse files
dfitzmaudfitzmau
authored
Merge pull request #97038 from mburke5678/mco-boot-image-aws-example
OSDOCS 15615 Clarity on bootimage changes on AWS and GCP
2 parents abfe92d + 7faca38 commit 7f527a5

File tree

4 files changed

+65
-74
lines changed

4 files changed

+65
-74
lines changed

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

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,14 @@ How the cluster behaves after disabling or re-enabling the feature, depends upon
4444
Because a boot image is used only when a node is scaled up, this feature has no effect on existing nodes.
4545
====
4646

47-
To view the current boot image used in your cluster, examine a machine set:
47+
To view the current boot image used in your cluster, examine a machine set.
4848

49-
.Example machine set with the boot image reference
49+
[NOTE]
50+
====
51+
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.
52+
====
53+
54+
.Example {gcp-short} machine set with the boot image reference
5055

5156
[source,yaml]
5257
----
@@ -72,6 +77,28 @@ spec:
7277
----
7378
<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.
7479

80+
.Example {aws-short} machine set with the boot image reference
81+
82+
[source,yaml]
83+
----
84+
apiVersion: machine.openshift.io/v1beta1
85+
kind: MachineSet
86+
metadata:
87+
name: ci-ln-hmy310k-72292-5f87z-worker-a
88+
namespace: openshift-machine-api
89+
spec:
90+
# ...
91+
template:
92+
# ...
93+
spec:
94+
# ...
95+
providerSpec:
96+
value:
97+
ami:
98+
id: ami-0e8fd9094e487d1ff
99+
# ...
100+
----
101+
75102
// The following admonition is intended to address https://issues.redhat.com/browse//OSDOCS-14592
76103
[IMPORTANT]
77104
====

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

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -84,39 +84,3 @@ $ oc label machineset.machine ci-ln-hmy310k-72292-5f87z-worker-a region: "east"
8484
.Verification
8585
8686
include::snippets/mco-update-boot-images-verification.adoc[]
87-
88-
* Get the boot image version by running the following command:
89-
+
90-
[source,terminal]
91-
----
92-
$ oc get machinesets <machineset_name> -n openshift-machine-api -o yaml
93-
----
94-
+
95-
.Example machine set with the boot image reference
96-
+
97-
[source,yaml]
98-
----
99-
apiVersion: machine.openshift.io/v1beta1
100-
kind: MachineSet
101-
metadata:
102-
labels:
103-
machine.openshift.io/cluster-api-cluster: ci-ln-77hmkpt-72292-d4pxp
104-
update-boot-image: "true"
105-
name: ci-ln-77hmkpt-72292-d4pxp-worker-a
106-
namespace: openshift-machine-api
107-
spec:
108-
# ...
109-
template:
110-
# ...
111-
spec:
112-
# ...
113-
providerSpec:
114-
# ...
115-
value:
116-
disks:
117-
- autoDelete: true
118-
boot: true
119-
image: projects/rhcos-cloud/global/images/<boot_image> <1>
120-
# ...
121-
----
122-
<1> This boot image is the same as the current {product-title} version.

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

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -84,39 +84,3 @@ spec:
8484
.Verification
8585

8686
include::snippets/mco-update-boot-images-verification.adoc[]
87-
88-
* Get the boot image version by running the following command:
89-
+
90-
[source,terminal]
91-
----
92-
$ oc get machinesets <machineset_name> -n openshift-machine-api -o yaml
93-
----
94-
+
95-
.Example machine set with the boot image reference
96-
+
97-
[source,yaml]
98-
----
99-
apiVersion: machine.openshift.io/v1beta1
100-
kind: MachineSet
101-
metadata:
102-
labels:
103-
machine.openshift.io/cluster-api-cluster: ci-ln-77hmkpt-72292-d4pxp
104-
update-boot-image: "true"
105-
name: ci-ln-77hmkpt-72292-d4pxp-worker-a
106-
namespace: openshift-machine-api
107-
spec:
108-
# ...
109-
template:
110-
# ...
111-
spec:
112-
# ...
113-
providerSpec:
114-
# ...
115-
value:
116-
disks:
117-
- autoDelete: true
118-
boot: true
119-
image: projects/rhcos-cloud/global/images/rhcos-9-6-20250402-0-gcp-x86-64 <1>
120-
# ...
121-
----
122-
<1> This boot image is the same as the current {product-title} version.

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,39 @@ status:
4040
selection:
4141
mode: All
4242
----
43+
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.
45+
+
46+
[source,terminal]
47+
----
48+
$ oc get machinesets <machineset_name> -n openshift-machine-api -o yaml
49+
----
50+
+
51+
.Example machine set with the boot image reference
52+
+
53+
[source,yaml]
54+
----
55+
apiVersion: machine.openshift.io/v1beta1
56+
kind: MachineSet
57+
metadata:
58+
labels:
59+
machine.openshift.io/cluster-api-cluster: ci-ln-77hmkpt-72292-d4pxp
60+
update-boot-image: "true"
61+
name: ci-ln-77hmkpt-72292-d4pxp-worker-a
62+
namespace: openshift-machine-api
63+
spec:
64+
# ...
65+
template:
66+
# ...
67+
spec:
68+
# ...
69+
providerSpec:
70+
# ...
71+
value:
72+
disks:
73+
- autoDelete: true
74+
boot: true
75+
image: projects/rhcos-cloud/global/images/<boot_image> <1>
76+
# ...
77+
----
78+
<1> This boot image is the same as the current {product-title} version.

0 commit comments

Comments
 (0)