Last modified November 27, 2024

cluster-azure chart reference

The cluster-azure chart templates all the Azure infrastructure resources that are necessary to create a Cluster API Azure cluster.

Chart Configuration Reference

Azure settings

.providerSpecific.azureClusterIdentity

Identity
object

AzureClusterIdentity resource to use for this cluster.

.providerSpecific.azureClusterIdentity.name

Name
string

.providerSpecific.azureClusterIdentity.namespace

Namespace
string

.providerSpecific.location

Location
string

.providerSpecific.network

Azure network settings
object

Azure VNet peering and other Azure-specific network settings.

.providerSpecific.network.peerings

VNet peerings
array

Specifying VNets (their resource groups and names) to which the peering is established.

.providerSpecific.network.peerings[*]

VNet peering
object

.providerSpecific.network.peerings[*].remoteVnetName

VNet name
string

Name of the remote VNet to which the peering is established.

.providerSpecific.network.peerings[*].resourceGroup

Resource group name
string

Resource group for the remote VNet to which the peering is established.

.providerSpecific.subscriptionId

Subscription ID
string

ID of the Azure subscription this cluster will run in.

Connectivity

.connectivity.allowedCIDRs

List of CIDRs which have to been allowed to connect to the API Server endpoint
array

.connectivity.allowedCIDRs[*]

string

.connectivity.containerRegistries

Container registries
object

Endpoints and credentials configuration for container registries.

.connectivity.containerRegistries.*

Registries
array

Container registries and mirrors

.connectivity.containerRegistries.[]

Registry
object

.connectivity.containerRegistries.[].credentials

Credentials
object

.connectivity.containerRegistries.[].credentials.auth

Auth
string

Base64-encoded string from the concatenation of the username, a colon, and the password.

.connectivity.containerRegistries.[].credentials.identitytoken

Identity token
string

Used to authenticate the user and obtain an access token for the registry.

.connectivity.containerRegistries.[].credentials.password

Password
string

Used to authenticate for the registry with username/password.

.connectivity.containerRegistries.[].credentials.username

Username
string

Used to authenticate for the registry with username/password.

.connectivity.containerRegistries.[].endpoint

Endpoint
string

Endpoint for the container registry.

.connectivity.network

Network
object

.connectivity.network.controlPlane

Control plane
object

.connectivity.network.controlPlane.cidr

Subnet
string

.connectivity.network.hostCidr

Node subnet
string

IPv4 address range for nodes, in CIDR notation.

.connectivity.network.mode

Network mode
string

Specifying if the cluster resources are publicly accessible or not.

.connectivity.network.podCidr

Pod subnet
string

IPv4 address range for pods, in CIDR notation.

.connectivity.network.serviceCidr

Service subnet
string

IPv4 address range for services, in CIDR notation.

.connectivity.network.workers

Workers
object

.connectivity.network.workers.cidr

Subnet
string

Control plane

.controlPlane.containerdVolumeSizeGB

Containerd volume size (GB)
integer

.controlPlane.encryptionAtHost

Encryption at host
boolean

Enable encryption at host for the control plane nodes.

.controlPlane.etcdVolumeSizeGB

Etcd volume size (GB)
integer

.controlPlane.instanceType

Node VM size
string

.controlPlane.kubeletVolumeSizeGB

Kubelet volume size (GB)
integer

.controlPlane.oidc

OIDC authentication
object

.controlPlane.oidc.caPem

Certificate authority
string

Identity provider's CA certificate in PEM format.

.controlPlane.oidc.clientId

Client ID
string

.controlPlane.oidc.groupsClaim

Groups claim
string

.controlPlane.oidc.issuerUrl

Issuer URL
string

.controlPlane.oidc.usernameClaim

Username claim
string

.controlPlane.replicas

Number of nodes
integer

.controlPlane.rootVolumeSizeGB

Root volume size (GB)
integer

Internal settings

.internal.defaults

Default settings
object

.internal.defaults.evictionMinimumReclaim

Default settings for eviction minimum reclaim
string

.internal.defaults.hardEvictionThresholds

Default settings for hard eviction thresholds
string

.internal.defaults.softEvictionGracePeriod

Default settings for soft eviction grace period
string

.internal.defaults.softEvictionThresholds

Default settings for soft eviction thresholds
string

.internal.enableVpaResources

Enable VPA Resources in helmreleases
boolean

.internal.identity

Identity
object

.internal.identity.attachCapzControllerUserAssignedIdentity

Attach CAPZ controller UserAssigned identity
boolean

.internal.identity.systemAssignedScope

Scope of SystemAssignedIdentity
string

.internal.identity.type

Type of Identity
string

.internal.identity.userAssignedCustomIdentities

List of custom UserAssigned Identities to attach to all nodes
array

.internal.image

Node Image
object

.internal.image.gallery

Gallery
string

Name of the community gallery hosting the image

.internal.image.name

Image Definition
string

Name of the image definition in the Gallery

.internal.image.version

Image version
string

.internal.kubectlImage

Kubectl Image settings
object

.internal.kubectlImage.name

Image name
string

Name of the image Registry

.internal.kubectlImage.registry

Kubectl Image Registry
string

Registry for the kubectl image

.internal.kubectlImage.tag

Image tag
string

.internal.kubernetesVersion

Kubernetes version
string

.internal.network

Network configuration
object

Internal network configuration that is susceptible to more frequent change

.internal.network.subnets

VNet spec
object

Customize subnets configuration

.internal.network.subnets.controlPlaneSubnetName

ControlPlane subnet name
string

Name of the control plane subnet.

.internal.network.subnets.nodeSubnetNatGatewayName

Nodes subnet nat-gateway name
string

Name of the nat gateway on the nodes subnet.

.internal.network.subnets.nodesSubnetName

Nodes subnet name
string

Name of the nodes subnet.

.internal.network.vnet

VNet spec
object

Existing VNet configuration. This is susceptible to more frequent change or removal.

.internal.network.vnet.name

VNet name
string

Name of the existing VNet.

.internal.network.vnet.resourceGroup

Resource group name
string

Resource group where the existing VNet is deployed.

.internal.network.vpn

VPN configuration
object

Internal VPN configuration that is susceptible to more frequent change

.internal.network.vpn.gatewayMode

VPN gateway mode
string

.internal.sandboxContainerImage

The image used by sandbox / pause container
object

.internal.sandboxContainerImage.name

Repository
string

.internal.sandboxContainerImage.registry

Registry
string

.internal.sandboxContainerImage.tag

Tag
string

.internal.teleport

Teleport
object

.internal.teleport.enabled

Enable teleport
boolean

.internal.teleport.proxyAddr

Teleport proxy address
string

.internal.teleport.version

Teleport version
string

Metadata

.metadata.description

Cluster description
string

User-friendly description of the cluster's purpose.

.metadata.labels

Labels
object

These labels are added to the Kubernetes resources defining this cluster.

.metadata.labels.PATTERN

Label
string

.metadata.name

Cluster name
string

Unique identifier, cannot be changed after creation.

.metadata.organization

Organization
string

.metadata.servicePriority

Service priority
string

The relative importance of this cluster.

Node pools

.nodePools[*].customNodeLabels

Custom node labels
array

.nodePools[].customNodeLabels[]

Label
string

.nodePools[*].customNodeTaints

Custom node taints
array

.nodePools[].customNodeTaints[]

Node taint
object

.nodePools[].customNodeTaints[].effect

Effect
string

.nodePools[].customNodeTaints[].key

Key
string

.nodePools[].customNodeTaints[].value

Value
string

.nodePools[*].disableHealthCheck

Disable HealthChecks for the MachineDeployment
boolean

.nodePools[*].encryptionAtHost