OCPDOCS CQA MACH-6: CPMSO Provider Configurations and Health Checks Redux by mburke5678 · Pull Request #117206 · openshift/openshift-docs

mburke5678 · 2026-08-03T21:03:05Z

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

Previews:
Deploying machine health checks -- Updated entire assembly.
Changing the RHOSP compute flavor by using a control plane machine set -- Updated module.
Configuring multiple network interface controllers by using machine sets -- Updated module

openshift-ci-robot · 2026-08-03T21:03:07Z

@mburke5678: No Jira issue with key MACH-6 exists in the tracker at https://redhat.atlassian.net.
Once a valid jira issue is referenced in the title of this pull request, request a refresh with /jira refresh.

Details

In response to this:

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

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.

mburke5678 · 2026-08-03T21:10:33Z


 include::modules/machine-health-checks-creating.adoc[leveloffset=+1]

-You can configure and deploy a machine health check to detect and repair unhealthy bare metal nodes.


Moved to a module.

mburke5678 · 2026-08-03T21:23:43Z

+
+[role="_abstract"]
+You can use machine health check short-circuiting to ensure that machine health checks remediate machines only when the cluster is healthy, by configuring the `maxUnhealthy` field in the `MachineHealthCheck` resource.
+


Moved from https://github.com/openshift/openshift-docs/pull/117206/changes#diff-4dcba0b1e71613dc3607d7de39037ba614c0c2cd4f8de056ac50748191df095fL49. No need to review beyond the short desc. And changed the H3s to description list entries.

mburke5678 · 2026-08-03T21:24:10Z

 `spec.template.machines_v1beta1_machine_openshift_io.spec.providerSpec.value.network.workspace.server`:: Specifies the vCenter server IP or fully qualified domain name (FQDN).

 end::controlplane[]
--


Yeah, I have no idea....

mburke5678 · 2026-08-03T21:25:37Z

+
+[role="_abstract"]
+You can configure a machine health check by using a `MachineHealthCheck` custom resource (CR).
+


Moved from https://github.com/openshift/openshift-docs/pull/117206/changes#diff-9035c4e32d3908a412d19cfcf79271e1f3cfd5bb7a002b8b59c58749d6c79a42L70. But, I did move some things around, re-wrote a few, and added a few. Please do review.

mburke5678 · 2026-08-03T21:26:19Z

-If the power operations did not complete, the metal3 remediation controller triggers the reprovisioning of the unhealthy node unless this is a control plane node or a node that was provisioned externally.
-====
-
-[id="mgmt-power-remediation-baremetal-about-creating-mhc-baremetal_{context}"]


Moved to https://github.com/openshift/openshift-docs/pull/117206/changes#diff-3cd3c9313bf01396a184127e93053ed688373e92f4a1ee1ac16db662de78a550R7

mburke5678 · 2026-08-03T21:31:44Z

+
+:_mod-docs-content-type: CONCEPT
+[id="mgmt-power-remediation-baremetal-about-troubleshooting_{context}"]
+= Troubleshooting issues with power-based remediation


Moved from https://github.com/openshift/openshift-docs/pull/117206/changes#diff-9035c4e32d3908a412d19cfcf79271e1f3cfd5bb7a002b8b59c58749d6c79a42L176 and edited lightly.

mburke5678 · 2026-08-03T21:33:08Z

 After using one of these methods, unhealthy machines are power-cycled by using Baseboard Management Controller (BMC) credentials.

-[id="mgmt-power-remediation-baremetal-about-understanding-remediation-process_{context}"]
-== Understanding the annotation-based remediation process


Converted to description list to remediate an H3 error.

ocpdocs-previewbot · 2026-08-03T21:35:09Z

🤖 Mon Aug 03 23:20:04 - Prow CI generated the docs preview:

https://117206--ocpdocs-pr.netlify.app/openshift-enterprise/latest/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-supported-features-openstack.html
https://117206--ocpdocs-pr.netlify.app/openshift-enterprise/latest/machine_management/creating_machinesets/creating-machineset-vsphere.html
https://117206--ocpdocs-pr.netlify.app/openshift-enterprise/latest/machine_management/deploying-machine-health-checks.html
https://117206--ocpdocs-pr.netlify.app/openshift-enterprise/latest/post_installation_configuration/node-tasks.html

mburke5678 · 2026-08-03T21:36:14Z

-[NOTE]
-====
-If the power operations did not complete, the metal3 remediation controller triggers the reprovisioning of the unhealthy node unless this is a control plane node or a node that was provisioned externally.
-====


This note is still in the file and renders well in the preview.

ocpdocs-vale-bot · 2026-08-03T21:46:21Z

+
+.Prerequisites
+
+* The {product-title} is installed using installer-provisioned infrastructure (IPI).


🤖 [error] RedHat.TermsErrors: Use 'installer-provisioned infrastructure' rather than 'IPI'. For more information, see RedHat.TermsErrors.

ocpdocs-vale-bot · 2026-08-03T21:46:23Z

+
+--
+`metadata.name`:: Specifies the name of the machine health check to deploy.
+`metadata.annotations`:: For bare metal clusters, you must include the `machine.openshift.io/remediation-strategy: external-baremetal` annotation in the `annotations` section to enable power-cycle remediation. With this remediation strategy, unhealthy hosts are rebooted instead of removed from the cluster.


🤖 [error] RedHat.TermsErrors: Use 'bare-metal clusters' rather than 'bare metal clusters'. For more information, see RedHat.TermsErrors.

ocpdocs-vale-bot · 2026-08-03T21:46:26Z


-In a bare metal cluster, remediation of nodes is critical to ensuring the overall health of the cluster. Physically remediating a cluster can be challenging and any delay in putting the machine into a safe or an operational state increases the time the cluster remains in a degraded state, and the risk that subsequent failures might bring the cluster offline. Power-based remediation helps counter such challenges.
+[role="_abstract"]
+You can configure and deploy a machine health check to detect and repair unhealthy bare metal nodes, which is critical to ensuring the overall health of the cluster. 


🤖 [error] RedHat.TermsErrors: Use 'bare-metal nodes' rather than 'bare metal nodes'. For more information, see RedHat.TermsErrors.

mburke5678 · 2026-08-03T21:50:55Z

-
-[id="machine-health-checks-short-circuiting_{context}"]
-== Short-circuiting machine health check remediation
-


Moved to ‎modules/machine-health-checks-short-circuiting.adoc‎ to avoid H3s.

openshift-ci-robot · 2026-08-03T22:33:03Z

@mburke5678: No Jira issue with key MACH-6 exists in the tracker at https://redhat.atlassian.net.
Once a valid jira issue is referenced in the title of this pull request, request a refresh with /jira refresh.

Details

In response to this:

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

Previews:
Deploying machine health checks -- Updated entire assembly.
Changing the RHOSP compute flavor by using a control plane machine set -- Updated module.
Configuring multiple network interface controllers by using machine sets -- Updated module

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.

openshift-ci · 2026-08-03T23:21:40Z

@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 added this to the Continuous Release milestone Aug 3, 2026

mburke5678 added branch/enterprise-4.20 branch/enterprise-4.21 branch/enterprise-4.22 labels Aug 3, 2026

mburke5678 added the branch/enterprise-5.0 label Aug 3, 2026

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

mburke5678 commented Aug 3, 2026

View reviewed changes

ocpdocs-vale-bot reviewed Aug 3, 2026

View reviewed changes

mburke5678 commented Aug 3, 2026

View reviewed changes

OCPDOCS CQA MACH-6: CPMSO Provider Configurations and Health Checks

30a303a

mburke5678 force-pushed the mach-6-1 branch from e077d3d to 30a303a Compare August 3, 2026 22:34


		include::modules/machine-health-checks-creating.adoc[leveloffset=+1]

		You can configure and deploy a machine health check to detect and repair unhealthy bare metal nodes.


		[role="_abstract"]
		You can use machine health check short-circuiting to ensure that machine health checks remediate machines only when the cluster is healthy, by configuring the `maxUnhealthy` field in the `MachineHealthCheck` resource.


		[role="_abstract"]
		You can configure a machine health check by using a `MachineHealthCheck` custom resource (CR).


		.Prerequisites

		* The {product-title} is installed using installer-provisioned infrastructure (IPI).


		[id="machine-health-checks-short-circuiting_{context}"]
		== Short-circuiting machine health check remediation

Uh oh!

Conversation

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

Uh oh!

Uh oh!

openshift-ci-robot commented Aug 3, 2026

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!

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

Uh oh!

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-robot commented Aug 3, 2026

Uh oh!

openshift-ci Bot commented Aug 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mburke5678 commented Aug 3, 2026 •

edited

Loading

ocpdocs-previewbot commented Aug 3, 2026 •

edited

Loading