Skip to content

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

Open
mburke5678 wants to merge 1 commit into
openshift:mainfrom
mburke5678:mach-6-2
Open

OCPDOCS CQA MACH-6: CPMSO Provider Configurations and Health Checks II#117214
mburke5678 wants to merge 1 commit into
openshift:mainfrom
mburke5678:mach-6-2

Conversation

@mburke5678

@mburke5678 mburke5678 commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

@openshift-ci-robot

Copy link
Copy Markdown

@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

Quick review of files that didn't trigger a Vale error.

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 openshift-ci Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 4, 2026
@ocpdocs-previewbot

ocpdocs-previewbot commented Aug 4, 2026

Copy link
Copy Markdown

🤖 Tue Aug 04 18:51:49 - Prow CI generated the docs preview:
https://117214--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

[role="_abstract"]
To prevent downtime for your application due to the failure of a single {aws-first} region, you can configure failure domains in the control plane machine set.
To use failure domains, you configure appropriate values in the `failureDomains` section of the `ControlPlaneMachineSet` custom resource (CR).
To prevent downtime for your applications due to the failure of a single {aws-first} region, you can configure failure domains in the control plane machine set by configuring appropriate values in the `failureDomains` section of the `ControlPlaneMachineSet` object.

@mburke5678 mburke5678 Aug 4, 2026

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.

This and the next four short descriptions were too long (more than 300 characters).


[role="_abstract"]
To ensure that your cluster remains scalable and resilient, you can use a `MachineSet` object and machine health checks to automate the provisioning and repair of nodes. {product-title} adds a cluster-specific tag to each virtual machine (VM) that it creates. The installation program uses these tags to select the VMs to delete when uninstalling a cluster.
To ensure that your cluster remains scalable and resilient, you can use a `MachineSet` object and machine health checks to automate the provisioning and repair of nodes.

@mburke5678 mburke5678 Aug 4, 2026

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.

Short desc is too long. Split the sentences to fix that error.


[role="_abstract"]
You can use machine health checks to detect and remediate unhealthy machines automatically while limiting disruption to the targeted machine pool.
You can use machine health checks to detect and remediate unhealthy machines automatically, limiting disruption to the targeted machine pool.

@mburke5678 mburke5678 Aug 4, 2026

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.

Per ISG, use while only to refer to a period of time. I'll fix this while I'm here. ;-)

[role="_abstract"]
You can create a `MachineHealthCheck` resource to monitor and automatically remediate unhealthy machines in a machine set.

You can create a `MachineHealthCheck` resource for machine sets in your cluster.

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.

redundant?

Comment on lines -18 to +20
Accelerated Networking uses single root I/O virtualization (SR-IOV) to provide {azure-first} VMs with a more direct path to the switch. This enhances network performance. You can enable this feature
You can enable Accelerated Networking, which uses single root I/O virtualization (SR-IOV) to provide {azure-first} VMs with a more direct path to the switch.
ifdef::compute[during or ]
after installation.
after installation. This enhances network performance.

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.

To make this more user-centric.

Comment on lines 14 to +17
[role="_abstract"]
{product-title} {product-version} supports trusted launch for {azure-full} virtual machines (VMs). By editing the machine set YAML file, you can configure the trusted launch options that a machine set uses for machines that it deploys. For example, you can configure these machines to use UEFI security features such as Secure Boot or a dedicated virtual Trusted Platform Module (vTPM) instance.
By editing the machine set YAML file, you can configure the trusted launch for {azure-full} virtual machines (VMs) options that a machine set uses for machines that it deploys.

For example, you can configure these machines to use UEFI security features such as Secure Boot or a dedicated virtual Trusted Platform Module (vTPM) instance.

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.

Short desc too long

Comment on lines 14 to +15
[role="_abstract"]
{product-title} {product-version} supports {azure-full} confidential virtual machines (VMs). By enabling {azure-short} confidential VMs, you can use memory encryption to improve data confidentiality.
You can enable {azure-full} confidential virtual machines (VMs) to use memory encryption to improve data confidentiality.

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.

To make this more user-centric. Also, if we are telling folks to to use confidential virtual machines , doesn't that suggest OCP supports it?

Comment on lines 14 to +15
[role="_abstract"]
Configure Shielded Virtual Machine (VM) options for your machine sets on {gcp-first} to help secure your cluster instances. By editing the `MachineSet` YAML file, you can configure the Shielded VM options that a machine set uses for machines that it deploys.
To help secure your cluster instances, you can configure Shielded Virtual Machine (VM) options for your machine sets on {gcp-first} by editing the `MachineSet` YAML file.

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.

I wanted to put the "why" first for a bit more punch. And tightened it up a bit, I think.

Comment on lines 10 to +13
[role="_abstract"]
To provide persistent storage beyond the root volume for specialized application workloads, define a `dataDisks` array in the `MachineSet` YAML file to specify disk size and storage policy. {product-title} clusters on {vmw-first} support adding up to 29 disks to the virtual machine (VM) controller.
To provide persistent storage beyond the root volume for specialized application workloads, define a `dataDisks` array in the `MachineSet` YAML file to specify disk size and storage policy.

{product-title} clusters on {vmw-first} support adding up to 29 disks to the virtual machine (VM) controller.

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.

Short description is too long after the attribute renders.

Comment on lines +10 to +11
[role="_abstract"]
Update failure domain configurations on a Nutanix cluster by coordinating changes to specific resources. You must modify the cluster infrastructure, control plane machine set, and compute machine set custom resources (CRs) to apply the new configuration.
To modify failure domain configurations on a Nutanix cluster, you must modifying the cluster infrastructure, control plane machine set, and compute machine set custom resources (CRs) to apply the new configuration.

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.

Just preference; I didn't like the use of Update here, as it is usually/often used in a different context (as in upgrade). And tightened it up a bit.

@openshift-ci-robot

Copy link
Copy Markdown

@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

Quick review of files that didn't trigger a Vale error.

Previews:
Configuring multiple network interface controllers by using machine sets -- Added + after code block in step 3.
Enabling Accelerated Networking on an existing Microsoft Azure cluster -- Added + after code block in step 1.
Configuring Azure confidential virtual machines by using machine sets -- Added + after code block in step 1.

Control plane configuration options for Microsoft Azure -- Various edits in assembly.
Control plane configuration options for VMware vSphere -- Various edits in assembly.
Control plane configuration options for Red Hat OpenStack Platform (RHOSP) -- Various edits in assembly.
Control plane configuration options for Amazon Web Services -- Various edits in assembly.
Control plane configuration options for Nutanix -- Various edits in assembly.
Deploying machine health checks-- Various edits in assembly.

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-robot

Copy link
Copy Markdown

@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

Quick review of files that didn't trigger a Vale error.

Previews:
Configuring multiple network interface controllers by using machine sets -- Added + after code block in step 3.
Enabling Accelerated Networking on an existing Microsoft Azure cluster -- Added + after code block in step 1.

Control plane configuration options for Microsoft Azure -- Various edits in assembly.
Control plane configuration options for VMware vSphere -- Various edits in assembly.
Control plane configuration options for Red Hat OpenStack Platform (RHOSP) -- Various edits in assembly.
Control plane configuration options for Amazon Web Services -- Various edits in assembly.
Control plane configuration options for Nutanix -- Various edits in assembly.
Deploying machine health checks-- Various edits in assembly.

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

openshift-ci Bot commented Aug 4, 2026

Copy link
Copy Markdown

@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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants