AzureClusterConfiguration

Version: deckhouse.io/v1

  • apiVersionstring

    Required value

    Allowed values: deckhouse.io/v1, deckhouse.io/v1alpha1

  • kindstring

    Required value

    Allowed values: AzureClusterConfiguration

  • layoutstring

    Required value

    The way resources are located in the cloud.

    Read more about possible provider layouts.

    Allowed values: Standard

  • masterNodeGroup

    Required value

    The definition of the master’s NodeGroup.

    • instanceClassobject

      Required value

      Partial contents of the AzureInstanceClass fields.

      • additionalTagsobject

        The additional tags to attach to the instances created (in addition to those specified in the cloud provider configuration).

        Example:

        project: cms-production
        severity: critical
        
      • diskSizeGbinteger

        Instance root disk size in gigabytes.

        Example:

        diskSizeGb: 40
        
      • diskTypestring

        The type of the volume to create.

        You can view a list of available volume types using the Azure CLI:

        az vm list-skus -l westeurope --zone`
        

        Example:

        diskType: StandardSSD_LRS
        
      • enableExternalIPboolean

        Only available for the Standard layout.

        • false — the nodes do not have public addresses and access the Internet over NAT.
        • true — static public addresses are created for nodes.

        Default: false

        Allowed values: true, false

      • machineSizestring

        Required value

        The type of instances to provision.

        You can view a list of available types for the specific region using the Azure CLI:

        az vm list-sizes --location westeurope -o table
        

        Example:

        machineSize: Standard_F4
        
      • urnstring

        Required value

        The VM image to use for an instance.

        More information about virtual machine images can be found in the official documentation.

        You can get the latest version of an image using the Azure CLI:

        • az vm image show --urn Canonical:UbuntuServer:18.04-LTS:latest --location westeurope
        • az vm image show --urn Canonical:0001-com-ubuntu-server-focal:20_04-lts:latest --location westeurope

        By default: The image specified in AzureCloudDiscoveryData is used (the master of the cluster is based on this image).

        Caution! Currently, only Ubuntu 18.04, Ubuntu 20.04, Centos 7 are supported and tested to work.

    • replicasinteger

      Required value

      The number of master nodes to create.

      Allowed values: 1 <= X

    • zonesarray of strings

      A list of zones where master nodes can be created.

      You can browse a list of zones available for the selected instance type using the Azure CLI:

      az vm list-skus -l westeurope -o table
      

      Default: [1,2,3]

  • nodeGroupsarray of objects

    An array of additional NodeGroups for creating static nodes (e.g., for dedicated front nodes or gateways).

    • instanceClassobject

      Required value

      Partial contents of the fields of the AzureInstanceClass.

      • additionalTagsobject

        The additional tags to attach to the instances created (in addition to those specified in the cloud provider configuration).

        Example:

        project: cms-production
        severity: critical
        
      • diskSizeGbinteger

        Instance root disk size in gigabytes.

        Example:

        diskSizeGb: 40
        
      • diskTypestring

        The type of the volume to create.

        You can view a list of available volume types using the Azure CLI:

        az vm list-skus -l westeurope --zone`
        

        Example:

        diskType: StandardSSD_LRS
        
      • enableExternalIPboolean

        Only available for the Standard layout.

        • false — the nodes do not have public addresses and access the Internet over NAT.
        • true — static public addresses are created for nodes.

        Default: false

        Allowed values: true, false

      • machineSizestring

        Required value

        The type of instances to provision.

        You can view a list of available types for the specific region using the Azure CLI:

        az vm list-sizes --location westeurope -o table
        

        Example:

        machineSize: Standard_F4
        
      • urnstring

        Required value

        The VM image to use for an instance.

        More information about virtual machine images can be found in the official documentation.

        You can get the latest version of an image using the Azure CLI:

        • az vm image show --urn Canonical:UbuntuServer:18.04-LTS:latest --location westeurope
        • az vm image show --urn Canonical:0001-com-ubuntu-server-focal:20_04-lts:latest --location westeurope

        By default: The image specified in AzureCloudDiscoveryData is used (the master of the cluster is based on this image).

        Caution! Currently, only Ubuntu 18.04, Ubuntu 20.04, Centos 7 are supported and tested to work.

    • namestring

      Required value

      The name of the NodeGroup to use for generating node names.

    • nodeTemplate

      Parameters of Node objects in Kubernetes to add after registering the node.

      • annotationsobject

        The same as the metadata.annotations standard field.

        Example:

        annotations:
          ai.fleet.com/discombobulate: "true"
        
      • labelsobject

        A list of labels to attach to cluster resources.

        The same as the metadata.labels standard field.

        Note that you have to re-create all the machines to add new tags if tags were modified in the running cluster.

        Format — key: value.

        Example:

        labels:
          environment: production
          app: warp-drive-ai
        
      • taintsarray of objects

        The same as the .spec.taints field of the Node object.

        Caution! Only the effect, key, values fields are available.

        Example:

        taints:
        - effect: NoExecute
          key: ship-class
          value: frigate
        
        • effectstring

          Allowed values: NoSchedule, PreferNoSchedule, NoExecute

        • keystring
        • valuestring
    • replicasinteger

      Required value

      The number of nodes to create.

    • zonesarray of strings

      A list of zones where static nodes can be created;

      You can browse a list of zones available for the selected instance type using the Azure CLI:

      az vm list-skus -l westeurope -o table
      

      Default: [1,2,3]

  • peeredVNetsarray of objects

    An array of VNets to merge with the cluster network.

    The service account must have access to all the VNets listed above. You have to configure the peering connection manually if no access is available.

    • resourceGroupNamestring

      Required value

      The name of the resource group with the VNet.

    • vnetNamestring

      Required value

      The name of the VNet.

  • providerobject

    Required value

    Parameters for connecting to the Azure API.

    • clientIdstring

      Required value

      The client ID.

    • clientSecretstring

      Required value

      The client’s secret.

    • locationstring

      Required value

      The name of the region to create all the resources.

    • subscriptionIdstring

      Required value

      The ID of the subscription.

    • tenantIdstring

      Required value

      The ID of the tenant.

  • sshPublicKeystring

    Required value

    Public key to access nodes as azureuser.

  • standardobject

    Settings for the Standard layout.

    • natGatewayPublicIpCountinteger

      The number of IP addresses for the NAT Gateway (pricing). NAT Gateway is not used if the value is 0.

      Default: 0

  • subnetCIDRstring

    Required value

    A subnet from the vNetCIDR address space for cluster nodes.

    Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/(3[0-2]|[1-2][0-9]|[0-9]))$

    Example:

    subnetCIDR: 10.1.2.0/24
    
  • tagsobject

    A list of tags in the key: value format to attach to all cluster resources.

    You have to re-create all the machines to add new tags if tags were modified in the running cluster.

  • vNetCIDRstring

    Required value

    An address space of the virtual network in the CIDR format.

    Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/(3[0-2]|[1-2][0-9]|[0-9]))$

    Example:

    vNetCIDR: 10.0.0.0/16
    
  • zonesarray of strings

    The globally restricted set of zones that this Cloud Provider works with.