Last generated October 19, 2020

AzureMachinePool

AzureMachinePool is the Schema for the azuremachinepools API

Full name:
azuremachinepools.exp.infrastructure.cluster.x-k8s.io
Group:
exp.infrastructure.cluster.x-k8s.io
Singular name:
azuremachinepool
Plural name:
azuremachinepools
Scope:
Namespaced
Versions:
v1alpha3

Version v1alpha3

Properties

.apiVersion

string

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

string

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

.metadata

object

.spec

object

AzureMachinePoolSpec defines the desired state of AzureMachinePool

.spec.additionalTags

object

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.

.spec.location

string Required

Location is the Azure region location e.g. westus2

.spec.providerID

string

ProviderID is the identification ID of the Virtual Machine Scale Set

.spec.providerIDList

array

ProviderIDList are the identification IDs of machine instances provided by the provider. This field must match the provider IDs as seen on the node objects corresponding to a machine pool’s machine instances.

.spec.providerIDList[*]

string

.spec.template

object Required

Template contains the details used to build a replica virtual machine within the Machine Pool

.spec.template.acceleratedNetworking

boolean

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.

.spec.template.dataDisks

array

DataDisks specifies the list of data disks to be created for a Virtual Machine

.spec.template.dataDisks[*]

object

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

.spec.template.dataDisks[*].cachingType

string

.spec.template.dataDisks[*].diskSizeGB

integer Required

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

.spec.template.dataDisks[*].lun

integer

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.

.spec.template.dataDisks[*].nameSuffix

string Required

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

.spec.template.image

object

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

.spec.template.image.id

string

ID specifies an image to use by ID

.spec.template.image.marketplace

object

Marketplace specifies an image to use from the Azure Marketplace

.spec.template.image.marketplace.offer

string Required

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

.spec.template.image.marketplace.publisher

string Required

Publisher is the name of the organization that created the image

.spec.template.image.marketplace.sku

string Required

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

.spec.template.image.marketplace.thirdPartyImage

boolean

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

.spec.template.image.marketplace.version

string Required

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.

.spec.template.image.sharedGallery

object

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

.spec.template.image.sharedGallery.gallery

string Required

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

.spec.template.image.sharedGallery.name

string Required

Name is the name of the image

.spec.template.image.sharedGallery.resourceGroup

string Required

ResourceGroup specifies the resource group containing the shared image gallery

.spec.template.image.sharedGallery.subscriptionID

string Required

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

.spec.template.image.sharedGallery.version

string Required

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.

.spec.template.osDisk

object Required

OSDisk contains the operating system disk information for a Virtual Machine

.spec.template.osDisk.cachingType

string

.spec.template.osDisk.diffDiskSettings

object

DiffDiskSettings describe ephemeral disk settings for the os disk.

.spec.template.osDisk.diffDiskSettings.option

string Required

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

.spec.template.osDisk.diskSizeGB

integer Required

.spec.template.osDisk.managedDisk

object Required

ManagedDisk defines the managed disk options for a VM.

.spec.template.osDisk.managedDisk.storageAccountType

string Required

.spec.template.osDisk.osType

string Required

.spec.template.sshPublicKey

string Required

SSHPublicKey is the SSH public key string base64 encoded to add to a Virtual Machine

.spec.template.terminateNotificationTimeout

integer

TerminateNotificationTimeout enables or disables VMSS scheduled events termination notification with specified timeout allowed values are between 5 and 15 (mins)

.spec.template.vmSize

string Required

.status

object

AzureMachinePoolStatus defines the observed state of AzureMachinePool

.status.conditions

array

Conditions defines current service state of the AzureMachinePool.

.status.conditions[*]

object

Condition defines an observation of a Cluster API resource operational state.

.status.conditions[*].lastTransitionTime

string

Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

.status.conditions[*].message

string

A human readable message indicating details about the transition. This field may be empty.

.status.conditions[*].reason

string

The reason for the condition’s last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.

.status.conditions[*].severity

string

Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.

.status.conditions[*].status

string Required

Status of the condition, one of True, False, Unknown.

.status.conditions[*].type

string Required

Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

.status.failureMessage

string

FailureMessage will be set in the event that there is a terminal problem reconciling the MachinePool and will contain a more verbose string suitable for logging and human consumption. This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the MachinePool’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured. Any transient errors that occur during the reconciliation of MachinePools can be added as events to the MachinePool object and/or logged in the controller’s output.

.status.failureReason

string

FailureReason will be set in the event that there is a terminal problem reconciling the MachinePool and will contain a succinct value suitable for machine interpretation. This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the MachinePool’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured. Any transient errors that occur during the reconciliation of MachinePools can be added as events to the MachinePool object and/or logged in the controller’s output.

.status.provisioningState

string

ProvisioningState is the provisioning state of the Azure virtual machine.

.status.ready

boolean

Ready is true when the provider resource is ready.

.status.replicas

integer

Replicas is the most recently observed number of replicas.


This documentation page shows information based on apiextensions v3.2.0.