Getting started with control plane machine sets

    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 activate the CR.

    Clusters without a generated CR

    For clusters that do not include a generated CR, you must with the appropriate configuration for your cluster.

    If you are uncertain about the state of the ControlPlaneMachineSet CR in your cluster, you can verify the CR status.

    In OKD 4.13, the control plane machine sets are supported for Amazon Web Services (AWS), Google Cloud Platform (GCP), Microsoft Azure, and VMware vSphere clusters.

    The status of the control plane machine set after installation depends on your cloud provider and the version of OKD that you installed on your cluster.

    1. AWS clusters that are upgraded from version 4.11 or earlier require CR activation.

    2. GCP and Azure clusters that are upgraded from version 4.12 or earlier require .

    You can verify the existence and state of the ControlPlaneMachineSet custom resource (CR).

    Procedure

    • Determine the state of the CR by running the following command:

      • A result of Active indicates that the ControlPlaneMachineSet CR exists and is activated. No administrator action is required.

      • A result of NotFound indicates that there is no existing ControlPlaneMachineSet CR.

    Next steps

    To use the control plane machine set, you must ensure that a ControlPlaneMachineSet CR with the correct settings for your cluster exists.

    • If your cluster has an existing CR, you must verify that the configuration in the CR is correct for your cluster.

    • If your cluster does not have an existing CR, you must create one with the correct configuration for your cluster.

    To use the control plane machine set, you must ensure that a ControlPlaneMachineSet custom resource (CR) with the correct settings for your cluster exists. On a cluster with a generated CR, you must verify that the configuration in the CR is correct for your cluster and activate it.

    For more information about the parameters in the CR, see “Control plane machine set configuration”.

    Procedure

    1. View the configuration of the CR by running the following command:

    2. Change the values of any fields that are incorrect for your cluster configuration.

    Additional resources

    To use the control plane machine set, you must ensure that a ControlPlaneMachineSet custom resource (CR) with the correct settings for your cluster exists. On a cluster without a generated CR, you must create the CR manually and activate it.

    For more information about the structure and parameters of the CR, see “Control plane machine set configuration”.

    Procedure

    1. Create a YAML file using the following template:

      Control plane machine set CR YAML file template

    2. Refer to the sample failure domain configuration and sample provider specification for your cloud provider and update those sections of your file with the appropriate values.

    3. When the configuration is correct, activate the CR by setting the .spec.state field to Active and saving your changes.

    4. Create the CR from your YAML file by running the following command:

      where <control_plane_machine_set> is the name of the YAML file that contains the CR configuration.

    Additional resources