AzureMachineTemplate

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

AzureMachineTemplateSpec defines the desired state of AzureMachineTemplate.

AzureMachineTemplateResource describes the data needed to create an AzureMachine from a template.

Spec is the specification of the desired behavior of the machine.

AcceleratedNetworking enables or disables Azure accelerated networking. If omitted, it will be set based on whether the requested VMSize supports accelerated networking. If AcceleratedNetworking is set to true with a VMSize that does not support it, Azure will return an error.

AdditionalTags is an optional set of tags to add to an instance, in addition to the ones added by default by the Azure provider. If both the AzureCluster and the AzureMachine specify the same tag name with different values, the AzureMachine’s value takes precedence.

AllocatePublicIP allows the ability to create dynamic public ips for machines where this value is true.

DEPRECATED: use FailureDomain instead

DataDisk specifies the parameters that are used to add one or more data disks to the machine

DataDisk specifies the parameters that are used to add one or more data disks to the machine.

DiskSizeGB is the size in GB to assign to the data disk.

Lun Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. The value must be between 0 and 63.

ManagedDisk defines the managed disk options for a VM.

DiskEncryptionSetParameters defines disk encryption options.

ID defines resourceID for diskEncryptionSet resource. It must be in the same subscription

NameSuffix is the suffix to be appended to the machine name to generate the disk name. Each disk name will be in format _.

EnableIPForwarding enables IP Forwarding in Azure which is required for some CNI’s to send traffic from a pods on one machine to another. This is required for IpV6 with Calico in combination with User Defined Routes (set by the Azure Cloud Controller manager). Default is false for disabled.

FailureDomain is the failure domain unique identifier this Machine should be attached to, as defined in Cluster API. This relates to an Azure Availability Zone

Identity is the type of identity used for the virtual machine. The type ‘SystemAssigned’ is an implicitly created identity. The generated identity will be assigned a Subscription contributor role. The type ‘UserAssigned’ is a standalone Azure resource provided by the user and assigned to the VM

Image is used to provide details of an image to use during VM creation. If image details are omitted the image will default the Azure Marketplace “capi” offer, which is based on Ubuntu.

ID specifies an image to use by ID

Marketplace specifies an image to use from the Azure Marketplace

Offer specifies the name of a group of related images created by the publisher. For example, UbuntuServer, WindowsServer

Publisher is the name of the organization that created the image

SKU specifies an instance of an offer, such as a major release of a distribution. For example, 18.04-LTS, 2019-Datacenter

ThirdPartyImage indicates the image is published by a third party publisher and a Plan will be generated for it.

Version specifies the version of an image sku. The allowed formats are Major.Minor.Build or ‘latest’. Major, Minor, and Build are decimal numbers. Specify ‘latest’ to use the latest version of an image available at deploy time. Even if you use ‘latest’, the VM image will not automatically update after deploy time even if a new version becomes available.

SharedGallery specifies an image to use from an Azure Shared Image Gallery

Gallery specifies the name of the shared image gallery that contains the image

Name is the name of the image

ResourceGroup specifies the resource group containing the shared image gallery

SubscriptionID is the identifier of the subscription that contains the shared image gallery

Version specifies the version of the marketplace image. The allowed formats are Major.Minor.Build or ‘latest’. Major, Minor, and Build are decimal numbers. Specify ‘latest’ to use the latest version of an image available at deploy time. Even if you use ‘latest’, the VM image will not automatically update after deploy time even if a new version becomes available.

DEPRECATED: to support old clients, will be removed in v1alpha4/v1beta1

OSDisk specifies the parameters for the operating system disk of the machine

DiffDiskSettings describe ephemeral disk settings for the os disk.

Option enables ephemeral OS when set to “Local” See https://docs.microsoft.com/en-us/azure/virtual-machines/ephemeral-os-disks for full details

ManagedDisk defines the managed disk options for a VM.

DiskEncryptionSetParameters defines disk encryption options.

ID defines resourceID for diskEncryptionSet resource. It must be in the same subscription

ProviderID is the unique identifier as specified by the cloud provider.

RoleAssignmentName is the name of the role assignment to create for a system assigned identity. It can be any valid GUID. If not specified, a random GUID will be generated.

SecurityProfile specifies the Security profile settings for a virtual machine.

This field indicates whether Host Encryption should be enabled or disabled for a virtual machine or virtual machine scale set. Default is disabled.

SpotVMOptions allows the ability to specify the Machine should use a Spot VM.

MaxPrice defines the maximum price the user is willing to pay for Spot VM instances

UserAssignedIdentities is a list of standalone Azure identities provided by the user The lifecycle of a user-assigned identity is managed separately from the lifecycle of the AzureMachine. See https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-cli

UserAssignedIdentity defines the user-assigned identities provided by the user to be assigned to Azure resources.

ProviderID is the identification ID of the user-assigned Identity, the format of an identity is: ‘azure:///subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

AzureMachineTemplateSpec defines the desired state of AzureMachineTemplate.

AzureMachineTemplateResource describes the data needed to create an AzureMachine from a template.

Spec is the specification of the desired behavior of the machine.

AcceleratedNetworking enables or disables Azure accelerated networking. If omitted, it will be set based on whether the requested VMSize supports accelerated networking. If AcceleratedNetworking is set to true with a VMSize that does not support it, Azure will return an error.

AdditionalTags is an optional set of tags to add to an instance, in addition to the ones added by default by the Azure provider. If both the AzureCluster and the AzureMachine specify the same tag name with different values, the AzureMachine’s value takes precedence.

AllocatePublicIP allows the ability to create dynamic public ips for machines where this value is true.

DataDisk specifies the parameters that are used to add one or more data disks to the machine

DataDisk specifies the parameters that are used to add one or more data disks to the machine.

CachingType specifies the caching requirements.

DiskSizeGB is the size in GB to assign to the data disk.

Lun Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. The value must be between 0 and 63.

ManagedDisk specifies the Managed Disk parameters for the data disk.

DiskEncryptionSetParameters defines disk encryption options.

ID defines resourceID for diskEncryptionSet resource. It must be in the same subscription

NameSuffix is the suffix to be appended to the machine name to generate the disk name. Each disk name will be in format _.

EnableIPForwarding enables IP Forwarding in Azure which is required for some CNI’s to send traffic from a pods on one machine to another. This is required for IpV6 with Calico in combination with User Defined Routes (set by the Azure Cloud Controller manager). Default is false for disabled.

FailureDomain is the failure domain unique identifier this Machine should be attached to, as defined in Cluster API. This relates to an Azure Availability Zone

Identity is the type of identity used for the virtual machine. The type ‘SystemAssigned’ is an implicitly created identity. The generated identity will be assigned a Subscription contributor role. The type ‘UserAssigned’ is a standalone Azure resource provided by the user and assigned to the VM

Image is used to provide details of an image to use during VM creation. If image details are omitted the image will default the Azure Marketplace “capi” offer, which is based on Ubuntu.

ID specifies an image to use by ID

Marketplace specifies an image to use from the Azure Marketplace

Offer specifies the name of a group of related images created by the publisher. For example, UbuntuServer, WindowsServer

Publisher is the name of the organization that created the image

SKU specifies an instance of an offer, such as a major release of a distribution. For example, 18.04-LTS, 2019-Datacenter

ThirdPartyImage indicates the image is published by a third party publisher and a Plan will be generated for it.

Version specifies the version of an image sku. The allowed formats are Major.Minor.Build or ‘latest’. Major, Minor, and Build are decimal numbers. Specify ‘latest’ to use the latest version of an image available at deploy time. Even if you use ‘latest’, the VM image will not automatically update after deploy time even if a new version becomes available.

SharedGallery specifies an image to use from an Azure Shared Image Gallery

Gallery specifies the name of the shared image gallery that contains the image

Name is the name of the image

Offer specifies the name of a group of related images created by the publisher. For example, UbuntuServer, WindowsServer This value will be used to add a Plan in the API request when creating the VM/VMSS resource. This is needed when the source image from which this SIG image was built requires the Plan to be used.

Publisher is the name of the organization that created the image. This value will be used to add a Plan in the API request when creating the VM/VMSS resource. This is needed when the source image from which this SIG image was built requires the Plan to be used.

ResourceGroup specifies the resource group containing the shared image gallery

SKU specifies an instance of an offer, such as a major release of a distribution. For example, 18.04-LTS, 2019-Datacenter This value will be used to add a Plan in the API request when creating the VM/VMSS resource. This is needed when the source image from which this SIG image was built requires the Plan to be used.

SubscriptionID is the identifier of the subscription that contains the shared image gallery

Version specifies the version of the marketplace image. The allowed formats are Major.Minor.Build or ‘latest’. Major, Minor, and Build are decimal numbers. Specify ‘latest’ to use the latest version of an image available at deploy time. Even if you use ‘latest’, the VM image will not automatically update after deploy time even if a new version becomes available.

OSDisk specifies the parameters for the operating system disk of the machine

CachingType specifies the caching requirements.

DiffDiskSettings describe ephemeral disk settings for the os disk.

Option enables ephemeral OS when set to “Local” See https://docs.microsoft.com/en-us/azure/virtual-machines/ephemeral-os-disks for full details

DiskSizeGB is the size in GB to assign to the OS disk. Will have a default of 30GB if not provided

ManagedDisk specifies the Managed Disk parameters for the OS disk.

DiskEncryptionSetParameters defines disk encryption options.

ID defines resourceID for diskEncryptionSet resource. It must be in the same subscription

ProviderID is the unique identifier as specified by the cloud provider.

RoleAssignmentName is the name of the role assignment to create for a system assigned identity. It can be any valid GUID. If not specified, a random GUID will be generated.

SecurityProfile specifies the Security profile settings for a virtual machine.

This field indicates whether Host Encryption should be enabled or disabled for a virtual machine or virtual machine scale set. Default is disabled.

SpotVMOptions allows the ability to specify the Machine should use a Spot VM

MaxPrice defines the maximum price the user is willing to pay for Spot VM instances

SubnetName selects the Subnet where the VM will be placed

UserAssignedIdentities is a list of standalone Azure identities provided by the user The lifecycle of a user-assigned identity is managed separately from the lifecycle of the AzureMachine. See https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-cli

UserAssignedIdentity defines the user-assigned identities provided by the user to be assigned to Azure resources.

ProviderID is the identification ID of the user-assigned Identity, the format of an identity is: ‘azure:///subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

AzureMachineTemplateSpec defines the desired state of AzureMachineTemplate.

AzureMachineTemplateResource describes the data needed to create an AzureMachine from a template.

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. This is a copy of customizable fields from metav1.ObjectMeta. ObjectMeta is embedded in Machine.Spec, MachineDeployment.Template and MachineSet.Template, which are not top-level Kubernetes objects. Given that metav1.ObjectMeta has lots of special cases and read-only fields which end up in the generated CRD validation, having it as a subset simplifies the API and some issues that can impact user experience. During the upgrade to controller-tools@v2 for v1alpha2, we noticed a failure would occur running Cluster API test suite against the new CRDs, specifically spec.metadata.creationTimestamp in body must be of type string: "null". The investigation showed that controller-tools@v2 behaves differently than its previous version when handling types from metav1 package. In more details, we found that embedded (non-top level) types that embedded metav1.ObjectMeta had validation properties, including for creationTimestamp (metav1.Time). The metav1.Time type specifies a custom json marshaller that, when IsZero() is true, returns null which breaks validation because the field isn’t marked as nullable. In future versions, controller-tools@v2 might allow overriding the type and validation for embedded types. When that happens, this hack should be revisited.

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

Spec is the specification of the desired behavior of the machine.

AcceleratedNetworking enables or disables Azure accelerated networking. If omitted, it will be set based on whether the requested VMSize supports accelerated networking. If AcceleratedNetworking is set to true with a VMSize that does not support it, Azure will return an error.

AdditionalTags is an optional set of tags to add to an instance, in addition to the ones added by default by the Azure provider. If both the AzureCluster and the AzureMachine specify the same tag name with different values, the AzureMachine’s value takes precedence.

AllocatePublicIP allows the ability to create dynamic public ips for machines where this value is true.

DataDisk specifies the parameters that are used to add one or more data disks to the machine

DataDisk specifies the parameters that are used to add one or more data disks to the machine.

CachingType specifies the caching requirements.

DiskSizeGB is the size in GB to assign to the data disk.

Lun Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. The value must be between 0 and 63.

ManagedDisk specifies the Managed Disk parameters for the data disk.

DiskEncryptionSetParameters defines disk encryption options.

ID defines resourceID for diskEncryptionSet resource. It must be in the same subscription

NameSuffix is the suffix to be appended to the machine name to generate the disk name. Each disk name will be in format _.

EnableIPForwarding enables IP Forwarding in Azure which is required for some CNI’s to send traffic from a pods on one machine to another. This is required for IpV6 with Calico in combination with User Defined Routes (set by the Azure Cloud Controller manager). Default is false for disabled.

FailureDomain is the failure domain unique identifier this Machine should be attached to, as defined in Cluster API. This relates to an Azure Availability Zone

Identity is the type of identity used for the virtual machine. The type ‘SystemAssigned’ is an implicitly created identity. The generated identity will be assigned a Subscription contributor role. The type ‘UserAssigned’ is a standalone Azure resource provided by the user and assigned to the VM

Image is used to provide details of an image to use during VM creation. If image details are omitted the image will default the Azure Marketplace “capi” offer, which is based on Ubuntu.

ID specifies an image to use by ID

Marketplace specifies an image to use from the Azure Marketplace

Offer specifies the name of a group of related images created by the publisher. For example, UbuntuServer, WindowsServer

Publisher is the name of the organization that created the image

SKU specifies an instance of an offer, such as a major release of a distribution. For example, 18.04-LTS, 2019-Datacenter

ThirdPartyImage indicates the image is published by a third party publisher and a Plan will be generated for it.

Version specifies the version of an image sku. The allowed formats are Major.Minor.Build or ‘latest’. Major, Minor, and Build are decimal numbers. Specify ‘latest’ to use the latest version of an image available at deploy time. Even if you use ‘latest’, the VM image will not automatically update after deploy time even if a new version becomes available.

SharedGallery specifies an image to use from an Azure Shared Image Gallery

Gallery specifies the name of the shared image gallery that contains the image

Name is the name of the image

Offer specifies the name of a group of related images created by the publisher. For example, UbuntuServer, WindowsServer This value will be used to add a Plan in the API request when creating the VM/VMSS resource. This is needed when the source image from which this SIG image was built requires the Plan to be used.

Publisher is the name of the organization that created the image. This value will be used to add a Plan in the API request when creating the VM/VMSS resource. This is needed when the source image from which this SIG image was built requires the Plan to be used.

ResourceGroup specifies the resource group containing the shared image gallery

SKU specifies an instance of an offer, such as a major release of a distribution. For example, 18.04-LTS, 2019-Datacenter This value will be used to add a Plan in the API request when creating the VM/VMSS resource. This is needed when the source image from which this SIG image was built requires the Plan to be used.

SubscriptionID is the identifier of the subscription that contains the shared image gallery

Version specifies the version of the marketplace image. The allowed formats are Major.Minor.Build or ‘latest’. Major, Minor, and Build are decimal numbers. Specify ‘latest’ to use the latest version of an image available at deploy time. Even if you use ‘latest’, the VM image will not automatically update after deploy time even if a new version becomes available.

OSDisk specifies the parameters for the operating system disk of the machine

CachingType specifies the caching requirements.

DiffDiskSettings describe ephemeral disk settings for the os disk.

Option enables ephemeral OS when set to “Local” See https://docs.microsoft.com/en-us/azure/virtual-machines/ephemeral-os-disks for full details

DiskSizeGB is the size in GB to assign to the OS disk. Will have a default of 30GB if not provided

ManagedDisk specifies the Managed Disk parameters for the OS disk.

DiskEncryptionSetParameters defines disk encryption options.

ID defines resourceID for diskEncryptionSet resource. It must be in the same subscription

ProviderID is the unique identifier as specified by the cloud provider.

RoleAssignmentName is the name of the role assignment to create for a system assigned identity. It can be any valid GUID. If not specified, a random GUID will be generated.

SecurityProfile specifies the Security profile settings for a virtual machine.

This field indicates whether Host Encryption should be enabled or disabled for a virtual machine or virtual machine scale set. Default is disabled.

SpotVMOptions allows the ability to specify the Machine should use a Spot VM

MaxPrice defines the maximum price the user is willing to pay for Spot VM instances

SubnetName selects the Subnet where the VM will be placed

UserAssignedIdentities is a list of standalone Azure identities provided by the user The lifecycle of a user-assigned identity is managed separately from the lifecycle of the AzureMachine. See https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-cli

UserAssignedIdentity defines the user-assigned identities provided by the user to be assigned to Azure resources.

ProviderID is the identification ID of the user-assigned Identity, the format of an identity is: ‘azure:///subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’