Skip to content

Commit 78d3ca8

Browse files
mburke5678mburke5678
authored
Merge pull request #102021 from mburke5678/mco-mcn-for-ocl
OSDOCS 17238 Update MCO to reflect API changes made for Status Reporting
2 parents 243057a + 940f503 commit 78d3ca8

File tree

6 files changed

+107
-0
lines changed

6 files changed

+107
-0
lines changed

‎machine_configuration/index.adoc‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,12 @@ include::modules/checking-mco-status.adoc[leveloffset=+1]
4747

4848
include::modules/checking-mco-node-status.adoc[leveloffset=+1]
4949

50+
[role="_additional-resources"]
51+
.Additional resources
52+
53+
* xref:../machine_configuration/mco-coreos-layering.adoc#coreos-layering-configuring-on_mco-coreos-layering[About on-cluster image mode]
54+
* xref:../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[Enabling features using feature gates]
55+
5056
include::modules/checking-mco-node-status-configuring.adoc[leveloffset=+2]
5157

5258
[id="machine-config-operator-certificates_{context}"]

‎machine_configuration/mco-coreos-layering.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,12 +186,14 @@ include::modules/coreos-layering-configuring-on.adoc[leveloffset=+1]
186186
* xref:../machine_configuration/mco-coreos-layering.adoc#coreos-layering-configuring-on-rebuild_mco-coreos-layering[Rebuilding an on-cluster custom layered image]
187187
* xref:../machine_configuration/mco-coreos-layering.adoc#coreos-layering-configuring-on-revert_mco-coreos-layering[Reverting an on-cluster custom layered image]
188188
* xref:../machine_configuration/mco-coreos-layering.adoc#coreos-layering-configuring-on-modifying_mco-coreos-layering[Modifying a custom layered image]
189+
* xref:../machine_configuration/index.adoc#checking-mco-node-status_machine-config-overview[About checking machine config node status]
189190

190191
include::modules/coreos-layering-configuring-on-proc.adoc[leveloffset=+2]
191192

192193
.Additional resources
193194
* xref:../openshift_images/managing_images/using-image-pull-secrets.adoc#images-update-global-pull-secret_using-image-pull-secrets[Updating the global cluster pull secret]
194195
* xref:../machine_configuration/mco-coreos-layering.adoc#coreos-layering-configuring-on-revert_mco-coreos-layering[Reverting an on-cluster custom layered image]
196+
* xref:../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[Enabling features using feature gates]
195197

196198
include::modules/coreos-layering-configuring-on-modifying.adoc[leveloffset=+2]
197199

‎modules/checking-mco-node-status-configuring.adoc‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,20 @@ During the update of a machine config pool (MCP), you can monitor the progress o
1111

1212
For more information on the meaning of these fields, see "About checking machine config node status."
1313

14+
.Prerequisites
15+
16+
* In order to see specific machine config node output, as described in "About checking machine config node status", you must enable the `TechPreviewNoUpgrade` feature set on the cluster. For more information, see "Enabling features using feature gates".
17+
+
18+
[NOTE]
19+
====
20+
Enabling the `TechPreviewNoUpgrade` feature set cannot be undone and prevents minor version updates. These feature sets are not recommended on production clusters.
21+
====
22+
+
23+
--
24+
:FeatureName: The custom layered image output
25+
include::snippets/technology-preview.adoc[]
26+
--
27+
1428
.Procedure
1529

1630
* View the update status of all nodes in the cluster, including the current and desired machine configurations, by running the following command:

‎modules/checking-mco-node-status.adoc‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,19 @@ The node update process consists of the following phases and subphases that are
2727
** *Uncordoned*
2828
* *Updated* The MCO completed a node update and the current config version of the node is equal to the desired updated version.
2929
* *Resumed*. The MCO restarted the config drift monitor process and the node returns to operational state.
30+
* *ImagePulledFromRegistry*. The MCO has pulled the desired custom layered image. This condition applies only to nodes on which {image-mode-os-on-lower} has been configured.
31+
+
32+
In order to see *ImagePulledFromRegistry* in the output, you must enable the `TechPreviewNoUpgrade` feature set on the cluster. For more information, see "Enabling features using feature gates".
33+
+
34+
[NOTE]
35+
====
36+
Enabling the `TechPreviewNoUpgrade` feature set cannot be undone and prevents minor version updates. These feature sets are not recommended on production clusters.
37+
====
38+
+
39+
--
40+
:FeatureName: The `ImagePulledFromRegistry` condition
41+
include::snippets/technology-preview.adoc[]
42+
--
3043
3144
As the update moves through these phases, you can query the `MachineConfigNode` custom resource, which reports one of the following conditions for each phase:
3245

@@ -141,6 +154,7 @@ $ oc describe machineconfignode/<machine_config_node_name>
141154

142155
.Example output
143156
[source,text]
157+
----
144158
apiVersion: machineconfiguration.openshift.io/v1
145159
kind: MachineConfigNode
146160
metadata:
@@ -238,3 +252,17 @@ status:
238252
<1> The `MachineConfigNode` object name.
239253
<2> The new machine configuration. This field updates after the MCO validates the machine config in the `UPDATEPREPARED` phase, then the status adds the new configuration.
240254
<3> The current machine config on the node.
255+
256+
For clusters configured with {image-mode-os-on-lower}, the machine config node output also includes the name of the custom layered image that was applied to affected nodes.
257+
258+
include::snippets/mco-mcn-ocl-example.adoc[]
259+
260+
In order to see the custom layered image in the output, you must enable the `TechPreviewNoUpgrade` feature set on the cluster. For more information, see "Enabling features using feature gates".
261+
262+
[NOTE]
263+
====
264+
Enabling the `TechPreviewNoUpgrade` feature set cannot be undone and prevents minor version updates. These feature sets are not recommended on production clusters.
265+
====
266+
267+
:FeatureName: The custom layered image output
268+
include::snippets/technology-preview.adoc[]

‎modules/coreos-layering-configuring-on-proc.adoc‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,24 @@ NAME PREPARED BUILDING SUCCEEDED
177177
layered-image-ad5a3cad36303c363cf458ab0524e7c0 False True False False False 12m <1>
178178
----
179179
<1> The `MachineOSBuild` is named in the `<MachineOSConfig_CR_name>-<hash>` format.
180+
+
181+
The build is complete when `BUILDING` is `False` and `SUCCEEDED` is `True`.
182+
183+
. When the build is complete, verify that the image has been applied to the nodes in the affected pool by running a command similar to the following:
184+
+
185+
[source,terminal]
186+
----
187+
$ oc describe machineconfignode/<machine_config_node_name>
188+
----
189+
+
190+
--
191+
include::snippets/mco-mcn-ocl-example.adoc[]
192+
--
193+
+
194+
--
195+
:FeatureName: The `ImagePulledFromRegistry` condition
196+
include::snippets/technology-preview.adoc[]
197+
--
180198

181199
. Verify that the `MachineOSConfig` object contains a reference to the new custom layered image by running the following command:
182200
+

‎snippets/mco-mcn-ocl-example.adoc‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
// Text snippet included in the following modules:
2+
//
3+
// * modules/coreos-layering-configuring-on
4+
// * modules/checking-mco-node-status
5+
6+
:_mod-docs-content-type: SNIPPET
7+
8+
.Example machine config node output
9+
[source,terminal]
10+
----
11+
Name: ip-10-0-14-86.us-west-1.compute.internal
12+
API Version: machineconfiguration.openshift.io/v1
13+
Kind: MachineConfigNode
14+
# ...
15+
Spec:
16+
Config Image:
17+
Desired Image: image-registry.openshift-image-registry.svc:5000/openshift-machine-config-operator/ocb-image@sha256:b485378fd8f7963ed74f14ce64f4f1e511e1601d49302b3046b1b78a83f539e3 <1>
18+
Config Version:
19+
Desired: rendered-worker-d63c7736923b60b8b82492ae9a1eef40
20+
Node:
21+
Name: ip-10-0-14-86.us-west-1.compute.internal
22+
Pool:
23+
Name: worker
24+
# ...
25+
Status:
26+
Conditions:
27+
# ...
28+
Message: Action during update to image-registry.openshift-image-registry.svc:5000/openshift-machine-config-operator/ocb-image@sha256:b485378fd8f7963ed74f14ce64f4f1e511e1601d49302b3046b1b78a83f539e3: Successfully pulled OS image image-registry.openshift-image-registry.svc:5000/openshift-machine-config-operator/ocb-image@sha256:b485378fd8f7963ed74f14ce64f4f1e511e1601d49302b3046b1b78a83f539e3 from registry
29+
Reason: ImagePulledFromRegistry
30+
Status: False
31+
Type: ImagePulledFromRegistry
32+
# ...
33+
Config Image:
34+
Current Image: image-registry.openshift-image-registry.svc:5000/openshift-machine-config-operator/ocb-image@sha256:b485378fd8f7963ed74f14ce64f4f1e511e1601d49302b3046b1b78a83f539e3
35+
Desired Image: image-registry.openshift-image-registry.svc:5000/openshift-machine-config-operator/ocb-image@sha256:b485378fd8f7963ed74f14ce64f4f1e511e1601d49302b3046b1b78a83f539e3
36+
# ...
37+
----
38+
<1> Digested image pull spec for the new custom layered image.
39+

0 commit comments

Comments
 (0)