v1beta1
| Metadata | Value |
|---|---|
| Group | infrastructure.cluster.x-k8s.io |
| Version | |
| Module | sigs.k8s.io/cluster-api-provider-azure/exp/api/v1beta1 |
| Property Optionality |
AzureMachinePool
Used by: AzureMachinePoolList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | AzureMachinePoolSpec | |
| status | AzureMachinePoolStatus |
AzureMachinePoolSpec
| Property | Description | Type |
|---|---|---|
| additionalTags | 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. | infrav1.Tags |
| identity | Identity is the type of identity used for the Virtual Machine Scale Set. 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 | infrav1.VMIdentity |
| location | Location is the Azure region location e.g. westus2 | string |
| orchestrationMode | OrchestrationMode specifies the orchestration mode for the Virtual Machine Scale Set | infrav1.OrchestrationModeType |
| platformFaultDomainCount | PlatformFaultDomainCount specifies the number of fault domains that the Virtual Machine Scale Set can use. The count determines the spreading algorithm of the Azure fault domain. | int32 |
| providerID | ProviderID is the identification ID of the Virtual Machine Scale Set | string |
| providerIDList | 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. | string[] |
| roleAssignmentName | Deprecated: RoleAssignmentName should be set in the systemAssignedIdentityRole field. | string |
| strategy | The deployment strategy to use to replace existing AzureMachinePoolMachines with new ones. | AzureMachinePoolDeploymentStrategy |
| systemAssignedIdentityRole | SystemAssignedIdentityRole defines the role and scope to assign to the system assigned identity. | infrav1.SystemAssignedIdentityRole |
| template | Template contains the details used to build a replica virtual machine within the Machine Pool | AzureMachinePoolMachineTemplate |
| userAssignedIdentities | 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 AzureMachinePool. See https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-cli | infrav1.UserAssignedIdentity[] |
| zoneBalance | ZoneBalane dictates whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. | bool |
AzureMachinePoolStatus
| Property | Description | Type |
|---|---|---|
| conditions | Conditions defines current service state of the AzureMachinePool. | clusterv1.Conditions |
| failureMessage | 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. | string |
| failureReason | 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. | string |
| image | Image is the current image used in the AzureMachinePool. When the spec image is nil, this image is populated with the details of the defaulted Azure Marketplace "capi" offer. | infrav1.Image |
| infrastructureMachineKind | InfrastructureMachineKind is the kind of the infrastructure resources behind MachinePool Machines. | string |
| instances | Instances is the VM instance status for each VM in the VMSS | AzureMachinePoolInstanceStatus[] |
| longRunningOperationStates | LongRunningOperationStates saves the state for Azure long-running operations so they can be continued on the next reconciliation loop. | infrav1.Futures |
| provisioningState | ProvisioningState is the provisioning state of the Azure virtual machine. | infrav1.ProvisioningState |
| ready | Ready is true when the provider resource is ready. | bool |
| replicas | Replicas is the most recently observed number of replicas. | int32 |
| version | Version is the Kubernetes version for the current VMSS model | string |
AzureMachinePoolList
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | AzureMachinePool[] |
AzureMachinePoolMachine
Used by: AzureMachinePoolMachineList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | AzureMachinePoolMachineSpec | |
| status | AzureMachinePoolMachineStatus |
AzureMachinePoolMachineSpec
| Property | Description | Type |
|---|---|---|
| instanceID | InstanceID is the identification of the Machine Instance within the VMSS | string |
| providerID | ProviderID is the identification ID of the Virtual Machine Scale Set | string |
AzureMachinePoolMachineStatus
| Property | Description | Type |
|---|---|---|
| conditions | Conditions defines current service state of the AzureMachinePool. | clusterv1.Conditions |
| failureMessage | 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. 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. | string |
| failureReason | FailureReason will be set in the event that there is a terminal problem reconciling the MachinePool machine and will contain a succinct value suitable for machine interpretation. 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. | string |
| instanceName | InstanceName is the name of the Machine Instance within the VMSS | string |
| latestModelApplied | LatestModelApplied indicates the instance is running the most up-to-date VMSS model. A VMSS model describes the image version the VM is running. If the instance is not running the latest model, it means the instance may not be running the version of Kubernetes the Machine Pool has specified and needs to be updated. | bool |
| longRunningOperationStates | LongRunningOperationStates saves the state for Azure long running operations so they can be continued on the next reconciliation loop. | infrav1.Futures |
| nodeRef | NodeRef will point to the corresponding Node if it exists. | corev1.ObjectReference |
| provisioningState | ProvisioningState is the provisioning state of the Azure virtual machine instance. | infrav1.ProvisioningState |
| ready | Ready is true when the provider resource is ready. | bool |
| version | Version defines the Kubernetes version for the VM Instance | string |
AzureMachinePoolMachineList
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | AzureMachinePoolMachine[] |
azureMachinePoolWebhook
azureMachinePoolWebhook implements a validating and defaulting webhook for AzureMachinePool.
| Property | Description | Type |
|---|---|---|
| Client | client.Client |
mockClient
| Property | Description | Type |
|---|---|---|
| client.Client | ||
| ReturnError | bool | |
| Version | string |
mockDefaultClient
| Property | Description | Type |
|---|---|---|
| client.Client | ||
| ClusterName | string | |
| Name | string | |
| ReturnError | bool | |
| SubscriptionID | string | |
| Version | string |
AzureMachinePoolMachineSpec
Used by: AzureMachinePoolMachine.
| Property | Description | Type |
|---|---|---|
| instanceID | InstanceID is the identification of the Machine Instance within the VMSS | string |
| providerID | ProviderID is the identification ID of the Virtual Machine Scale Set | string |
AzureMachinePoolMachineStatus
Used by: AzureMachinePoolMachine.
| Property | Description | Type |
|---|---|---|
| conditions | Conditions defines current service state of the AzureMachinePool. | clusterv1.Conditions |
| failureMessage | 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. 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. | string |
| failureReason | FailureReason will be set in the event that there is a terminal problem reconciling the MachinePool machine and will contain a succinct value suitable for machine interpretation. 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. | string |
| instanceName | InstanceName is the name of the Machine Instance within the VMSS | string |
| latestModelApplied | LatestModelApplied indicates the instance is running the most up-to-date VMSS model. A VMSS model describes the image version the VM is running. If the instance is not running the latest model, it means the instance may not be running the version of Kubernetes the Machine Pool has specified and needs to be updated. | bool |
| longRunningOperationStates | LongRunningOperationStates saves the state for Azure long running operations so they can be continued on the next reconciliation loop. | infrav1.Futures |
| nodeRef | NodeRef will point to the corresponding Node if it exists. | corev1.ObjectReference |
| provisioningState | ProvisioningState is the provisioning state of the Azure virtual machine instance. | infrav1.ProvisioningState |
| ready | Ready is true when the provider resource is ready. | bool |
| version | Version defines the Kubernetes version for the VM Instance | string |
AzureMachinePoolSpec
Used by: AzureMachinePool.
| Property | Description | Type |
|---|---|---|
| additionalTags | 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. | infrav1.Tags |
| identity | Identity is the type of identity used for the Virtual Machine Scale Set. 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 | infrav1.VMIdentity |
| location | Location is the Azure region location e.g. westus2 | string |
| orchestrationMode | OrchestrationMode specifies the orchestration mode for the Virtual Machine Scale Set | infrav1.OrchestrationModeType |
| platformFaultDomainCount | PlatformFaultDomainCount specifies the number of fault domains that the Virtual Machine Scale Set can use. The count determines the spreading algorithm of the Azure fault domain. | int32 |
| providerID | ProviderID is the identification ID of the Virtual Machine Scale Set | string |
| providerIDList | 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. | string[] |
| roleAssignmentName | Deprecated: RoleAssignmentName should be set in the systemAssignedIdentityRole field. | string |
| strategy | The deployment strategy to use to replace existing AzureMachinePoolMachines with new ones. | AzureMachinePoolDeploymentStrategy |
| systemAssignedIdentityRole | SystemAssignedIdentityRole defines the role and scope to assign to the system assigned identity. | infrav1.SystemAssignedIdentityRole |
| template | Template contains the details used to build a replica virtual machine within the Machine Pool | AzureMachinePoolMachineTemplate |
| userAssignedIdentities | 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 AzureMachinePool. See https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-cli | infrav1.UserAssignedIdentity[] |
| zoneBalance | ZoneBalane dictates whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. | bool |
AzureMachinePoolStatus
Used by: AzureMachinePool.
| Property | Description | Type |
|---|---|---|
| conditions | Conditions defines current service state of the AzureMachinePool. | clusterv1.Conditions |
| failureMessage | 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. | string |
| failureReason | 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. | string |
| image | Image is the current image used in the AzureMachinePool. When the spec image is nil, this image is populated with the details of the defaulted Azure Marketplace "capi" offer. | infrav1.Image |
| infrastructureMachineKind | InfrastructureMachineKind is the kind of the infrastructure resources behind MachinePool Machines. | string |
| instances | Instances is the VM instance status for each VM in the VMSS | AzureMachinePoolInstanceStatus[] |
| longRunningOperationStates | LongRunningOperationStates saves the state for Azure long-running operations so they can be continued on the next reconciliation loop. | infrav1.Futures |
| provisioningState | ProvisioningState is the provisioning state of the Azure virtual machine. | infrav1.ProvisioningState |
| ready | Ready is true when the provider resource is ready. | bool |
| replicas | Replicas is the most recently observed number of replicas. | int32 |
| version | Version is the Kubernetes version for the current VMSS model | string |
AzureMachinePoolDeploymentStrategy
Used by: AzureMachinePoolSpec.
| Property | Description | Type |
|---|---|---|
| rollingUpdate | Rolling update config params. Present only if MachineDeploymentStrategyType = RollingUpdate. | MachineRollingUpdateDeployment |
| type | Type of deployment. Currently the only supported strategy is RollingUpdate | AzureMachinePoolDeploymentStrategyType |
AzureMachinePoolInstanceStatus
Used by: AzureMachinePoolStatus.
| Property | Description | Type |
|---|---|---|
| instanceID | InstanceID is the identification of the Machine Instance within the VMSS | string |
| instanceName | InstanceName is the name of the Machine Instance within the VMSS | string |
| latestModelApplied | LatestModelApplied indicates the instance is running the most up-to-date VMSS model. A VMSS model describes the image version the VM is running. If the instance is not running the latest model, it means the instance may not be running the version of Kubernetes the Machine Pool has specified and needs to be updated. | bool |
| providerID | ProviderID is the provider identification of the VMSS Instance | string |
| provisioningState | ProvisioningState is the provisioning state of the Azure virtual machine instance. | infrav1.ProvisioningState |
| version | Version defines the Kubernetes version for the VM Instance | string |
AzureMachinePoolMachineTemplate
Used by: AzureMachinePoolSpec.
| Property | Description | Type |
|---|---|---|
| acceleratedNetworking | Deprecated: AcceleratedNetworking should be set in the networkInterfaces field. | bool |
| additionalCapabilities | AdditionalCapabilities specifies additional capabilities enabled or disabled on the virtual machine. | infrav1.AdditionalCapabilities |
| dataDisks | DataDisks specifies the list of data disks to be created for a Virtual Machine | infrav1.DataDisk[] |
| diagnostics | Diagnostics specifies the diagnostics settings for a virtual machine. If not specified then Boot diagnostics (Managed) will be enabled. | infrav1.Diagnostics |
| image | 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. | infrav1.Image |
| networkInterfaces | NetworkInterfaces specifies a list of network interface configurations. If left unspecified, the VM will get a single network interface with a single IPConfig in the subnet specified in the cluster's node subnet field. The primary interface will be the first networkInterface specified (index 0) in the list. | infrav1.NetworkInterface[] |
| osDisk | OSDisk contains the operating system disk information for a Virtual Machine | infrav1.OSDisk |
| securityProfile | SecurityProfile specifies the Security profile settings for a virtual machine. | infrav1.SecurityProfile |
| spotVMOptions | SpotVMOptions allows the ability to specify the Machine should use a Spot VM | infrav1.SpotVMOptions |
| sshPublicKey | SSHPublicKey is the SSH public key string, base64-encoded to add to a Virtual Machine. Linux only. Refer to documentation on how to set up SSH access on Windows instances. | string |
| subnetName | Deprecated: SubnetName should be set in the networkInterfaces field. | string |
| terminateNotificationTimeout | TerminateNotificationTimeout enables or disables VMSS scheduled events termination notification with specified timeout allowed values are between 5 and 15 (mins) | int |
| vmExtensions | VMExtensions specifies a list of extensions to be added to the scale set. | infrav1.VMExtension[] |
| vmSize | VMSize is the size of the Virtual Machine to build. See https://learn.microsoft.com/rest/api/compute/virtualmachines/createorupdate#virtualmachinesizetypes | string |
AzureMachinePoolDeploymentStrategyType
Used by: AzureMachinePoolDeploymentStrategy.
MachineRollingUpdateDeployment
Used by: AzureMachinePoolDeploymentStrategy.
| Property | Description | Type |
|---|---|---|
| deletePolicy | DeletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling. Valid values are "Random, "Newest", "Oldest" When no value is supplied, the default is Oldest | AzureMachinePoolDeletePolicyType |
| maxSurge | The maximum number of machines that can be scheduled above the desired number of machines. Value can be an absolute number (ex: 5) or a percentage of desired machines (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 1. Example: when this is set to 30%, the new MachineSet can be scaled up immediately when the rolling update starts, such that the total number of old and new machines do not exceed 130% of desired machines. Once old machines have been killed, new MachineSet can be scaled up further, ensuring that total number of machines running at any time during the update is at most 130% of desired machines. | intstr.IntOrString |
| maxUnavailable | The maximum number of machines that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired machines (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 0. Example: when this is set to 30%, the old MachineSet can be scaled down to 70% of desired machines immediately when the rolling update starts. Once new machines are ready, old MachineSet can be scaled down further, followed by scaling up the new MachineSet, ensuring that the total number of machines available at all times during the update is at least 70% of desired machines. | intstr.IntOrString |
AzureMachinePoolDeletePolicyType
Used by: MachineRollingUpdateDeployment.