Creating a compute machine set on Nutanix

You can create a different compute machine set to serve a specific purpose in your OKD cluster on Nutanix. For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines.

You can use the advanced machine management and scaling capabilities only in clusters where the Machine API is operational. Clusters with user-provisioned infrastructure require additional validation and configuration to use the Machine API.

Clusters with the infrastructure platform type none cannot use the Machine API. This limitation applies even if the compute machines that are attached to the cluster are installed on a platform that supports the feature. This parameter cannot be changed after installation.

To view the platform type for your cluster, run the following command:

  1. $ oc get infrastructure cluster -o jsonpath=’{.status.platform}’

Sample YAML for a compute machine set custom resource on Nutanix

This sample YAML defines a Nutanix compute machine set that creates nodes that are labeled with node-role.kubernetes.io/<role>: "".

In this sample, <infrastructure_id> is the infrastructure ID label that is based on the cluster ID that you set when you provisioned the cluster, and <role> is the node label to add.

Values obtained by using the OpenShift CLI

In the following example, you can obtain some of the values for your cluster by using the OpenShift CLI (oc).

Infrastructure ID

The <infrastructure_id> string is the infrastructure ID that is based on the cluster ID that you set when you provisioned the cluster. If you have the OpenShift CLI installed, you can obtain the infrastructure ID by running the following command:

  1. $ oc get -o jsonpath='{.status.infrastructureName}{"\n"}' infrastructure cluster
  1. apiVersion: machine.openshift.io/v1beta1
  2. kind: MachineSet
  3. metadata:
  4.   labels:
  5.     machine.openshift.io/cluster-api-cluster: <infrastructure_id> (1)
  6.     machine.openshift.io/cluster-api-machine-role: <role> (2)
  7.     machine.openshift.io/cluster-api-machine-type: <role>
  8.   name: <infrastructure_id>-<role>-<zone> (3)
  9.   namespace: openshift-machine-api
  10.   annotations: (4)
  11.     machine.openshift.io/memoryMb: "16384"
  12.     machine.openshift.io/vCPU: "4"
  13. spec:
  14.   replicas: 3
  15.   selector:
  16.     matchLabels:
  17.       machine.openshift.io/cluster-api-cluster: <infrastructure_id>
  18.       machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>-<zone>
  19.   template:
  20.     metadata:
  21.       labels:
  22.         machine.openshift.io/cluster-api-cluster: <infrastructure_id>
  23.         machine.openshift.io/cluster-api-machine-role: <role>
  24.         machine.openshift.io/cluster-api-machine-type: <role>
  25.         machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>-<zone>
  26.     spec:
  27.       metadata:
  28.         labels:
  29.           node-role.kubernetes.io/<role>: ""
  30.       providerSpec:
  31.         value:
  32.           apiVersion: machine.openshift.io/v1
  33.           bootType: "" (5)
  34.           categories: (6)
  35.           - key: <category_name>
  36.             value: <category_value>
  37.           cluster: (7)
  38.             type: uuid
  39.             uuid: <cluster_uuid>
  40.           credentialsSecret:
  41.             name: nutanix-credentials
  42.           image:
  43.             name: <infrastructure_id>-rhcos (8)
  44.             type: name
  45.           kind: NutanixMachineProviderConfig
  46.           memorySize: 16Gi (9)
  47.           project: (10)
  48.             type: name
  49.             name: <project_name>
  50.           subnets:
  51.           - type: uuid
  52.             uuid: <subnet_uuid>
  53.           systemDiskSize: 120Gi (11)
  54.           userDataSecret:
  55.             name: <user_data_secret> (12)
  56.           vcpuSockets: 4 (13)
  57.           vcpusPerSocket: 1 (14)
1For <infrastructure_id>, specify the infrastructure ID that is based on the cluster ID that you set when you provisioned the cluster.
2Specify the node label to add.
3Specify the infrastructure ID, node label, and zone.
4Annotations for the cluster autoscaler.
5Specifies the boot type that the compute machines use. For more information about boot types, see Understanding UEFI, Secure Boot, and TPM in the Virtualized Environment. Valid values are Legacy, SecureBoot, or UEFI. The default is Legacy.

You must use the Legacy boot type in OKD 4.

6Specify one or more Nutanix Prism categories to apply to compute machines. This stanza requires key and value parameters for a category key-value pair that exists in Prism Central. For more information about categories, see Category management.
7Specify a Nutanix Prism Element cluster configuration. In this example, the cluster type is uuid, so there is a uuid stanza.
8Specify the image to use. Use an image from an existing default compute machine set for the cluster.
9Specify the amount of memory for the cluster in Gi.
10Specify the Nutanix project that you use for your cluster. In this example, the project type is name, so there is a name stanza.
11Specify the size of the system disk in Gi.
12Specify the name of the secret in the user data YAML file that is in the openshift-machine-api namespace. Use the value that installation program populates in the default compute machine set.
13Specify the number of vCPU sockets.
14Specify the number of vCPUs per socket.

Creating a compute machine set

In addition to the compute machine sets created by the installation program, you can create your own to dynamically manage the machine compute resources for specific workloads of your choice.

Prerequisites

  • Deploy an OKD cluster.

  • Install the OpenShift CLI (oc).

  • Log in to oc as a user with cluster-admin permission.

Procedure

  1. Create a new YAML file that contains the compute machine set custom resource (CR) sample and is named <file_name>.yaml.

    Ensure that you set the <clusterID> and <role> parameter values.

  2. Optional: If you are not sure which value to set for a specific field, you can check an existing compute machine set from your cluster.

    1. To list the compute machine sets in your cluster, run the following command:

      1. $ oc get machinesets -n openshift-machine-api

      Example output

      1. NAME                                DESIRED   CURRENT   READY   AVAILABLE   AGE
      2. agl030519-vplxk-worker-us-east-1a   1         1         1       1           55m
      3. agl030519-vplxk-worker-us-east-1b   1         1         1       1           55m
      4. agl030519-vplxk-worker-us-east-1c   1         1         1       1           55m
      5. agl030519-vplxk-worker-us-east-1d   0         0                             55m
      6. agl030519-vplxk-worker-us-east-1e   0         0                             55m
      7. agl030519-vplxk-worker-us-east-1f   0         0                             55m

    2. To view values of a specific compute machine set custom resource (CR), run the following command:

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

      Example output

      1. apiVersion: machine.openshift.io/v1beta1
      2. kind: MachineSet
      3. metadata:
      4.   labels:
      5.     machine.openshift.io/cluster-api-cluster: <infrastructure_id> (1)
      6.   name: <infrastructure_id>-<role> (2)
      7.   namespace: openshift-machine-api
      8. spec:
      9.   replicas: 1
      10.   selector:
      11.     matchLabels:
      12.       machine.openshift.io/cluster-api-cluster: <infrastructure_id>
      13.       machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>
      14.   template:
      15.     metadata:
      16.       labels:
      17.         machine.openshift.io/cluster-api-cluster: <infrastructure_id>
      18.         machine.openshift.io/cluster-api-machine-role: <role>
      19.         machine.openshift.io/cluster-api-machine-type: <role>
      20.         machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>
      21.     spec:
      22.       providerSpec: (3)
      23.         ...
      1The cluster infrastructure ID.
      2A default node label.

      For clusters that have user-provisioned infrastructure, a compute machine set can only create worker and infra type machines.

      3The values in the <providerSpec> section of the compute machine set CR are platform-specific. For more information about <providerSpec> parameters in the CR, see the sample compute machine set CR configuration for your provider.

  3. Create a MachineSet CR by running the following command:

    1. $ oc create -f <file_name>.yaml

Verification

  • View the list of compute machine sets by running the following command:

    1. $ oc get machineset -n openshift-machine-api

    Example output

    1. NAME                                DESIRED   CURRENT   READY   AVAILABLE   AGE
    2. agl030519-vplxk-infra-us-east-1a    1         1         1       1           11m
    3. agl030519-vplxk-worker-us-east-1a   1         1         1       1           55m
    4. agl030519-vplxk-worker-us-east-1b   1         1         1       1           55m
    5. agl030519-vplxk-worker-us-east-1c   1         1         1       1           55m
    6. agl030519-vplxk-worker-us-east-1d   0         0                             55m
    7. agl030519-vplxk-worker-us-east-1e   0         0                             55m
    8. agl030519-vplxk-worker-us-east-1f   0         0                             55m

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