Creating a Windows MachineSet object on AWS

    • You installed the Windows Machine Config Operator (WMCO) using Operator Lifecycle Manager (OLM).

    • You are using a supported Windows Server as the operating system image.

      Use the following aws command to query valid AMI images:

    The Machine API is a combination of primary resources that are based on the upstream Cluster API project and custom OKD resources.

    For OKD 4.13 clusters, the Machine API performs all node host provisioning management actions after the cluster installation finishes. Because of this system, OKD 4.13 offers an elastic, dynamic provisioning method on top of public or private cloud infrastructure.

    The two primary resources are:

    Machines

    A fundamental unit that describes the host for a node. A machine has a providerSpec specification, which describes the types of compute nodes that are offered for different cloud platforms. For example, a machine type for a worker node on Amazon Web Services (AWS) might define a specific machine type and required metadata.

    Machine sets

    MachineSet resources are groups of compute machines. Compute machine sets are to compute machines as replica sets are to pods. If you need more compute machines or must scale them down, you change the replicas field on the MachineSet resource to meet your compute need.

    The following custom resources add more capabilities to your cluster:

    The MachineAutoscaler resource automatically scales compute machines in a cloud. You can set the minimum and maximum scaling boundaries for nodes in a specified compute machine set, and the machine autoscaler maintains that range of nodes.

    The MachineAutoscaler object takes effect after a ClusterAutoscaler object exists. Both ClusterAutoscaler and MachineAutoscaler resources are made available by the ClusterAutoscalerOperator object.

    Cluster autoscaler

    This resource is based on the upstream cluster autoscaler project. In the OKD implementation, it is integrated with the Machine API by extending the compute machine set API. You can use the cluster autoscaler to manage your cluster in the following ways:

    • Set cluster-wide scaling limits for resources such as cores, nodes, memory, and GPU

    • Set the priority so that the cluster prioritizes pods and new nodes are not brought online for less important pods

    • Set the scaling policy so that you can scale up nodes but not scale them down

    Machine health check

    The MachineHealthCheck resource detects when a machine is unhealthy, deletes it, and, on supported platforms, makes a new machine.

    In OKD version 3.11, you could not roll out a multi-zone architecture easily because the cluster did not manage machine provisioning. Beginning with OKD version 4.1, this process is easier. Each compute machine set is scoped to a single zone, so the installation program sends out compute machine sets across availability zones on your behalf. And then because your compute is dynamic, and in the face of a zone failure, you always have a zone for when you must rebalance your machines. In global Azure regions that do not have multiple availability zones, you can use availability sets to ensure high availability. The autoscaler provides best-effort balancing over the life of a cluster.

    This sample YAML defines a Windows MachineSet object running on Amazon Web Services (AWS) that the Windows Machine Config Operator (WMCO) can react upon.

    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>-windows-worker-<zone> (2)
    7.   namespace: openshift-machine-api
    8. spec:
    9.   replicas: 1
    10.   selector:
    11.     matchLabels:
    12.       machine.openshift.io/cluster-api-cluster: <infrastructure_id> (1)
    13.       machine.openshift.io/cluster-api-machineset: <infrastructure_id>-windows-worker-<zone> (2)
    14.   template:
    15.     metadata:
    16.       labels:
    17.         machine.openshift.io/cluster-api-cluster: <infrastructure_id> (1)
    18.         machine.openshift.io/cluster-api-machine-role: worker
    19.         machine.openshift.io/cluster-api-machine-type: worker
    21.     spec:
    22.       metadata:
    23.         labels:
    24.           node-role.kubernetes.io/worker: "" (4)
    25.       providerSpec:
    26.         value:
    27.           ami:
    28.             id: <windows_container_ami> (5)
    29.           apiVersion: awsproviderconfig.openshift.io/v1beta1
    30.           blockDevices:
    31.             - ebs:
    32.                 iops: 0
    33.                 volumeSize: 120
    34.                 volumeType: gp2
    35.           credentialsSecret:
    36.             name: aws-cloud-credentials
    37.           deviceIndex: 0
    38.           iamInstanceProfile:
    39.             id: <infrastructure_id>-worker-profile (1)
    40.           instanceType: m5a.large
    41.           kind: AWSMachineProviderConfig
    42.           placement:
    43.             availabilityZone: <zone> (6)
    44.             region: <region> (7)
    45.           securityGroups:
    46.             - filters:
    47.                 - name: tag:Name
    48.                   values:
    49.                     - <infrastructure_id>-worker-sg (1)
    50.           subnet:
    51.               - name: tag:Name
    52.                 values:
    54.           tags:
    55.             - name: kubernetes.io/cluster/<infrastructure_id> (1)
    56.               value: owned
    57.           userDataSecret:
    58.             name: windows-user-data (8)
    59.             namespace: openshift-machine-api

    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.

    • 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:

        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

    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