Merge pull request #73646 from jeana-redhat/OSDOCS-10020-CPMS-per-provider

OSDOCS-10020: CPMS per-provider breakout

Author: jeana-redhat

_attributes/common-attributes.adoc

@@ -264,6 +264,7 @@ endif::[]
 :azure-short: Azure
 :azure-id: Azure AD Workload Identity
 //vSphere
+:vmw-first: VMware vSphere
 :vmw-full: VMware vSphere
 :vmw-short: vSphere
 //Oracle

_topic_maps/_topic_map.yml

@@ -2311,10 +2311,25 @@ Topics:
     File: cpmso-about
   - Name: Getting started with control plane machine sets
     File: cpmso-getting-started
+  - Name: Managing control plane machines with control plane machine sets
+    File: cpmso-managing-machines
   - Name: Control plane machine set configuration
     File: cpmso-configuration
-  - Name: Using control plane machine sets
-    File: cpmso-using
+  - Name: Configuration options for control plane machines
+    Dir: cpmso_provider_configurations
+    Topics:
+    - Name: Control plane configuration options for Amazon Web Services
+      File: cpmso-config-options-aws
+    - Name: Control plane configuration options for Microsoft Azure
+      File: cpmso-config-options-azure
+    - Name: Control plane configuration options for Google Cloud Platform
+      File: cpmso-config-options-gcp
+    - Name: Control plane configuration options for Nutanix
+      File: cpmso-config-options-nutanix
+    - Name: Control plane configuration options for Red Hat OpenStack
+      File: cpmso-config-options-openstack
+    - Name: Control plane configuration options for VMware vSphere
+      File: cpmso-config-options-vsphere
   - Name: Control plane resiliency and recovery
     File: cpmso-resiliency
   - Name: Troubleshooting the control plane machine set

machine_management/control_plane_machine_management/cpmso-about.adoc

@@ -19,7 +19,7 @@ Control plane machine sets provide for control plane machines similar management
 include::modules/cpmso-overview.adoc[leveloffset=+1]
 
 //Control Plane Machine Set Operator limitations
-include::modules/cpmso-limitations.adoc[leveloffset=+1]
+include::modules/cpmso-limitations.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 [id="additional-resources_cpmso-about"]

machine_management/control_plane_machine_management/cpmso-configuration.adoc

@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-These example YAML snippets show the base structure for a control plane machine set custom resource (CR) and platform-specific samples for provider specification and failure domain configurations.
+This example YAML snippet shows the base structure for a control plane machine set custom resource (CR).
 
 //Sample YAML for a control plane machine set custom resource
 include::modules/cpmso-yaml-sample-cr.adoc[leveloffset=+1]
@@ -15,107 +15,22 @@ include::modules/cpmso-yaml-sample-cr.adoc[leveloffset=+1]
 .Additional resources
 * xref:../../machine_management/control_plane_machine_management/cpmso-getting-started.adoc#cpmso-getting-started[Getting started with control plane machine sets]
 
-* xref:../../machine_management/control_plane_machine_management/cpmso-using.adoc#cpmso-feat-config-update_cpmso-using[Updating the control plane configuration]
+* xref:../../machine_management/control_plane_machine_management/cpmso-managing-machines.adoc#cpmso-feat-config-update_cpmso-managing-machines[Updating the control plane configuration]
 
-[discrete]
 [id="cpmso-sample-yaml-provider-specific_{context}"]
-=== Provider-specific configuration
+== Provider-specific configuration options
 
-The `<platform_provider_spec>` and `<platform_failure_domains>` sections of the control plane machine set resources are provider-specific. Refer to the example YAML for your cluster:
+The `<platform_provider_spec>` and `<platform_failure_domains>` sections of the control plane machine set manifests are provider specific.
+For provider-specific configuration options for your cluster, see the following resources:
 
-* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-aws_cpmso-configuration[Sample YAML snippets for configuring Amazon Web Services clusters]
+* xref:../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-aws.adoc#cpmso-config-options-aws[Control plane configuration options for {aws-full}]
 
-* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-gcp_cpmso-configuration[Sample YAML snippets for configuring Google Cloud Platform clusters]
+* xref:../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-gcp.adoc#cpmso-config-options-gcp[Control plane configuration options for {gcp-full}]
 
-* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-azure_cpmso-configuration[Sample YAML snippets for configuring Microsoft Azure clusters]
+* xref:../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-azure.adoc#cpmso-config-options-azure[Control plane configuration options for {azure-full}]
 
-* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-nutanix_cpmso-configuration[Sample YAML snippets for configuring Nutanix clusters]
+* xref:../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-nutanix#cpmso-config-options-nutanix[Control plane configuration options for Nutanix]
 
-* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-vsphere_cpmso-configuration[Sample YAML snippets for configuring VMware vSphere clusters]
+* xref:../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-openstack.adoc#cpmso-config-options-openstack[Control plane configuration options for {rh-openstack-first}]
 
-* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-openstack_cpmso-configuration[Sample YAML snippets for configuring {rh-openstack-first} clusters]
-
-[id="cpmso-sample-yaml-aws_{context}"]
-== Sample YAML for configuring Amazon Web Services clusters
-
-Some sections of the control plane machine set CR are provider-specific. The following example YAML snippets show provider specification and failure domain configurations for an Amazon Web Services (AWS) cluster.
-
-//Sample AWS provider specification
-include::modules/cpmso-yaml-provider-spec-aws.adoc[leveloffset=+2]
-
-[role="_additional-resources"]
-.Additional resources
-* xref:../../machine_management/control_plane_machine_management/cpmso-using.adoc#cpmso-supported-features-aws_cpmso-using[Enabling Amazon Web Services features for control plane machines]
-
-//Sample AWS failure domain configuration
-include::modules/cpmso-yaml-failure-domain-aws.adoc[leveloffset=+2]
-
-[id="cpmso-sample-yaml-gcp_{context}"]
-== Sample YAML for configuring Google Cloud Platform clusters
-
-Some sections of the control plane machine set CR are provider-specific. The following example YAML snippets show provider specification and failure domain configurations for a Google Cloud Platform (GCP) cluster.
-
-//Sample GCP provider specification
-include::modules/cpmso-yaml-provider-spec-gcp.adoc[leveloffset=+2]
-
-[role="_additional-resources"]
-.Additional resources
-* xref:../../machine_management/control_plane_machine_management/cpmso-using.adoc#cpmso-supported-features-gcp_cpmso-using[Enabling Google Cloud Platform features for control plane machines]
-
-//Sample GCP failure domain configuration
-include::modules/cpmso-yaml-failure-domain-gcp.adoc[leveloffset=+2]
-
-[id="cpmso-sample-yaml-azure_{context}"]
-== Sample YAML for configuring Microsoft Azure clusters
-
-Some sections of the control plane machine set CR are provider-specific. The following example YAML snippets show provider specification and failure domain configurations for an Azure cluster.
-
-//Sample Azure provider specification
-include::modules/cpmso-yaml-provider-spec-azure.adoc[leveloffset=+2]
-
-[role="_additional-resources"]
-.Additional resources
-* xref:../../machine_management/control_plane_machine_management/cpmso-using.adoc#cpmso-supported-features-azure_cpmso-using[Enabling Microsoft Azure features for control plane machines]
-
-//Sample Azure failure domain configuration
-include::modules/cpmso-yaml-failure-domain-azure.adoc[leveloffset=+2]
-
-[id="cpmso-sample-yaml-nutanix_{context}"]
-== Sample YAML for configuring Nutanix clusters
-
-Some sections of the control plane machine set CR are provider-specific. The following example YAML snippet shows a provider specification configuration for a Nutanix cluster.
-
-//Sample Nutanix provider specification
-include::modules/cpmso-yaml-provider-spec-nutanix.adoc[leveloffset=+2]
-
-//Failure domains for Nutanix clusters
-include::modules/mapi-failure-domain-nutanix.adoc[leveloffset=+2]
-[role="_additional-resources"]
-.Additional resources
-* xref:../../post_installation_configuration/adding-nutanix-failure-domains.adoc#adding-failure-domains-to-an-existing-nutanix-cluster[Adding failure domains to an existing Nutanix cluster]
-
-[id="cpmso-sample-yaml-vsphere_{context}"]
-== Sample YAML for configuring VMware vSphere clusters
-
-Some sections of the control plane machine set CR are provider-specific. The following example YAML snippet shows a provider specification configuration for a VMware vSphere cluster.
-
-//Sample VMware vSphere provider specification
-include::modules/cpmso-yaml-provider-spec-vsphere.adoc[leveloffset=+2]
-
-//Sample VMware vSphere failure domain configuration
-include::modules/cpmso-yaml-failure-domain-vsphere.adoc[leveloffset=+2]
-
-[role="_additional-resources"]
-.Additional resources
-* For an example of a cluster-wide infrastructure CRD that defines resources for each failure domain, see xref:../../post_installation_configuration/post-install-vsphere-zones-regions-configuration.adoc#specifying-regions-zones-infrastructure-vsphere_post-install-vsphere-zones-regions-configuration[Specifying multiple regions and zones for your cluster on vSphere]
-
-[id="cpmso-sample-yaml-openstack_{context}"]
-== Sample YAML for configuring {rh-openstack-first} clusters
-
-Some sections of the control plane machine set CR are provider-specific. The following example YAML snippets show provider specification and failure domain configurations for an {rh-openstack} cluster.
-
-//Sample OpenStack provider specification
-include::modules/cpmso-yaml-provider-spec-openstack.adoc[leveloffset=+2]
-
-//Sample OpenStack failure domain configuration
-include::modules/cpmso-yaml-failure-domain-openstack.adoc[leveloffset=+2]
+* xref:../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-vsphere.adoc#cpmso-config-options-vsphere[Control plane configuration options for {vmw-full}]

machine_management/control_plane_machine_management/cpmso-getting-started.adoc

@@ -81,11 +81,8 @@ include::modules/cpmso-creating-cr.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
-* xref:../../machine_management/control_plane_machine_management/cpmso-using.adoc#cpmso-feat-config-update_cpmso-using[Updating the control plane configuration]
+* xref:../../machine_management/control_plane_machine_management/cpmso-managing-machines.adoc#cpmso-feat-config-update_cpmso-managing-machines[Updating the control plane configuration]
+
 * xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-configuration[Control plane machine set configuration]
-* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-aws_cpmso-configuration[Sample YAML for configuring Amazon Web Services clusters]
-* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-gcp_cpmso-configuration[Sample YAML for configuring Google Cloud Platform clusters]
-* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-azure_cpmso-configuration[Sample YAML for configuring Microsoft Azure clusters]
-* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-nutanix_cpmso-configuration[Sample YAML for configuring Nutanix clusters]
-* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-vsphere_cpmso-configuration[Sample YAML for configuring VMware vSphere clusters]
-* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-openstack_cpmso-configuration[Sample YAML for configuring {rh-openStack-first} clusters]
+
+* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-provider-specific_cpmso-configuration[Provider-specific configuration options]

machine_management/control_plane_machine_management/cpmso-managing-machines.adoc

@@ -0,0 +1,32 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="cpmso-managing-machines"]
+= Managing control plane machines with control plane machine sets
+include::_attributes/common-attributes.adoc[]
+:context: cpmso-managing-machines
+
+toc::[]
+
+Control plane machine sets automate several essential aspects of control plane management.
+
+//Vertical resizing of the control plane
+//include::modules/cpmso-feat-vertical-resize.adoc[leveloffset=+1]
+
+//Updating the control plane configuration
+include::modules/cpmso-feat-config-update.adoc[leveloffset=+1]
+
+//Automatic updates to the control plane configuration
+include::modules/cpmso-feat-auto-update.adoc[leveloffset=+2]
+
+//Manual updates to the control plane configuration
+include::modules/cpmso-feat-ondelete-update.adoc[leveloffset=+2]
+
+//Replacing a control plane machine
+include::modules/cpmso-feat-replace.adoc[leveloffset=+1]
+
+[id="additional-resources_{context}"]
+[role="_additional-resources"]
+== Additional resources
+
+* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-configuration[Control plane machine set configuration]
+
+* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-provider-specific_cpmso-configuration[Provider-specific configuration options]

machine_management/control_plane_machine_management/cpmso-resiliency.adoc

@@ -17,15 +17,20 @@ When possible, the control plane machine set spreads the control plane machines
 include::modules/cpmso-failure-domains-provider.adoc[leveloffset=+2]
 [role="_additional-resources"]
 .Additional resources
-* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-yaml-failure-domain-aws_cpmso-configuration[Sample Amazon Web Services failure domain configuration]
 
-* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-yaml-failure-domain-gcp_cpmso-configuration[Sample Google Cloud Platform failure domain configuration]
+* xref:../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-aws.adoc#cpmso-yaml-failure-domain-aws_cpmso-config-options-aws[Sample {aws-full} failure domain configuration]
 
-* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-yaml-failure-domain-azure_cpmso-configuration[Sample Microsoft Azure failure domain configuration]
+* xref:../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-gcp.adoc#cpmso-yaml-failure-domain-gcp_cpmso-config-options-gcp[Sample {gcp-full} failure domain configuration]
+
+* xref:../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-azure.adoc#cpmso-yaml-failure-domain-azure_cpmso-config-options-azure[Sample {azure-full} failure domain configuration]
 
 * xref:../../post_installation_configuration/adding-nutanix-failure-domains.adoc#adding-failure-domains-to-an-existing-nutanix-cluster[Adding failure domains to an existing Nutanix cluster]
 
-* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-yaml-failure-domain-openstack_cpmso-configuration[Sample {rh-openstack-first} failure domain configuration]
+* xref:../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-openstack.adoc#cpmso-yaml-failure-domain-openstack_cpmso-config-options-openstack[Sample {rh-openstack-first} failure domain configuration]
+
+* xref:../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-vsphere.adoc#cpmso-yaml-failure-domain-vsphere_cpmso-config-options-vsphere[Sample {vmw-full} failure domain configuration]
+
+* xref:../../post_installation_configuration/post-install-vsphere-zones-regions-configuration.adoc#post-install-vsphere-zones-regions-configuration[Regions and zones for a VMware vCenter]
 
 //Balancing control plane machines
 include::modules/cpmso-failure-domains-balancing.adoc[leveloffset=+2]

machine_management/control_plane_machine_management/cpmso-troubleshooting.adoc

@@ -21,7 +21,7 @@ include::modules/cpmso-ts-ilb-missing.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
-* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-yaml-provider-spec-azure_cpmso-configuration[Sample Azure provider specification]
+* xref:../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-azure.adoc#cpmso-yaml-provider-spec-azure_cpmso-config-options-azure[Sample {azure-full} provider specification]
 
 //Recovering a degraded etcd Operator after a machine health check operation
 include::modules/cpmso-ts-mhc-etcd-degraded.adoc[leveloffset=+1]