:_mod-docs-content-type: ASSEMBLY
[id="cpmso-getting-started"]
= Getting started with control plane machine sets
include::_attributes/common-attributes.adoc[]
:context: cpmso-getting-started

toc::[]

[role="_abstract"]
Set up the control plane machine set to enable automated management, recovery, and configuration updates for control plane machines in your cluster.

The process for getting started with control plane machine sets depends on the state of the `ControlPlaneMachineSet` custom resource (CR) in your cluster.

Clusters with an active generated CR:: Clusters that have a generated CR with an active state use the control plane machine set by default. No administrator action is required.

Clusters with an inactive generated CR:: For clusters that include an inactive generated CR, you must review the CR configuration and xref:../../machine_management/control_plane_machine_management/cpmso-getting-started.adoc#cpmso-activating_cpmso-getting-started[activate the CR].

Clusters without a generated CR:: For clusters that do not include a generated CR, you must xref:../../machine_management/control_plane_machine_management/cpmso-getting-started.adoc#cpmso-creating-cr_cpmso-getting-started[create and activate a CR] with the appropriate configuration for your cluster.

If you are uncertain about the state of the `ControlPlaneMachineSet` CR in your cluster, you can xref:../../machine_management/control_plane_machine_management/cpmso-getting-started.adoc#cpmso-checking-status_cpmso-getting-started[verify the CR status].

[id="cpmso-platform-matrix_{context}"]
== Supported cloud providers

In {product-title} {product-version}, the control plane machine set is supported for Amazon Web Services (AWS), {gcp-first}, Microsoft Azure, Nutanix, and VMware vSphere clusters.

The status of the control plane machine set after installation depends on your cloud provider and the version of {product-title} that you installed on your cluster.

.Control plane machine set implementation for {product-title} {product-version}
[cols="<.^5,^.^4,^.^4,^.^4"]
|====
|Cloud provider |Active by default |Generated CR |Manual CR required

|{aws-first}
|X ^[1]^
|X
|

|{gcp-first}
|X ^[2]^
|X
|

|{azure-first}
|X ^[2]^
|X
|

|Nutanix
|X ^[3]^
|X
|

|{rh-openstack-first}
|X ^[3]^
|X
|

|{vmw-full}
|X ^[4]^
|X
|
|====
[.small]
--
1. {aws-short} clusters that are upgraded from version 4.11 or earlier require xref:../../machine_management/control_plane_machine_management/cpmso-getting-started.adoc#cpmso-activating_cpmso-getting-started[CR activation].
2. {gcp-short} and {azure-short} clusters that are upgraded from version 4.12 or earlier require xref:../../machine_management/control_plane_machine_management/cpmso-getting-started.adoc#cpmso-activating_cpmso-getting-started[CR activation].
3. Nutanix and {rh-openstack} clusters that are upgraded from version 4.13 or earlier require xref:../../machine_management/control_plane_machine_management/cpmso-getting-started.adoc#cpmso-activating_cpmso-getting-started[CR activation].
4. {vmw-short} clusters that are upgraded from version 4.15 or earlier require xref:../../machine_management/control_plane_machine_management/cpmso-getting-started.adoc#cpmso-activating_cpmso-getting-started[CR activation].
--

//Checking the control plane machine set custom resource state
include::modules/cpmso-checking-status.adoc[leveloffset=+1]

//Activating the control plane machine set custom resource
include::modules/cpmso-activating.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-configuration[Control plane machine set configuration]

//Creating a control plane machine set custom resource
include::modules/cpmso-creating-cr.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* 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-config-provider-specific_cpmso-configuration[Provider-specific configuration options]