--- title: Creating a compute machine set on Azure Stack Hub --- # Creating a compute machine set on Azure Stack Hub {#creating-machineset-azure-stack-hub} You can create a different compute machine set to serve a specific purpose in your OpenShift Container Platform cluster on Microsoft Azure Stack Hub. For example, you might create infrastructure machine sets and related machines so that you can move supporting workloads to the new machines. > [!IMPORTANT] > 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: > > ```terminal > $ oc get infrastructure cluster -o jsonpath='{.status.platform}' > ``` ## Sample YAML for a compute machine set custom resource on Azure Stack Hub {#machineset-yaml-azure-stack-hub_creating-machineset-azure-stack-hub} You can create a machine set on Microsoft Azure Stack Hub. By defining a YAML configuration with specific cluster IDs and provider details, you can automate the provisioning of specialized nodes. The Microsoft Azure sample YAML defines a compute machine set that runs in the `1` Azure zone in a region and creates nodes that are labeled with `node-role.kubernetes.io/: ""`. In the sample, `` is the infrastructure ID label that is based on the cluster ID that you set when you provisioned the cluster, and `` is the node label to add. ```yaml apiVersion: machine.openshift.io/v1beta1 kind: MachineSet metadata: labels: machine.openshift.io/cluster-api-cluster: machine.openshift.io/cluster-api-machine-role: machine.openshift.io/cluster-api-machine-type: name: -- namespace: openshift-machine-api spec: replicas: 1 selector: matchLabels: machine.openshift.io/cluster-api-cluster: machine.openshift.io/cluster-api-machineset: -- template: metadata: creationTimestamp: null labels: machine.openshift.io/cluster-api-cluster: machine.openshift.io/cluster-api-machine-role: machine.openshift.io/cluster-api-machine-type: machine.openshift.io/cluster-api-machineset: -- spec: metadata: creationTimestamp: null labels: node-role.kubernetes.io/: "" providerSpec: value: apiVersion: machine.openshift.io/v1beta1 availabilitySet: credentialsSecret: name: azure-cloud-credentials namespace: openshift-machine-api image: offer: "" publisher: "" resourceID: /resourceGroups/-rg/providers/Microsoft.Compute/images/ sku: "" version: "" internalLoadBalancer: "" kind: AzureMachineProviderSpec location: managedIdentity: -identity metadata: creationTimestamp: null natRule: null networkResourceGroup: "" osDisk: diskSizeGB: 128 managedDisk: storageAccountType: Premium_LRS osType: Linux publicIP: false publicLoadBalancer: "" resourceGroup: -rg sshPrivateKey: "" sshPublicKey: "" subnet: --subnet userDataSecret: name: worker-user-data vmSize: Standard_DS4_v2 vnet: -vnet zone: "1" ``` where: `` : Specifies the infrastructure ID that is based on the cluster ID that you set when you provisioned the cluster. If you have the OpenShift Container Platform CLI installed, you can obtain the infrastructure ID by running the following command: ```terminal $ oc get -o jsonpath='{.status.infrastructureName}{"\n"}' infrastructure cluster ``` You can obtain the subnet by running the following command: ```terminal $ oc -n openshift-machine-api \ -o jsonpath='{.spec.template.spec.providerSpec.value.subnet}{"\n"}' \ get machineset/-worker-centralus1 ``` You can obtain the vnet by running the following command: ```terminal $ oc -n openshift-machine-api \ -o jsonpath='{.spec.template.spec.providerSpec.value.vnet}{"\n"}' \ get machineset/-worker-centralus1 ``` `` : Specifies the node label to add. `--` : Specifies the infrastructure ID, node label, and region. `` : Specifies the region to place machines on. > [!NOTE] > The `spec.template.spec.providerSpec.value.zone` specifies the zone within your region to place machines on. Be sure that your region supports the zone that you specify. `` : Specifies the availability set for the cluster. `` : Specifies the boot image to use. You should use the use the latest image when adding a new machine set. > [!NOTE] > Machine sets running on Azure Stack Hub do not support non-guaranteed Spot VMs. **Additional resources** {._additional-resources} - [Manually updating the boot image](/openshift-docs-markdown/machine_configuration/mco-update-boot-images-manual#mco-update-boot-images-manual) ## Creating a compute machine set {#machineset-creating_creating-machineset-azure-stack-hub} To dynamically manage machine compute resources, you can create your own compute machine sets in addition to the compute machine sets created by the installation program. Use the OpenShift Container Platform CLI to automate node provisioning. **Prerequisites** - Deploy an OpenShift Container Platform cluster. - Install the OpenShift CLI (`oc`). - Log in to `oc` as a user with `cluster-admin` permission. - Create an availability set in which to deploy Azure Stack Hub compute machines. **Procedure** 1. Create a new YAML file that contains the compute machine set custom resource (CR) sample and is named `.yaml`. Ensure that you set the ``, ``, and `` 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: ```terminal $ oc get machinesets -n openshift-machine-api ``` The following is example output: ```terminal 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 ``` 2. To view values of a specific compute machine set custom resource (CR), run the following command: ```terminal $ oc get machineset \ -n openshift-machine-api -o yaml ``` The following is example output: ```yaml apiVersion: machine.openshift.io/v1beta1 kind: MachineSet metadata: labels: machine.openshift.io/cluster-api-cluster: name: - namespace: openshift-machine-api spec: replicas: 1 selector: matchLabels: machine.openshift.io/cluster-api-cluster: machine.openshift.io/cluster-api-machineset: - template: metadata: labels: machine.openshift.io/cluster-api-cluster: machine.openshift.io/cluster-api-machine-role: machine.openshift.io/cluster-api-machine-type: machine.openshift.io/cluster-api-machineset: - spec: providerSpec: ... ``` where: `metadata.labels.machine.openshift.io/cluster-api-cluster` : Specifies the cluster infrastructure ID. `metadata.labels.name` : Specifies a default node label. > [!NOTE] > For clusters that have user-provisioned infrastructure, a compute machine set can only create `worker` and `infra` type machines. `spec.template.metadata.spec.providerSpec` : Specifies the values of the compute machine set CR. The values are platform-specific. For more information about `` 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: ```terminal $ oc create -f .yaml ``` **Verification** - View the list of compute machine sets by running the following command: ```terminal $ oc get machineset -n openshift-machine-api ``` The following is example output: ```terminal NAME DESIRED CURRENT READY AVAILABLE AGE agl030519-vplxk-infra-us-east-1a 1 1 1 1 11m 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 ``` 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. ## Labeling GPU machine sets for the cluster autoscaler {#machineset-label-gpu-autoscaler_creating-machineset-azure-stack-hub} Label your machine sets to indicate which machines the cluster autoscaler can use for GPU-enabled nodes. Applying the accelerator label helps ensure that the autoscaler deploys the correct resources for your GPU workloads. **Prerequisites** - Your cluster uses a cluster autoscaler. **Procedure** - On the machine set that you want to create machines for the cluster autoscaler to use to deploy GPU-enabled nodes, add a `cluster-api/accelerator` label: ```yaml apiVersion: machine.openshift.io/v1beta1 kind: MachineSet metadata: name: machine-set-name spec: template: spec: metadata: labels: cluster-api/accelerator: ``` where: `` : Specifies a label of your choice that consists of alphanumeric characters, `-`, `_`, or `.` and starts and ends with an alphanumeric character. For example, you might use `nvidia-t4` to represent Nvidia T4 GPUs, or `nvidia-a10g` for A10G GPUs. > [!NOTE] > You must specify the value of this label for the `spec.resourceLimits.gpus.type` parameter in your `ClusterAutoscaler` CR. For more information, see "Cluster autoscaler resource definition". **Additional resources** {._additional-resources} - [Cluster autoscaler resource definition](/openshift-docs-markdown/machine_management/applying-autoscaling#cluster-autoscaler-cr_applying-autoscaling) ## Enabling Microsoft Azure boot diagnostics {#machineset-azure-boot-diagnostics_creating-machineset-azure-stack-hub} You can enable boot diagnostics on Microsoft Azure machines that your machine set creates. Use this to store console logs that you can use to troubleshoot why a node fails to boot. **Prerequisites** - Have an existing Azure Stack Hub cluster. **Procedure** - Add the `diagnostics` configuration that is applicable to your storage type to the `providerSpec` field in your machine set YAML file: - For an Azure Managed storage account: ```yaml providerSpec: value: diagnostics: boot: storageAccountType: ``` where: `` : Specifies an Azure Managed storage account. - For an Azure Unmanaged storage account: ```yaml providerSpec: value: diagnostics: boot: storageAccountType: customerManaged: storageAccountURI: .blob.core.windows.net> ``` where: `` : Specifies an Azure Unmanaged storage account. `https://.blob.core.windows.net` : Specifies the storage account URL. Replace `` with the name of your storage account. > [!NOTE] > Only the Azure Blob Storage data service is supported. **Verification** - On the Azure portal, review the **Boot diagnostics** page for a machine deployed by the machine set, and verify that you can see the serial logs for the machine. ## Enabling customer-managed encryption keys for a machine set {#machineset-enabling-customer-managed-encryption-azure_creating-machineset-azure-stack-hub} To enhance data security, enable customer-managed encryption on Microsoft Azure by adding the disk encryption set ID to your machine set. You can supply an encryption key to Azure to encrypt data on managed disks at rest. You can enable server-side encryption with customer-managed keys by using the Machine API. An Azure Key Vault, a disk encryption set, and an encryption key are required to use a customer-managed key. The disk encryption set must be in a resource group where the Cloud Credential Operator (CCO) has granted permissions. If not, an additional reader role is required to be granted on the disk encryption set. **Prerequisites** - [You created an Azure Key Vault instance (Azure documentation)](https://docs.microsoft.com/en-us/azure/aks/azure-disk-customer-managed-keys#create-an-azure-key-vault-instance). - [You created an instance of a disk encryption set (Azure documentation)](https://docs.microsoft.com/en-us/azure/aks/azure-disk-customer-managed-keys#create-an-instance-of-a-diskencryptionset). - [You granted the disk encryption set access to key vault (Azure documentation)](https://docs.microsoft.com/en-us/azure/aks/azure-disk-customer-managed-keys#grant-the-diskencryptionset-access-to-key-vault). **Procedure** - Configure the disk encryption set under the `providerSpec` field in your machine set YAML file. For example: ```yaml providerSpec: value: osDisk: diskSizeGB: 128 managedDisk: diskEncryptionSet: id: /subscriptions//resourceGroups//providers/Microsoft.Compute/diskEncryptionSets/ storageAccountType: Premium_LRS ``` **Additional resources** {._additional-resources} - [Customer-managed keys (Azure documentation)](https://docs.microsoft.com/en-us/azure/virtual-machines/disk-encryption#customer-managed-keys)