Skip to content

OSDOCS Specify that user-created machinesets should use the latest bootimages#109278

Open
mburke5678 wants to merge 13 commits intoopenshift:mainfrom
mburke5678:mco-boot-image-use-latest
Open

OSDOCS Specify that user-created machinesets should use the latest bootimages#109278
mburke5678 wants to merge 13 commits intoopenshift:mainfrom
mburke5678:mco-boot-image-use-latest

Conversation

@mburke5678
Copy link
Copy Markdown
Contributor

@mburke5678 mburke5678 commented Mar 30, 2026

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

Link to docs preview:
Overview of machine management -> Compute machine management -- Added note at end of section and link.

Standard machine sets:
Sample YAML for a compute machine set custom resource on AWS
Sample YAML for a compute machine set custom resource on Azure
Sample YAML for a compute machine set custom resource on Azure Stack Hub
Sample YAML for a compute machine set custom resource on Google Cloud
Sample YAML for a compute machine set custom resource on IBM Cloud
Sample YAML for a compute machine set custom resource on IBM Power Virtual Server
Sample YAML for a compute machine set custom resource on Nutanix
Sample YAML for a compute machine set custom resource on OpenStack
Sample YAML for a compute machine set custom resource that uses SR-IOV on RHOSP
Sample YAML for a compute machine set custom resource on vSphere
Sample YAML for a compute machine set custom resource on bare metal

Infrastructure machine sets:
Sample YAML for a compute machine set custom resource on AWS
Sample YAML for a compute machine set custom resource on Azure
Sample YAML for a compute machine set custom resource on Azure Stack Hub
Sample YAML for a compute machine set custom resource on IBM Cloud
Sample YAML for a compute machine set custom resource on Google Cloud
Sample YAML for a compute machine set custom resource on Nutanix
Sample YAML for a compute machine set custom resource on RHOSP
Sample YAML for a compute machine set custom resource on vSphere

Machine configuration -> Manually updating the boot image -> Manually updating the boot image on a Nutanix cluster -- Added boot image skew enforcement wording, as last step in the procedure, right before the verification.
Machine configuration -> Manually updating the boot image -> Manually updating the boot image on an RHOSP cluster -- Added boot image skew enforcement wording, as last step in the procedure, right before the verification.

QE review:

  • QE has approved this change.

@mburke5678 mburke5678 added this to the Planned for 4.22 GA milestone Mar 30, 2026
@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 30, 2026
@ocpdocs-previewbot
Copy link
Copy Markdown

ocpdocs-previewbot commented Mar 30, 2026

🤖 Tue Apr 14 13:27:39 - Prow CI generated the docs preview:
https://109278--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

@openshift-ci openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 31, 2026
@mburke5678
Copy link
Copy Markdown
Contributor Author

/retest

`<disk_name>`:: Specifies one or more data disk definitions. For more information, see "Configuring data disks by using machine sets".
`<image_name>`:: Specifies the image to use as a boot image for your nodes. You should use the use the latest image when adding a new machine set.
`<vm_network_name>`:: Specifies the vSphere VM network to deploy the compute machine set to. This VM network must be where other compute machines reside in the cluster.
`<vm_template_name>`:: Specifies the vSphere VM template to use, such as `user-5ddjd-rhcos`.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

vsphere uses template field, there is no image field

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<vm_template_name>:: Specifies the vSphere VM template to use as a boot image for your nodes, such as user-5ddjd-rhcos. You should use a template with the latest {product-title} image when adding a new machine set.

<3> Specify the node label to add.
<4> Edit the `checksum` URL to use the API VIP address.
<5> Edit the `url` URL to use the API VIP address.
<4> Specify the image details of the boot image for your nodes. You should use the latest image when adding a new machine set.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should ask them to migrate to the new system for baremetal(#109158) than do this, since it is a one time action. This is referencing the old <4.9, presumably because the docs are out of date?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When creating a bare metal machine set, you do not need to specify a boot image? The CVO takes care of this for new machines?
As for what is outdated, is it the whole stanza or just the <4> and <5>?

          image: <4>
            checksum: http:/172.22.0.3:6181/images/rhcos-<version>.<architecture>.qcow2.<md5sum> <5>
            url: http://172.22.0.3:6181/images/rhcos-<version>.<architecture>.qcow2 <6>

It appears the example was added around the time when 4.12 was the current release. So it could be dated.


[NOTE]
====
When creating a new machine set, you should specify the latest image to use for the boot image. The method to specify the image varies by provider.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When creating a new machine set, you should specify the latest image to use for the boot image. The method to specify the image varies by provider.
When creating a new machine set, you should specify the latest image to use for the boot image. For more info about updating the bootimage on your cluster, please refer to "Boot image management". The method to update or specify the image varies by provider.

I did not see the preview for this, but perhaps it would be helpful to provide a reference about boot image updates here, so they can figure out if their cluster is even updated, and if it is, they can just copy of an existing machineset.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to preview: Managing compute machines

@mburke5678 mburke5678 force-pushed the mco-boot-image-use-latest branch 2 times, most recently from ba4b183 to 72611dd Compare April 9, 2026 13:02

[NOTE]
====
When creating a new machine set, you should specify the latest image to use for the boot image. For more information about updating the boot image on your cluster, see "Manually updating the boot image". The method to update or specify the image varies by platform.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When creating a new machine set, you should specify the latest image to use for the boot image. For more information about updating the boot image on your cluster, see "Manually updating the boot image". The method to update or specify the image varies by platform.
When creating a new machine set, you should specify the latest image to use for the boot image. For more information about updating the boot image on your cluster, see "Manually updating the boot image" and "Boot image management". The method to update or specify the image varies by platform.

just adding a ref here

@djoshy
Copy link
Copy Markdown

djoshy commented Apr 9, 2026

lgtm!

|===

For all other platforms, the MCO does not update the boot image with each cluster update.
For all other platforms, the MCO does not automatically update the boot image with each cluster update. For clusters where automatic updates are disabled or not supported, you can manually update the boot image on your cluster. See "Manually updating the boot image" for information. The method to update or specify the image varies by platform.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there already a link to "Manually updating the boot image" in additional resources?

@openshift-ci openshift-ci bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 14, 2026
@mburke5678 mburke5678 force-pushed the mco-boot-image-use-latest branch from 2eb1f90 to 400fc50 Compare April 14, 2026 13:04
@openshift-ci openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 14, 2026
@mburke5678 mburke5678 force-pushed the mco-boot-image-use-latest branch from c892555 to d032668 Compare April 14, 2026 13:13
@openshift-ci openshift-ci bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 14, 2026
@openshift-ci
Copy link
Copy Markdown

openshift-ci bot commented Apr 14, 2026

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.22 size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants