Azure

Zuul can use Azure as a source for build nodes.

Before using the Azure driver, make sure you have created a service principal.

Two methods of authenticating the service principal are available: a shared secret or OIDC federation.

To use a shared secret: save the credential information in a JSON file. Follow the instructions at Azure CLI and use the --sdk-auth flag:

az ad sp create-for-rbac --name zuul --sdk-auth

There are two options for providing the information in this file to Zuul: place this file on the zuul-launcher and refer to it using <azure connection>.shared_credentials_file or extract the information in the file and provide it directly with the configuration options below.

To use OIDC federation, the JWT must be available in a file on the zuul-launcher (for example, by way of Kubernetes secret projection). Set the <azure connection>.subscription_id, <azure connection>.tenant_id, <azure connection>.client_id, and <azure connection>.federated_token_file fields.

You must also have created a network for Zuul to use. Be sure to enable IPv6 on the network if you plan to use it.

The Azure driver uses the “Standard” SKU for all public IP addresses. Standard IP addresses block all incoming traffic by default, therefore the use of a Network Security Group is required in order to allow incoming traffic. You will need to create one, add any required rules, and attach it to the subnet created above.

You may also need to register the Microsoft.Compute resource provider with your subscription.

The azure driver adds the following options to the provider and section configurations:

Connection Configuration

The supported options in zuul.conf connections are:

<azure connection>

<azure connection>.driver (required)

azure: The connection must set driver=azure for Azure connections.

<azure connection>.shared_credentials_file: A path to JSON file with shared access credentials. If this is supplied, no other credential settings need to be present.

<azure connection>.federated_token_file: Path to the a file containing a JWT for use with OIDC federation.

<azure connection>.tenant_id: The Microsoft Entra tenant ID for the account. Required unless <azure connection>.shared_credentials_file is set.

<azure connection>.client_id: The Microsoft Entra client ID for the account. Required unless <azure connection>.shared_credentials_file is set.

<azure connection>.client_secret: The shared secret for the principal. Required unless <azure connection>.shared_credentials_file or <azure connection>.federated_token_file are set.

<azure connection>.subscription_id: The Azure subscription to use. Required unless <azure connection>.shared_credentials_file is set.

<azure connection>.rate Default: 2: The API rate limit (in requests per second) to use when performing API calls with Azure.

Provider Configuration

The azure driver adds the following options to the provider and section configurations:

provider[azure] Type: dict

The attributes available for configuring an Azure provider are below.

provider[azure].abstract Default: False Type: bool: Whether a section is intended to be inherited by another section or a provider. This setting is currently unused (but may be used in the future). If a section is used to provide common values to other sections, set this to true. Otherwise, the default of false indicates that the section should be referenced directly by providers.

provider[azure].connection Type: str: The name of the connection to use. This attribute is only used by section objects and may not be changed via inheritance.

provider[azure].flavor-defaults Type: dict

Attributes to be set as default values for any flavor used with this provider. Many attributes which may be set on an individual flavor may be set once in this section and used for all the flavors in this provider. Values set on individual flavors may still override the values set here.

provider[azure].flavor-defaults.ephemeral-disk Type: bool: If set to true, Azure will create an ephemeral OS disk instead of a managed disk.

provider[azure].flavor-defaults.final Default: False

Whether the configuration of the flavor may be updated by values in flavor-defaults or overidden with a new definition by sections or providers lower in the hierarchy than the point at which the final attribute is applied.

True: The flavor may not be updated or overidden.

False: The flavor may be updated or overidden.

allow-override: The flavor may not be updated by flavor-defaults but may be explicitly overidden by redefining it in a new ‘flavor’ entry.

provider[azure].flavor-defaults.generate-password Type: bool: If booting a Windows image, an administrative password is required. If the password is not actually used (e.g., the image has key-based authentication enabled), a random password can be provided by enabling this option. The password is not stored anywhere and is not retrievable.

provider[azure].flavor-defaults.public-ipv4 Default: False Type: bool: Whether a public IPv4 address should be attached to nodes.

provider[azure].flavor-defaults.public-ipv6 Default: False Type: bool: Whether a public IPv6 address should be attached to nodes.

provider[azure].flavor-defaults.userdata Type: str: A string of userdata for a node. Systems such as “cloud-init” may use this to configure the node on boot.

provider[azure].flavor-defaults.volume-size Type: int: The size of the operating system disk, in GiB.

provider[azure].flavors Type: dict

A list of flavors associated with this provider.

provider[azure].flavors.description Type: str: A textual description of the image for reference purposes.

provider[azure].flavors.ephemeral-disk Type: bool: If set to true, Azure will create an ephemeral OS disk instead of a managed disk.

provider[azure].flavors.final Default: False

Whether the configuration of the flavor may be updated by values in flavor-defaults or overidden with a new definition by sections or providers lower in the hierarchy than the point at which the final attribute is applied.

True: The flavor may not be updated or overidden.

False: The flavor may be updated or overidden.

allow-override: The flavor may not be updated by flavor-defaults but may be explicitly overidden by redefining it in a new ‘flavor’ entry.

provider[azure].flavors.generate-password Type: bool: If booting a Windows image, an administrative password is required. If the password is not actually used (e.g., the image has key-based authentication enabled), a random password can be provided by enabling this option. The password is not stored anywhere and is not retrievable.

provider[azure].flavors.ipv4 Default: False Type: bool: Whether to enable IPv4 networking. Defaults to true unless IPv6 is enabled. Enabling this will attach a private IPv4 address.

provider[azure].flavors.ipv6 Default: False Type: bool: Whether to enable IPv6 networking. Enabling this will attach a private IPv6 address.

provider[azure].flavors.name Type: str: The name of the flavor. Used to refer to the flavor in Zuul configuration.

provider[azure].flavors.priority Default: regular

Whether to create regular or spot instances.

regular: A regular instance.

spot: A spot instance.

provider[azure].flavors.public-ipv4 Default: False Type: bool: Whether a public IPv4 address should be attached to nodes.

provider[azure].flavors.public-ipv6 Default: False Type: bool: Whether a public IPv6 address should be attached to nodes.

provider[azure].flavors.userdata Type: str: A string of userdata for a node. Systems such as “cloud-init” may use this to configure the node on boot.

provider[azure].flavors.vm-size Type: str: Size of the VM to use in Azure. See the List of VM sizes for the list of sizes availabile in each region.

provider[azure].flavors.volume-size Type: int: The size of the operating system disk, in GiB.

provider[azure].image-defaults Type: dict

Attributes to be set as default values for any image used with this provider. Many attributes which may be set on an individual image may be set once in this section and used for all the images in this provider. Values set on individual images may still override the values set here.

provider[azure].image-defaults.connection-port Type: int: The port that Zuul should use when connecting to the node. For most nodes this is not necessary. This defaults to 22 when connection-type is ‘ssh’ and 5986 when it is ‘winrm’.

provider[azure].image-defaults.connection-type

The connection type that a consumer should use when connecting to the node.

winrm: A winrm connection.

ssh: An ssh connection.

provider[azure].image-defaults.ephemeral-disk Type: bool: If set to true, Azure will create an ephemeral OS disk instead of a managed disk.

provider[azure].image-defaults.final Default: False

Whether the configuration of the label may be updated by values in label-defaults or overidden with a new definition by sections or providers lower in the hierarchy than the point at which the final attribute is applied.

True: The label may not be updated or overidden.

False: The label may be updated or overidden.

allow-override: The label may not be updated by label-defaults but may be explicitly overidden by redefining it in a new ‘label’ entry.

provider[azure].image-defaults.generate-password Type: bool: If booting a Windows image, an administrative password is required. If the password is not actually used (e.g., the image has key-based authentication enabled), a random password can be provided by enabling this option. The password is not stored anywhere and is not retrievable.

provider[azure].image-defaults.import-timeout Default: 300 Type: int: The limit on the amount of time a successful image import can take.

provider[azure].image-defaults.max-retain-count Type: int

A limit for how many images to keep available. This provides an upper limit for the retain-count attribute; any attempt to set retain-count higher than this value in any images, sections or providers that inherit this value will result in an error.

Once max-retain-count, sections and providers that inherit it may not set it to a larger value, but may further reduce it.

provider[azure].image-defaults.python-path Type: str: The path of the default python interpreter. Used by Zuul to set ansible_python_interpreter. The special value auto will direct Zuul to use inbuilt Ansible logic to select the interpreter.

provider[azure].image-defaults.retain-count Default: 2 Type: int: How many images to keep available. As new images are created, the most recent retain-count validated images will be kept available. Keeping more than one image available allows tenant admins to choose to fall-back on older images in case new images exhibit problems. The most recent (and therefore, in-use) image is included in the count. So a retain-count of 1 means to only keep the current in-use image; a count of 2 means to keep one extra image as a backup.

provider[azure].image-defaults.shell-type Type: str

The shell type of the node’s default shell executable. Used by Zuul to set ansible_shell_type. This setting should only be used

For a windows image with the experimental connection-type ssh in which case cmd or powershell should be set and reflect the node’s DefaultShell configuration.
If the default shell is not Bourne compatible (sh), but instead e.g. csh or fish, and the user is aware that there is a long-standing issue with ansible_shell_type in combination with become.

provider[azure].image-defaults.tags Type: dict: A dictionary of tags to add to uploaded images, and to nodes created from them. Avoid the use of zuul_ as a key prefix since Zuul uses this for internal values.

provider[azure].image-defaults.upload-methods Default: ['copy', 'import', 'upload'] Type: list

An ordered list of methods to use when creating an image in the provider.

copy: Copy the image from another provider if available.

import: Import the image directly from its storage location.

upload: Download the image from its storage location and upload it to the provider.

provider[azure].image-defaults.userdata Type: str: A string of userdata for a node. Systems such as “cloud-init” may use this to configure the node on boot.

provider[azure].image-defaults.username Type: str: The username Zuul should use when connecting to the node.

provider[azure].image-defaults.volume-size Type: int: The size of the operating system disk, in GiB.

provider[azure].images Type: list: A list of images associated with this provider.

provider[azure].images[cloud] Type: dict

These are the attributes available for a cloud image.

provider[azure].images[cloud].community-gallery-image Type: dict

Specifies a community gallery image to use. Either this field, provider[azure].images[cloud].shared-gallery-image, provider[azure].images[cloud].image-reference, provider[azure].images[cloud].image-id, or provider[azure].images[cloud].image-filter must be provided.

provider[azure].images[cloud].community-gallery-image.gallery-name Type: str: The image gallery name.

provider[azure].images[cloud].community-gallery-image.name Type: str: The image name.

provider[azure].images[cloud].community-gallery-image.version Type: str: The image version. Omit to use the latest version.

provider[azure].images[cloud].connection-port Type: int: The port that Zuul should use when connecting to the node. For most nodes this is not necessary. This defaults to 22 when connection-type is ‘ssh’ and 5986 when it is ‘winrm’.

provider[azure].images[cloud].connection-type

The connection type that a consumer should use when connecting to the node.

winrm: A winrm connection.

ssh: An ssh connection.

provider[azure].images[cloud].description Type: str: A textual description of the image for reference purposes.

provider[azure].images[cloud].ephemeral-disk Type: bool: If set to true, Azure will create an ephemeral OS disk instead of a managed disk.

provider[azure].images[cloud].final Default: False

Whether the configuration of the label may be updated by values in label-defaults or overidden with a new definition by sections or providers lower in the hierarchy than the point at which the final attribute is applied.

True: The label may not be updated or overidden.

False: The label may be updated or overidden.

allow-override: The label may not be updated by label-defaults but may be explicitly overidden by redefining it in a new ‘label’ entry.

provider[azure].images[cloud].generate-password Type: bool: If booting a Windows image, an administrative password is required. If the password is not actually used (e.g., the image has key-based authentication enabled), a random password can be provided by enabling this option. The password is not stored anywhere and is not retrievable.

provider[azure].images[cloud].image-filter Type: dict

Specifies a private image to use via filters. Either this field, provider[azure].images[cloud].shared-gallery-image, provider[azure].images[cloud].community-gallery-image, provider[azure].images[cloud].image-reference, or provider[azure].images[cloud].image-id must be provided.

If a filter is provided, Zuul will list all of the images in the provider’s resource group and reduce the list using the supplied filter. All items specified in the filter must match in order for an image to match. If more than one image matches, the images are sorted by name and the last one matches.

The following filters are available:

provider[azure].images[cloud].image-filter.location Type: str: The image location.

provider[azure].images[cloud].image-filter.name Type: str: The image name.

provider[azure].images[cloud].image-filter.tags Type: dict: The image tags.

provider[azure].images[cloud].image-id Type: str: Specifies a private image to use by ID. Either this field, provider[azure].images[cloud].shared-gallery-image, provider[azure].images[cloud].community-gallery-image, provider[azure].images[cloud].image-reference, or provider[azure].images[cloud].image-filter must be provided.

provider[azure].images[cloud].image-reference Type: dict

Specifies a public image to use by reference. Either this field, provider[azure].images[cloud].shared-gallery-image, provider[azure].images[cloud].community-gallery-image, provider[azure].images[cloud].image-id, or provider[azure].images[cloud].image-filter must be provided.

provider[azure].images[cloud].image-reference.offer Type: str: The image offer.

provider[azure].images[cloud].image-reference.publisher Type: str: The image Publisher.

provider[azure].images[cloud].image-reference.sku Type: str: The image SKU.

provider[azure].images[cloud].image-reference.version Type: str: The image version.

provider[azure].images[cloud].import-timeout Default: 300 Type: int: The limit on the amount of time a successful image import can take.

provider[azure].images[cloud].name Type: str: The name of the image. Used to refer to the image in Zuul configuration.

provider[azure].images[cloud].python-path Type: str: The path of the default python interpreter. Used by Zuul to set ansible_python_interpreter. The special value auto will direct Zuul to use inbuilt Ansible logic to select the interpreter.

provider[azure].images[cloud].shared-gallery-image Type: dict

Specifies a shared gallery image to use. Either this field, provider[azure].images[cloud].community-gallery-image, provider[azure].images[cloud].image-reference, provider[azure].images[cloud].image-id, or provider[azure].images[cloud].image-filter must be provided.

provider[azure].images[cloud].shared-gallery-image.gallery-name Type: str: The image gallery name.

provider[azure].images[cloud].shared-gallery-image.name Type: str: The image name.

provider[azure].images[cloud].shared-gallery-image.version Type: str: The image version. Omit to use the latest version.

provider[azure].images[cloud].shell-type Type: str

The shell type of the node’s default shell executable. Used by Zuul to set ansible_shell_type. This setting should only be used

For a windows image with the experimental connection-type ssh in which case cmd or powershell should be set and reflect the node’s DefaultShell configuration.
If the default shell is not Bourne compatible (sh), but instead e.g. csh or fish, and the user is aware that there is a long-standing issue with ansible_shell_type in combination with become.

provider[azure].images[cloud].type

The type of image.

cloud: An existing image available in the cloud.

provider[azure].images[cloud].userdata Type: str: A string of userdata for a node. Systems such as “cloud-init” may use this to configure the node on boot.

provider[azure].images[cloud].username Type: str: The username Zuul should use when connecting to the node.

provider[azure].images[cloud].volume-size Type: int: The size of the operating system disk, in GiB.

provider[azure].images[zuul] Type: dict

These are the attributes available for a Zuul image.

provider[azure].images[zuul].connection-port Type: int: The port that Zuul should use when connecting to the node. For most nodes this is not necessary. This defaults to 22 when connection-type is ‘ssh’ and 5986 when it is ‘winrm’.

provider[azure].images[zuul].connection-type

The connection type that a consumer should use when connecting to the node.

winrm: A winrm connection.

ssh: An ssh connection.

provider[azure].images[zuul].description Type: str: A textual description of the image for reference purposes.

provider[azure].images[zuul].ephemeral-disk Type: bool: If set to true, Azure will create an ephemeral OS disk instead of a managed disk.

provider[azure].images[zuul].final Default: False

Whether the configuration of the label may be updated by values in label-defaults or overidden with a new definition by sections or providers lower in the hierarchy than the point at which the final attribute is applied.

True: The label may not be updated or overidden.

False: The label may be updated or overidden.

allow-override: The label may not be updated by label-defaults but may be explicitly overidden by redefining it in a new ‘label’ entry.

provider[azure].images[zuul].generate-password Type: bool: If booting a Windows image, an administrative password is required. If the password is not actually used (e.g., the image has key-based authentication enabled), a random password can be provided by enabling this option. The password is not stored anywhere and is not retrievable.

provider[azure].images[zuul].import-timeout Default: 300 Type: int: The limit on the amount of time a successful image import can take.

provider[azure].images[zuul].max-retain-count Type: int

A limit for how many images to keep available. This provides an upper limit for the retain-count attribute; any attempt to set retain-count higher than this value in any images, sections or providers that inherit this value will result in an error.

Once max-retain-count, sections and providers that inherit it may not set it to a larger value, but may further reduce it.

provider[azure].images[zuul].name Type: str: The name of the image. Used to refer to the image in Zuul configuration.

provider[azure].images[zuul].python-path Type: str: The path of the default python interpreter. Used by Zuul to set ansible_python_interpreter. The special value auto will direct Zuul to use inbuilt Ansible logic to select the interpreter.

provider[azure].images[zuul].retain-count Default: 2 Type: int: How many images to keep available. As new images are created, the most recent retain-count validated images will be kept available. Keeping more than one image available allows tenant admins to choose to fall-back on older images in case new images exhibit problems. The most recent (and therefore, in-use) image is included in the count. So a retain-count of 1 means to only keep the current in-use image; a count of 2 means to keep one extra image as a backup.

provider[azure].images[zuul].shell-type Type: str

The shell type of the node’s default shell executable. Used by Zuul to set ansible_shell_type. This setting should only be used

For a windows image with the experimental connection-type ssh in which case cmd or powershell should be set and reflect the node’s DefaultShell configuration.
If the default shell is not Bourne compatible (sh), but instead e.g. csh or fish, and the user is aware that there is a long-standing issue with ansible_shell_type in combination with become.

provider[azure].images[zuul].tags Type: dict: A dictionary of tags to add to uploaded images, and to nodes created from them. Avoid the use of zuul_ as a key prefix since Zuul uses this for internal values.

provider[azure].images[zuul].type

The type of image.

zuul: An image managed by Zuul.

provider[azure].images[zuul].upload-methods Default: ['copy', 'import', 'upload'] Type: list

An ordered list of methods to use when creating an image in the provider.

copy: Copy the image from another provider if available.

import: Import the image directly from its storage location.

upload: Download the image from its storage location and upload it to the provider.

provider[azure].images[zuul].userdata Type: str: A string of userdata for a node. Systems such as “cloud-init” may use this to configure the node on boot.

provider[azure].images[zuul].username Type: str: The username Zuul should use when connecting to the node.

provider[azure].images[zuul].volume-size Type: int: The size of the operating system disk, in GiB.

provider[azure].label-defaults Type: dict

Attributes to be set as default values for any label used with this provider. Many attributes which may be set on an individual label may be set once in this section and used for all the labels in this provider. Values set on individual labels may still override the values set here.

provider[azure].label-defaults.aliases Type: str: A list of label aliases to associate with nodes created from this label. These labels may be used to request existing ready nodes that were previously created from this label, but none of their attributes will be used to define characteristics.

provider[azure].label-defaults.boot-timeout Default: 300 Type: int: The time (in seconds) to wait for a node to boot.

provider[azure].label-defaults.ephemeral-disk Type: bool: If set to true, Azure will create an ephemeral OS disk instead of a managed disk.

provider[azure].label-defaults.executor-zone Type: str: Specify that a Zuul executor in the specified zone is used to run jobs with nodes from this label.

provider[azure].label-defaults.final Default: False

Whether the configuration of the label may be updated by values in label-defaults or overidden with a new definition by sections or providers lower in the hierarchy than the point at which the final attribute is applied.

True: The label may not be updated or overidden.

False: The label may be updated or overidden.

allow-override: The label may not be updated by label-defaults but may be explicitly overidden by redefining it in a new ‘label’ entry.

provider[azure].label-defaults.generate-password Type: bool: If booting a Windows image, an administrative password is required. If the password is not actually used (e.g., the image has key-based authentication enabled), a random password can be provided by enabling this option. The password is not stored anywhere and is not retrievable.

provider[azure].label-defaults.host-key-checking Default: True Type: bool: Whether to validate SSH host keys. When true, this helps ensure that nodes are ready to receive SSH connections before they are used. When set to false, Zuul will not attempt to ssh-keyscan nodes after they are booted. Disable this if the zuul-launcher and the nodes it launches are on different networks, where the launcher is unable to reach the nodes directly.

provider[azure].label-defaults.key-data Type: str: The SSH public key that should be installed on the node.

provider[azure].label-defaults.max-age Default: 0 Type: int: The time (in seconds) since creation that a node may be available for use. Ready nodes older than this time will be deleted.

provider[azure].label-defaults.max-ready-age Default: 0 Type: int: The time (in seconds) an unassigned node should stay in ready state.

provider[azure].label-defaults.min-retention-time Default: 0 Type: int

The time (in seconds) since an instance was launched, during which a node will not be deleted. For node resources with minimum billing times, this can be used to ensure that the instance is retained for at least the minimum billing interval.

This setting takes precedence over max-[ready-]age.

provider[azure].label-defaults.reuse Default: False Type: bool: Should the node be reused (True) or deleted (False) after use.

provider[azure].label-defaults.slots Default: 1 Type: int: How many jobs are permitted run on the same node simultaneously.

provider[azure].label-defaults.snapshot-expiration Default: 604800 Type: int: The time (in seconds) until a snapshot expires.

provider[azure].label-defaults.snapshot-timeout Default: 3600 Type: int: The time (in seconds) to wait for a snapshot to complete.

provider[azure].label-defaults.subnet-id Type: str: Specifies the subnet to use by ID.

provider[azure].label-defaults.subnet-reference Type: dict

Specifies the subnet to use by reference

provider[azure].label-defaults.subnet-reference.network Type: str: The name of the subnet’s network.

provider[azure].label-defaults.subnet-reference.resource-group Type: str: The resource group that contains the subnet.

provider[azure].label-defaults.subnet-reference.subnet Default: default Type: str: The name of the subnet.

provider[azure].label-defaults.tags Type: dict: A dictionary of tags to add to nodes. Avoid the use of zuul_ as a key prefix since Zuul uses this for internal values.

provider[azure].label-defaults.user-assigned-identities Type: dict

provider[azure].label-defaults.user-assigned-identities.name Type: str: The name of the identity.

provider[azure].label-defaults.user-assigned-identities.resource-group Type: str: The resource group that contains the identity.

provider[azure].label-defaults.userdata Type: str: A string of userdata for a node. Systems such as “cloud-init” may use this to configure the node on boot.

provider[azure].label-defaults.volume-size Type: int: The size of the operating system disk, in GiB.

provider[azure].labels Type: dict

A list of labels associated with this provider.

provider[azure].labels.aliases Type: str: A list of label aliases to associate with nodes created from this label. These labels may be used to request existing ready nodes that were previously created from this label, but none of their attributes will be used to define characteristics.

provider[azure].labels.boot-timeout Default: 300 Type: int: The time (in seconds) to wait for a node to boot.

provider[azure].labels.description Type: str: A textual description of the label for reference purposes.

provider[azure].labels.ephemeral-disk Type: bool: If set to true, Azure will create an ephemeral OS disk instead of a managed disk.

provider[azure].labels.executor-zone Type: str: Specify that a Zuul executor in the specified zone is used to run jobs with nodes from this label.

provider[azure].labels.final Default: False

Whether the configuration of the label may be updated by values in label-defaults or overidden with a new definition by sections or providers lower in the hierarchy than the point at which the final attribute is applied.

True: The label may not be updated or overidden.

False: The label may be updated or overidden.

allow-override: The label may not be updated by label-defaults but may be explicitly overidden by redefining it in a new ‘label’ entry.

provider[azure].labels.flavor Type: str: The flavor to use with this label.

provider[azure].labels.generate-password Type: bool: If booting a Windows image, an administrative password is required. If the password is not actually used (e.g., the image has key-based authentication enabled), a random password can be provided by enabling this option. The password is not stored anywhere and is not retrievable.

provider[azure].labels.host-key-checking Default: True Type: bool: Whether to validate SSH host keys. When true, this helps ensure that nodes are ready to receive SSH connections before they are used. When set to false, Zuul will not attempt to ssh-keyscan nodes after they are booted. Disable this if the zuul-launcher and the nodes it launches are on different networks, where the launcher is unable to reach the nodes directly.

provider[azure].labels.image Type: str: The image to use with this label.

provider[azure].labels.key-data Type: str: The SSH public key that should be installed on the node.

provider[azure].labels.max-age Default: 0 Type: int: The time (in seconds) since creation that a node may be available for use. Ready nodes older than this time will be deleted.

provider[azure].labels.max-ready-age Default: 0 Type: int: The time (in seconds) an unassigned node should stay in ready state.

provider[azure].labels.min-retention-time Default: 0 Type: int

The time (in seconds) since an instance was launched, during which a node will not be deleted. For node resources with minimum billing times, this can be used to ensure that the instance is retained for at least the minimum billing interval.

This setting takes precedence over max-[ready-]age.

provider[azure].labels.name Type: str: The name of the label. Used to refer to the label in Zuul configuration.

provider[azure].labels.reuse Default: False Type: bool: Should the node be reused (True) or deleted (False) after use.

provider[azure].labels.slots Default: 1 Type: int: How many jobs are permitted run on the same node simultaneously.

provider[azure].labels.snapshot-expiration Default: 604800 Type: int: The time (in seconds) until a snapshot expires.

provider[azure].labels.snapshot-timeout Default: 3600 Type: int: The time (in seconds) to wait for a snapshot to complete.

provider[azure].labels.subnet-id Type: str: Specifies the subnet to use by ID.

provider[azure].labels.subnet-reference Type: dict

Specifies the subnet to use by reference

provider[azure].labels.subnet-reference.network Type: str: The name of the subnet’s network.

provider[azure].labels.subnet-reference.resource-group Type: str: The resource group that contains the subnet.

provider[azure].labels.subnet-reference.subnet Default: default Type: str: The name of the subnet.

provider[azure].labels.tags Type: dict: A dictionary of tags to add to nodes. Avoid the use of zuul_ as a key prefix since Zuul uses this for internal values.

provider[azure].labels.user-assigned-identities Type: dict

provider[azure].labels.user-assigned-identities.name Type: str: The name of the identity.

provider[azure].labels.user-assigned-identities.resource-group Type: str: The resource group that contains the identity.

provider[azure].labels.userdata Type: str: A string of userdata for a node. Systems such as “cloud-init” may use this to configure the node on boot.

provider[azure].labels.volume-size Type: int: The size of the operating system disk, in GiB.

provider[azure].launch-attempts Default: 3 Type: int: The number of times to attempt launching a node before considering the request failed.

provider[azure].launch-timeout Type: int: The time to wait from issuing the command to create a new node until the node is reporting as running. If the timeout is exceeded, the node launch is aborted and the node deleted.

provider[azure].name Type: str: The name of the provider. Used to refer to the provider in Zuul configuration.

provider[azure].parent Type: str: The name of the parent section from which to inherit. This attribute is only used by section objects. To indicate which section a provider should be attached to, use provider[azure].section

provider[azure].region Type: str: Name of the Azure region to use.

provider[azure].resource-group Type: str: Name of the resource group in which to place nodes.

provider[azure].resource-limits Type: dict

Resource limits for this provider. Configure these values to cause Zuul to attempt to limit the resource usage. This can be used to limit Zuul’s usage to a level below the cloud quota.

provider[azure].resource-limits.cores Type: int: The number of cores used by regular instances.

provider[azure].resource-limits.instances Type: int: The number of instances.

provider[azure].resource-limits.lowPriorityCores Type: int: The number of low priority cores (including spot instances).

provider[azure].resource-limits.ram Type: int: The amount of ram, in MiB.

provider[azure].section Type: str: The name of the section from which to inherit.