Skip to content

Commit 20677a1

Browse files
authored
Merge pull request #89003 from mburke5678/mco-ocl-mcp-wording-marrusl
MCO OCL remove wording around layered MCP
2 parents e789972 + 44faa6e commit 20677a1

5 files changed

+17
-16
lines changed

modules/coreos-layering-configuring-on-extensions.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ apiVersion: machineconfiguration.openshift.io/v1 <1>
3131
kind: MachineConfig
3232
metadata:
3333
labels:
34-
machineconfiguration.openshift.io/role: layered <2>
34+
machineconfiguration.openshift.io/role: worker <2>
3535
name: 80-worker-extensions
3636
spec:
3737
config:
@@ -80,9 +80,8 @@ $ oc get machineconfigpools
8080
[source,terminal]
8181
----
8282
NAME CONFIG UPDATED UPDATING DEGRADED MACHINECOUNT READYMACHINECOUNT UPDATEDMACHINECOUNT DEGRADEDMACHINECOUNT AGE
83-
layered rendered-layered-221507009cbcdec0eec8ab3ccd789d18 False True False 1 0 0 0 167m <1>
8483
master rendered-master-a0b404d061a6183cc36d302363422aba True False False 3 3 3 0 3h38m
85-
worker rendered-worker-221507009cbcdec0eec8ab3ccd789d18 True False False 2 2 2 0 3h38m
84+
worker rendered-worker-221507009cbcdec0eec8ab3ccd789d18 False True False 2 2 2 0 3h38m <1>
8685
----
8786
<1> The value `FALSE` in the `UPDATED` column indicates that the `MachineOSBuild` object is building. When the `UPDATED` column reports `FALSE`, the new custom layered image has rolled out to the nodes.
8887

modules/coreos-layering-configuring-on-modifying.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ include::snippets//coreos-layering-configuring-on-pause.adoc[]
2727
apiVersion: machineconfiguration.openshift.io/v1alpha1
2828
kind: MachineOSConfig
2929
metadata:
30-
name: layered-alpha1
30+
name: layered
3131
spec:
3232
machineConfigPool:
33-
name: layered
33+
name: worker
3434
buildInputs:
3535
containerFile:
3636
- containerfileArch: noarch
@@ -92,9 +92,8 @@ $ oc get machineconfigpools
9292
[source,terminal]
9393
----
9494
NAME CONFIG UPDATED UPDATING DEGRADED MACHINECOUNT READYMACHINECOUNT UPDATEDMACHINECOUNT DEGRADEDMACHINECOUNT AGE
95-
layered rendered-layered-221507009cbcdec0eec8ab3ccd789d18 False True False 1 0 0 0 167m <1>
9695
master rendered-master-a0b404d061a6183cc36d302363422aba True False False 3 3 3 0 3h38m
97-
worker rendered-worker-221507009cbcdec0eec8ab3ccd789d18 True False False 2 2 2 0 3h38m
96+
worker rendered-worker-221507009cbcdec0eec8ab3ccd789d18 False True False 2 2 2 0 3h38m <1>
9897
----
9998
<1> The value `FALSE` in the `UPDATED` column indicates that the `MachineOSBuild` object is building. When the `UPDATED` column reports `FALSE`, the new custom layered image has rolled out to the nodes.
10099

modules/coreos-layering-configuring-on-revert.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ $ oc get mcp
4545
[source,terminal]
4646
----
4747
NAME CONFIG UPDATED UPDATING DEGRADED MACHINECOUNT READYMACHINECOUNT UPDATEDMACHINECOUNT DEGRADEDMACHINECOUNT AGE
48-
layered rendered-layered-bde4e4206442c0a48b1a1fb35ba56e85 True False False 0 0 0 0 4h46m
4948
master rendered-master-8332482204e0b76002f15ecad15b6c2d True False False 3 3 3 0 5h26m
5049
worker rendered-worker-bde4e4206442c0a48b1a1fb35ba56e85 False True False 3 2 2 0 5h26m <1>
5150
----

modules/coreos-layering-configuring-on.adoc

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,12 @@ NAME READY STATUS RESTARTS
2929
build-layered-c8765e26ebc87e1e17a7d6e0a78e8bae 2/2 Running 0 11m
3030
----
3131

32-
When the build is complete, the MCO pushes the new custom layered image to your repository for use when deploying new nodes. You can see the digested image pull spec for the new custom layered image in the `MachineOSBuild` object and `machine-os-builder` pod.
32+
When the build is complete, the MCO pushes the new custom layered image to your repository and rolled out to the nodes in the associated machine config pool. You can see the digested image pull spec for the new custom layered image in the `MachineOSBuild` object and `machine-os-builder` pod.
33+
34+
[TIP]
35+
====
36+
You can test a `MachineOSBuild` object to make sure it builds correctly without rolling out the custom layered image to active nodes by using a custom machine config pool that contains non-production nodes. Alternatively, you can use a custom machine config pool that has no nodes. The `MachineOSBuild` object builds even if there are no nodes for the MCO to deploy the custom layered image onto.
37+
====
3338

3439
You should not need to interact with these new objects or the `machine-os-builder` pod. However, you can use all of these resources for troubleshooting, if necessary.
3540

@@ -99,7 +104,7 @@ metadata:
99104
name: layered <2>
100105
spec:
101106
machineConfigPool:
102-
name: <mcp_name> <3>
107+
name: worker <3>
103108
buildInputs:
104109
containerFile: <4>
105110
- containerfileArch: noarch
@@ -120,7 +125,7 @@ spec:
120125
----
121126
<1> Specifies the `machineconfiguration.openshift.io/v1` API that is required for `MachineConfig` CRs.
122127
<2> Specifies a name for the `MachineOSConfig` object. This name is used with other on-cluster layering resources. The examples in this documentation use the name `layered`.
123-
<3> Specifies the name of the machine config pool associated with the nodes where you want to deploy the custom layered image.
128+
<3> Specifies the name of the machine config pool associated with the nodes where you want to deploy the custom layered image. The examples in this documentation use the `worker` machine config pool.
124129
<4> Specifies the Containerfile to configure the custom layered image.
125130
<5> Specifies the name of the image builder to use. This must be `PodImageBuilder`.
126131
<6> Specifies the name of the pull secret that the MCO needs in order to pull the base operating system image from the registry.
@@ -223,7 +228,7 @@ Spec:
223228
Desired Config:
224229
Name: rendered-layered-ad5a3cad36303c363cf458ab0524e7c0
225230
Machine OS Config:
226-
Name: layered-alpha1
231+
Name: layered
227232
Rendered Image Pushspec: image-registry.openshift-image-registry.svc:5000/openshift-machine-config-operator/os-images:layered-ad5a3cad36303c363cf458ab0524e7c0
228233
# ...
229234
Last Transition Time: 2025-02-12T19:21:28Z

snippets/coreos-layering-configuring-on-pause.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,17 @@
55

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

8-
Making certain changes to a `MachineOSConfig` object triggers an automatic rebuild of the associated custom layered image. You can mitigate the effects of the rebuild by pausing the machine config pool where the custom layered image is applied as described in "Pausing the machine config pools." For example, if you want to remove and replace a `MachineOSCOnfig` object, pausing the machine config pools before making the change prevents the MCO from reverting the associated nodes to the base image, reducing the number of reboots needed.
8+
Making certain changes to a `MachineOSConfig` object triggers an automatic rebuild of the associated custom layered image. You can mitigate the effects of the rebuild by pausing the machine config pool where the custom layered image is applied as described in "Pausing the machine config pools." For example, if you want to remove and replace a `MachineOSCOnfig` object, pausing the machine config pools before making the change prevents the MCO from reverting the associated nodes to the base image, reducing the number of reboots needed.
99

1010
When a machine config pool is paused, the `oc get machineconfigpools` reports the following status:
1111

1212
.Example output
1313
[source,terminal]
1414
----
1515
NAME CONFIG UPDATED UPDATING DEGRADED MACHINECOUNT READYMACHINECOUNT UPDATEDMACHINECOUNT DEGRADEDMACHINECOUNT AGE
16-
layered rendered-layered-221507009cbcdec0eec8ab3ccd789d18 False False False 1 0 0 0 3h23m <1>
1716
master rendered-master-a0b404d061a6183cc36d302363422aba True False False 3 3 3 0 4h14m
18-
worker rendered-worker-221507009cbcdec0eec8ab3ccd789d18 True False False 2 2 2 0 4h14m
17+
worker rendered-worker-221507009cbcdec0eec8ab3ccd789d18 False False False 2 2 2 0 4h14m <1>
1918
----
20-
<1> The `layered` machine config pool is paused, as indicated by the three `False` statuses and the `READYMACHINECOUNT` at `0`.
19+
<1> The `worker` machine config pool is paused, as indicated by the three `False` statuses and the `READYMACHINECOUNT` at `0`.
2120

2221
After the changes have been rolled out, you can unpause the machine config pool.

0 commit comments

Comments
 (0)