OSDOCS CQA MCO-1: MCO Core Configuration and Customization III by mburke5678 · Pull Request #113918 · openshift/openshift-docs

mburke5678 · 2026-06-23T14:52:29Z

https://redhat.atlassian.net/browse/OSDOCS-16921

Previews:
Machine Confguration -> Image mode for OpenShift

Assemblies:
mco-coreos-layering.adoc

openshift-ci-robot · 2026-06-23T14:52:34Z

@mburke5678: This pull request references MCO-1 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the epic to target either version "5.0." or "openshift-5.0.", but it targets "openshift-4.15" instead.

Details

In response to this:

https://redhat.atlassian.net/browse/OSDOCS-16921

Previews:

Assemblies:
mco-coreos-layering.adoc

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

ocpdocs-previewbot · 2026-06-23T15:01:29Z

🤖 Thu Jul 02 16:02:47 - Prow CI generated the docs preview:

https://113918--ocpdocs-pr.netlify.app/
https://113918--ocpdocs-pr.netlify.app/openshift-enterprise/latest/machine_configuration/mco-coreos-layering.html

lahinson

@mburke5678 Nice work! Just a few comments for your consideration. Feel free to merge when you are ready.

lahinson · 2026-07-01T15:26:09Z

 ====
 +
-Hotfixes are provided to you based on link:https://access.redhat.com/solutions/2996001[Red Hat Hotfix policy]. Apply it on top of the base image and test that new custom layered image in a non-production environment. When you are satisfied that the custom layered image is safe to use in production, you can roll it out on your own schedule to specific node pools. For any reason, you can easily roll back the custom layered image and return to using the default {op-system}.
+Hotfixes are provided to you based on Red Hat Hotfix policy. Apply it on top of the base image and test that new custom layered image in a non-production environment. When you are satisfied that the custom layered image is safe to use in production, you can roll it out on your own schedule to specific node pools. For any reason, you can easily roll back the custom layered image and return to using the default {op-system}.


Suggested change

Hotfixes are provided to you based on Red Hat Hotfix policy. Apply it on top of the base image and test that new custom layered image in a non-production environment. When you are satisfied that the custom layered image is safe to use in production, you can roll it out on your own schedule to specific node pools. For any reason, you can easily roll back the custom layered image and return to using the default {op-system}.

Hotfixes are provided to you based on Red{nbsp}Hat Hotfix policy. Apply it on top of the base image and test that new custom layered image in a non-production environment. When you are satisfied that the custom layered image is safe to use in production, you can roll it out on your own schedule to specific node pools. For any reason, you can easily roll back the custom layered image and return to using the default {op-system}.

SSG: https://redhat-documentation.github.io/supplementary-style-guide/#non-breaking-spaces

lahinson · 2026-07-01T15:26:26Z

 // https://issues.redhat.com/browse/OCPBUGS-42838

-* *{op-system-base} packages*. You can download {op-system-base-full} packages from the link:https://access.redhat.com/downloads/content/479/ver=/rhel---9/9.1/x86_64/packages[Red Hat Customer Portal], such as chrony, firewalld, and iputils.
+* *{op-system-base} packages*. You can download {op-system-base-full} packages from the Red Hat Customer Portal, such as chrony, firewalld, and iputils.


Suggested change

* *{op-system-base} packages*. You can download {op-system-base-full} packages from the Red Hat Customer Portal, such as chrony, firewalld, and iputils.

* *{op-system-base} packages*. You can download {op-system-base-full} packages from the Red{nbsp}Hat Customer Portal, such as chrony, firewalld, and iputils.

lahinson · 2026-07-01T15:29:22Z

-  containerFile: # <4>
-  - containerfileArch: NoArch <5>
+    name: layered-image
+  containerFile: #


Suggested change

containerFile: #

containerFile:

On this line and in a few other places in this example, I think you can remove the #.

lahinson · 2026-07-01T15:35:01Z

 ----
 $ oc describe machineconfignode/<machine_config_node_name>
 ----
 +


I'm seeing a callout in the preview. I think it's coming from the snippet on line 199.

lahinson · 2026-07-01T15:42:51Z

-<4> Optional: Update the secret needed to push the newly built custom layered image to the registry.
+
+where:
+


If you're formatting the user-replaced variable text as a definition list, the SSG says to introduce definition lists with "where:" and begin each variable description with "Specifies".

SSG: https://redhat-documentation.github.io/supplementary-style-guide/#explain-commands-variables-in-code-blocks

@lahinson This rule was recently changed to drop the requirement for Specifies.

lahinson · 2026-07-01T15:44:18Z


 If you modify and apply the `MachineOSConfig` object YAML or create a new YAML file, the YAML overwrites any changes you made directly to the `MachineOSConfig` object itself.

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


Check the snippet. I see a callout in the preview, and I'm guessing it's coming from there.

lahinson · 2026-07-01T15:46:10Z

+
+Add the `machineconfiguration.openshift.io/rebuild: ""` annotation to trigger a rebuild of the custom layered image.

 .Verification


Should the verification steps be in an ordered list? Just wondering if they should be completed in a specific order.

No. You can do them in any order or skip one of the two.

lahinson · 2026-07-01T15:47:02Z

-:_mod-docs-content-type: PROCEDURE
+:_mod-docs-content-type: CONCEPT
 [id="coreos-layering-configuring-on-remove_{context}"]
 = Removing an on-cluster custom layered image


Concept module titles should be noun phrases.

Suggested change

= Removing an on-cluster custom layered image

= Removal of an on-cluster custom layered image

lahinson · 2026-07-01T15:48:57Z

 ----
 sh-4.4# chroot /host
 ----



Suggested change

+

If you add this plus sign, I think it'll fix the formatting issues that are in the preview.

openshift-ci · 2026-07-02T16:12:17Z

@mburke5678: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

mburke5678 · 2026-07-02T16:21:40Z

/cherrypick enterprise-4.20

mburke5678 · 2026-07-02T16:21:44Z

/cherrypick enterprise-4.21

mburke5678 · 2026-07-02T16:21:47Z

/cherrypick enterprise-4.22

mburke5678 · 2026-07-02T16:21:52Z

/cherrypick enterprise-5.0

openshift-cherrypick-robot · 2026-07-02T16:22:27Z

@mburke5678: #113918 failed to apply on top of branch "enterprise-4.20":

Applying: MCO-1: MCO Core Configuration and Customization III
.git/rebase-apply/patch:25: trailing whitespace.
You can extend the functionality of your base {op-system} image by layering additional images onto the base image without modifying the base {op-system} image. 
.git/rebase-apply/patch:140: trailing whitespace.
You can modify an on-cluster custom layered image, as needed, to install additional packages, remove existing packages, change the pull or push repositories, update secrets, or other similar changes. 
.git/rebase-apply/patch:219: trailing whitespace.
You can use the on-cluster build process to apply a custom layered image to your cluster by creating a `MachineOSConfig` custom resource (CR). 
.git/rebase-apply/patch:221: trailing whitespace.
The `MachineOSConfig` CR specifies the following parameters: 
.git/rebase-apply/patch:273: trailing whitespace.
`metadata.name`:: Specifies a name for the `MachineOSConfig` object. The name must match the name of the associated machine config pool. This name is used with other {image-mode-os-on-lower} resources. The examples in this documentation use the name `layered-image`. 
warning: squelched 2 whitespace errors
warning: 7 lines add whitespace errors.
Using index info to reconstruct a base tree...
M	machine_configuration/mco-coreos-layering.adoc
M	modules/coreos-layering-configuring-on-proc.adoc
M	modules/coreos-layering-configuring-on-revert.adoc
M	modules/coreos-layering-configuring.adoc
M	modules/coreos-layering-removing.adoc
A	snippets/mco-mcn-ocl-example.adoc
Falling back to patching base and 3-way merge...
Auto-merging machine_configuration/mco-coreos-layering.adoc
CONFLICT (content): Merge conflict in machine_configuration/mco-coreos-layering.adoc
Auto-merging modules/coreos-layering-configuring-on-proc.adoc
CONFLICT (content): Merge conflict in modules/coreos-layering-configuring-on-proc.adoc
Auto-merging modules/coreos-layering-configuring-on-revert.adoc
Auto-merging modules/coreos-layering-configuring.adoc
Auto-merging modules/coreos-layering-removing.adoc
CONFLICT (modify/delete): snippets/mco-mcn-ocl-example.adoc deleted in HEAD and modified in MCO-1: MCO Core Configuration and Customization III.  Version MCO-1: MCO Core Configuration and Customization III of snippets/mco-mcn-ocl-example.adoc left in tree.
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config set advice.mergeConflict false"
Patch failed at 0001 MCO-1: MCO Core Configuration and Customization III

Details

In response to this:

/cherrypick enterprise-4.20

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-cherrypick-robot · 2026-07-02T16:22:38Z

@mburke5678: new pull request created: #114553

Details

In response to this:

/cherrypick enterprise-4.21

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-cherrypick-robot · 2026-07-02T16:22:41Z

@mburke5678: new pull request created: #114554

Details

In response to this:

/cherrypick enterprise-4.22

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-cherrypick-robot · 2026-07-02T16:22:46Z

@mburke5678: new pull request created: #114555

Details

In response to this:

/cherrypick enterprise-5.0

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

mburke5678 added this to the Continuous Release milestone Jun 23, 2026

mburke5678 added branch/enterprise-4.20 branch/enterprise-4.21 branch/enterprise-4.22 branch/enterprise-5.0 labels Jun 23, 2026

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jun 23, 2026

openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 23, 2026

mburke5678 changed the title ~~MCO-1: MCO Core Configuration and Customization III~~ OSDOCS MCO-1: MCO Core Configuration and Customization III Jun 23, 2026

mburke5678 force-pushed the cqa-mco-1-3 branch from 7a4465e to 20d9222 Compare June 23, 2026 20:22

mburke5678 added the merge-review-needed Signifies that the merge review team needs to review this PR label Jun 23, 2026

mburke5678 changed the title ~~OSDOCS MCO-1: MCO Core Configuration and Customization III~~ OSDOCS CQA MCO-1: MCO Core Configuration and Customization III Jun 26, 2026

lahinson added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Jul 1, 2026

lahinson reviewed Jul 1, 2026

View reviewed changes

lahinson added ok-to-merge and removed merge-review-in-progress Signifies that the merge review team is reviewing this PR labels Jul 1, 2026

mburke5678 force-pushed the cqa-mco-1-3 branch from 20d9222 to 817f214 Compare July 1, 2026 18:13

MCO-1: MCO Core Configuration and Customization III

ebfea00

mburke5678 force-pushed the cqa-mco-1-3 branch from 817f214 to ebfea00 Compare July 2, 2026 15:53

mburke5678 merged commit 81b43b6 into openshift:main Jul 2, 2026
2 checks passed

mburke5678 deleted the cqa-mco-1-3 branch July 2, 2026 16:18

openshift-cherrypick-robot mentioned this pull request Jul 2, 2026

[enterprise-4.21] OSDOCS CQA MCO-1: MCO Core Configuration and Customization III #114553

Merged

This was referenced Jul 2, 2026

[enterprise-4.22] OSDOCS CQA MCO-1: MCO Core Configuration and Customization III #114554

Merged

[enterprise-5.0] OSDOCS CQA MCO-1: MCO Core Configuration and Customization III #114555

Merged

mburke5678 mentioned this pull request Jul 2, 2026

[enterprise-4.20] OSDOCS CQA MCO-1: MCO Core Configuration and Customization III #114561

Merged

	* {op-system-base} packages. You can download {op-system-base-full} packages from the Red Hat Customer Portal, such as chrony, firewalld, and iputils.
	* {op-system-base} packages. You can download {op-system-base-full} packages from the Red{nbsp}Hat Customer Portal, such as chrony, firewalld, and iputils.


		If you modify and apply the `MachineOSConfig` object YAML or create a new YAML file, the YAML overwrites any changes you made directly to the `MachineOSConfig` object itself.

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

	= Removing an on-cluster custom layered image
	= Removal of an on-cluster custom layered image

Uh oh!

Conversation

mburke5678 commented Jun 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Jun 23, 2026 • edited by openshift-ci Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Jun 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lahinson left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

openshift-ci Bot commented Jul 2, 2026

Uh oh!

Uh oh!

mburke5678 commented Jul 2, 2026

Uh oh!

mburke5678 commented Jul 2, 2026

Uh oh!

mburke5678 commented Jul 2, 2026

Uh oh!

mburke5678 commented Jul 2, 2026

Uh oh!

openshift-cherrypick-robot commented Jul 2, 2026

Uh oh!

openshift-cherrypick-robot commented Jul 2, 2026

Uh oh!

openshift-cherrypick-robot commented Jul 2, 2026

Uh oh!

openshift-cherrypick-robot commented Jul 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mburke5678 commented Jun 23, 2026 •

edited

Loading

openshift-ci-robot commented Jun 23, 2026 •

edited by openshift-ci Bot

Loading

ocpdocs-previewbot commented Jun 23, 2026 •

edited

Loading