Skip to content

Azure machine parameters#

SSH#

The SSH public key can be passed to .spec.config.sshPublicKey parameter (in the case of a hosted control plane) or .spec.config.controlPlane.sshPublicKey and .spec.config.worker.sshPublicKey parameters (in the case of a standalone control plane) of the ClusterDeployment object.

It should be encoded in base64 format.

VM size#

Azure supports various VM sizes which can be retrieved with the following command:

az vm list-sizes --location "<location>" -o table

Then desired VM size could be passed to the:

  • .spec.config.vmSize - for hosted CP deployment.
  • .spec.config.controlPlane.vmSize - for control plane nodes in the standalone deployment.
  • .spec.config.worker.vmSize - for worker nodes in the standalone deployment.

Example: Standard_A4_v2

Root Volume size#

Root volume size of the VM (in GB) can be changed through the following parameters:

  • .spec.config.rootVolumeSize - for hosted CP deployment.
  • .spec.config.controlPlane.rootVolumeSize - for control plane nodes in the standalone deployment.
  • .spec.config.worker.rootVolumeSize - for worker nodes in the standalone deployment.

Default value: 30

Please note that this value can't be less than size of the root volume defined in your image.

VM Image#

You can define the image which will be used for your machine using the following parameters:

*.spec.config.image - for hosted CP deployment. * .spec.config.controlPlane.image - for control plane nodes in the standalone deployment. * .spec.config.worker.image - for worker nodes in the standalone deployment.

There are multiple self-excluding ways to define the image source (for example Azure Compute Gallery, Azure Marketplace, and so on).

If image is not specified, the default will be the ubuntu-2204 image from the Azure Marketplace.

Only one of the following image sources can be configured at a time:

  • image.id
  • image.computeGallery
  • image.marketplace

If multiple sources are specified, the precedence is as follows:

  1. id
  2. computeGallery
  3. marketplace

Example:

spec:
  config:
    image:
      computeGallery:
        gallery: aksazurelinux-f7c7cda5-1c9a-4bdc-a222-9614c968580b
        name: V2gen2arm64
        version: 202501.05.0

Detailed information regarding image can be found in CAPZ documentation

By default, the latest official CAPZ Ubuntu based image is used.