Skip to content

[enterprise-4.20] OSDOCS15909: On Cluster Layering: Make it easier to see errors #99146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 16, 2025
Merged

[enterprise-4.20] OSDOCS15909: On Cluster Layering: Make it easier to see errors #99146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion modules/coreos-layering-configuring-on-proc.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,37 @@ machine-os-builder-6fb66cfb99-zcpvq 1/1
<1> This is the build pod where the custom layered image is building, named in the `build-<MachineOSConfig_CR_name>-<hash>` format.
<2> This pod can be used for troubleshooting.

. Verify the custom layered image build by running a command similar to the following:
+
[source,terminal]
----
$ oc get machineconfigpool <mcp_name> -o yaml
----
+
.Example output
[source,terminal]
----
apiVersion: machineconfiguration.openshift.io/v1
kind: MachineConfigPool
metadata:
labels:
machineconfiguration.openshift.io/mco-built-in: ""
pools.operator.machineconfiguration.openshift.io/layered: ""
name: layered
# ...
status:
# ...
conditions
# ...
- lastTransitionTime: "2025-09-09T13:43:35Z"
message: 'Failed to build OS image for pool worker (MachineOSBuild: worker-2d03dc921ff0c242c5892a3ef1ed1608):
Failed: Build Failed'
reason: BuildFailed
status: "True" <1>
type: ImageBuildDegraded
----
<1> Indicates whether the custom layered image build failed. If `False`, the build succeeded. If `True`, the build failed. You can use the build pod logs to troubleshoot any build failures.

. Verify the current stage of your layered build by running the following command:
+
[source,terminal]
Expand All @@ -143,7 +174,7 @@ $ oc get machineosbuilds
[source,terminal]
----
NAME PREPARED BUILDING SUCCEEDED INTERRUPTED FAILED AGE
layered-image-ad5a3cad36303c363cf458ab0524e7c0 False True False False False 12m <1>
layered-image-ad5a3cad36303c363cf458ab0524e7c0 False True False False False 12m <1>
----
<1> The `MachineOSBuild` is named in the `<MachineOSConfig_CR_name>-<hash>` format.

Expand Down
2 changes: 1 addition & 1 deletion modules/coreos-layering-configuring-on.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ For {sno} clusters, you can apply a custom layered image to the control plane no

include::snippets//coreos-layering-configuring-on-pause.adoc[]

In the case of a build failure, for example due to network issues or an invalid secret, the MCO retries the build three additional times before the job fails. The MCO creates a different build pod for each build attempt. You can use the build pod logs to troubleshoot any build failures. Note that the MCO automatically removes these build pods after a short period of time.
In the case of a build failure, for example due to network issues or an invalid secret, the MCO retries the build three additional times before the job fails. The MCO creates a different build pod for each build attempt. Note that the MCO automatically removes these build pods after a short period of time. Also, the affected machine config pool reports a build failure through the `ImageBuildDegraded` status condition. You can use the build pod logs to troubleshoot any build failures.

.Example failed `MachineOSBuild` object
[source,terminal]
Expand Down