Chapter 12. Managing machines with the Cluster API

Procedure

1. Create a YAML file that contains the cluster custom resource (CR) and is named <cluster_resource_file>.yaml.

   If you are not sure which value to set for the <cluster_name> parameter, you can check the value for an existing Machine API machine set in your cluster.

   1. To list the Machine API machine sets, run the following command:

      $ oc get machinesets -n openshift-machine-api 

      1

      Copy to Clipboard Toggle word wrap

      1

      Specify the openshift-machine-api namespace.

      Example output

      NAME                                DESIRED   CURRENT   READY   AVAILABLE   AGE
      agl030519-vplxk-worker-us-east-1a   1         1         1       1           55m
      agl030519-vplxk-worker-us-east-1b   1         1         1       1           55m
      agl030519-vplxk-worker-us-east-1c   1         1         1       1           55m
      agl030519-vplxk-worker-us-east-1d   0         0                             55m
      agl030519-vplxk-worker-us-east-1e   0         0                             55m
      agl030519-vplxk-worker-us-east-1f   0         0                             55m

      Copy to Clipboard Toggle word wrap

   2. To display the contents of a specific machine set CR, run the following command:

      $ oc get machineset <machineset_name> \
      -n openshift-machine-api \
      -o yaml

      Copy to Clipboard Toggle word wrap

      Example output

      ...
      template:
          metadata:
            labels:
              machine.openshift.io/cluster-api-cluster: agl030519-vplxk 

      1

      
              machine.openshift.io/cluster-api-machine-role: worker
              machine.openshift.io/cluster-api-machine-type: worker
              machine.openshift.io/cluster-api-machineset: agl030519-vplxk-worker-us-east-1a
      ...

      Copy to Clipboard Toggle word wrap

      1

      The cluster ID, which you use for the <cluster_name> parameter.

2. Create the cluster CR by running the following command:

   $ oc create -f <cluster_resource_file>.yaml

   Copy to Clipboard Toggle word wrap

   Verification

   To confirm that the cluster CR is created, run the following command:

   $ oc get cluster

   Copy to Clipboard Toggle word wrap

   Example output

   NAME           PHASE        AGE  VERSION
   <cluster_name> Provisioning 4h6m

   Copy to Clipboard Toggle word wrap

3. Create a YAML file that contains the infrastructure CR and is named <infrastructure_resource_file>.yaml.

4. Create the infrastructure CR by running the following command:

   $ oc create -f <infrastructure_resource_file>.yaml

   Copy to Clipboard Toggle word wrap

   Verification

   To confirm that the infrastructure CR is created, run the following command:

   $ oc get <infrastructure_kind>

   Copy to Clipboard Toggle word wrap

   where <infrastructure_kind> is the value that corresponds to your platform.

   Example output

   NAME           CLUSTER        READY VPC BASTION IP
   <cluster_name> <cluster_name> true

   Copy to Clipboard Toggle word wrap

5. Create a YAML file that contains the machine template CR and is named <machine_template_resource_file>.yaml.

6. Create the machine template CR by running the following command:

   $ oc create -f <machine_template_resource_file>.yaml

   Copy to Clipboard Toggle word wrap

   Verification

   To confirm that the machine template CR is created, run the following command:

   $ oc get <machine_template_kind>

   Copy to Clipboard Toggle word wrap

   where <machine_template_kind> is the value that corresponds to your platform.

   Example output

   NAME            AGE
   <template_name> 77m

   Copy to Clipboard Toggle word wrap

7. Create a YAML file that contains the machine set CR and is named <machine_set_resource_file>.yaml.

8. Create the machine set CR by running the following command:

   $ oc create -f <machine_set_resource_file>.yaml

   Copy to Clipboard Toggle word wrap

   Verification

   To confirm that the machine set CR is created, run the following command:

   $ oc get machineset -n openshift-cluster-api 

   1

   Copy to Clipboard Toggle word wrap

   1

   Specify the openshift-cluster-api namespace.

   Example output

   NAME               CLUSTER        REPLICAS READY AVAILABLE AGE VERSION
   <machine_set_name> <cluster_name> 1        1     1         17m

   Copy to Clipboard Toggle word wrap

   When the new machine set is available, the REPLICAS and AVAILABLE values match. If the machine set is not available, wait a few minutes and run the command again.