azure_rm_aksagentpool

Manage node pools in Kubernetes kubernetes cluster

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_aksagentpool

Synopsis

Manage node pools in Kubernetes kubernetes cluster

Parameters

Name	Type	Required	Default	Description
ad_user	string			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url	string			Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile	string		`latest`	Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack.
append_tags	bool		`true`	Use to control if tags field is canonical or just appends to existing tags.
When canonical, any tags not found in the tags parameter will be removed from the object’s metadata.
auth_source	string		`auto`	Controls the source of the credentials to use for authentication.
Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli).
When set to C(env), the credentials will be read from the environment variables.
When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.
When set to C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.
The C(msi) was added in Ansible 2.6.
availability_zones	list			Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType.
capacity_reservation_group_id	string			The Capacity Reservation Group ID.
cert_validation_mode	string			Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable.
client_id	string			Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).
Can also be set via the C(AZURE_CLIENT_ID) environment variable.
cloud_environment	string		`AzureCloud`	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
cluster_name	string	yes		The name of the kubernetes cluster.
count	int			Number of agents (VMs) to host docker containers.
disable_instance_discovery	bool		`false`	Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to True, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy.
Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable.
enable_auto_scaling	bool			Whether to enable auto-scaler.
enable_encryption_at_host	bool			This is only supported on certain VM sizes and in certain Azure regions.
enable_fips	bool			Whether enable FIPS node pool.
enable_node_public_ip	bool			Some scenarios may require nodes in a node pool to receive theirown dedicated public IP addresses.
A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops.
enable_ultra_ssd	bool			Whether to enable UltraSSD.
gpu_instance_profile	string			GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
host_group_id	string			The Host Group ID.
Sample as C(/subscriptions/{subscriptionId}/resourceGroups/{RG_Name}/providers/Microsoft.Compute/hostGroups/{hostGroupName)
kubelet_config	dict			The Kubelet configuration on the agent pool nodes.
kubelet_disk_type	string			Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.
linux_os_config	dict			The OS configuration of Linux agent nodes.
log_mode	string			Parent argument.
log_path	string			Parent argument.
max_count	int			Maximum number of nodes for auto-scaling.
max_pods	int			Maximum number of pods that can run on a node.
min_count	int			Minimum number of nodes for auto-scaling.
mode	string			AgentPoolMode represents mode of an agent pool.
name	string	yes		The name of the node agent pool.
network_profile	dict			Network-related settings of an agent pool.
node_labels	dict			Agent pool node labels to be persisted across all nodes in agent pool.
node_public_ip_prefix_id	string			The Azure Public IP prefix’s ID.
node_taints	list			The taints added to new nodes during node pool create and scale.
For example as example, value:NoSchedule'.
oidc_token	string			Direct OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
This token is exchanged with Azure AD using OIDC federated identity.
Useful in CI systems (for example GitHub Actions, Azure DevOps) where an OIDC token is provided directly by the platform.
Can also be set via the C(AZURE_FEDERATED_TOKEN) environment variable.
oidc_token_file_path	string			Path to a file containing an OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
The file must contain only raw token.
This method is commonly used in platforms that materialize OIDC tokens as files
Can also be set via the C(AZURE_FEDERATED_TOKEN_FILE) environment variable.
orchestrator_version	string			Version of orchestrator specified when creating the managed cluster.
os_disk_size_gb	int			OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool.
os_disk_type	string			The default is C(Ephemeral) if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB.
Otherwise, defaults to C(Managed).
May not be changed after creation.
os_sku	string			Specifies an OS SKU.
This value must not be specified if OSType is Windows.
The I(os_sku=CBLMariner) deprecated. Microsoft recommends that new deployments choose ‘AzureLinux’ instead.
os_type	string			OsType to be used to specify os type.
password	string			Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
pod_subnet_id	string			If omitted, pod IPs are statically assigned on the node subnet.
power_state	dict			When an Agent Pool is first created it is initially C(Running).
The Agent Pool can be stopped by setting this field to C(Stopped).
A stopped Agent Pool stops all of its VMs and does not accrue billing charges.
An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded.
profile	string			Security profile found in ~/.azure/credentials file.
proximity_placement_group_id	string			The ID for Proximity Placement Group.
resource_group	string	yes		The name of the resource group.
scale_down_mode	string		`Delete`	This also effects the cluster autoscaler behavior.
If not specified, it defaults to C(Delete).
scale_set_eviction_policy	string			This cannot be specified unless the I(scale_set_priority=Spot).
If not specified, the default is C(Delete).
scale_set_priority	string			The Virtual Machine Scale Set priority.
If not specified, the default is C(Regular).
secret	string			Azure client secret. Use when authenticating with a Service Principal.
security_profile	dict			The security settings of an agent pool.
spot_max_price	float			Possible values are any decimal value greater than zero or -1.
Indicates the willingness to pay any on-demand price.
state	string		`present`	State of the automation runbook. Use C(present) to create or update a automation runbook and use C(absent) to delete.
subscription_id	string			Your Azure subscription Id.
tags	dict			Dictionary of string:string pairs to assign as metadata to the object.
Metadata tags on the object will be updated with any provided values.
To remove tags set append_tags option to false.
Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag.
Azure Front Door doesn’t support the use of
Azure Automation and Azure CDN only support 15 tags on resources.
tenant	string			Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint	string			The thumbprint of the private key specified in I(x509_certificate_path).
Use when authenticating with a Service Principal.
Required if I(x509_certificate_path) is defined.
type_properties_type	string			AgentPoolType represents types of an agent pool.
upgrade_settings	dict			Settings for upgrading the agentpool.
vm_size	string			Size of agent VMs
vnet_subnet_id	string			VNet SubnetID specifies the VNet’s subnet identifier.
windows_profile	dict			The Windows agent pool’s specific profile.
workload_runtime	string			Determines the type of workload a node can run.
x509_certificate_path	string			Path to the X509 certificate used to create the service principal in PEM format.
The certificate must be appended to the private key.
Use when authenticating with a Service Principal.

Example

yaml

- name: Add new node agent pool
  azure.azcollection.azure_rm_aksagentpool:
    resource_group: "{{ resource_group }}"
    cluster_name: aksfred01
    name: default-new
    count: 2
    vm_size: Standard_B2s
    type_properties_type: VirtualMachineScaleSets
    mode: System
    node_labels: {"release":"stable"}
    max_pods: 42
    orchestrator_version: 1.23.5
    availability_zones:
      - 1
      - 2
- name: Create a node agent pool with custom config
  azure.azcollection.azure_rm_aksagentpool:
    resource_group: "{{ resource_group }}"
    cluster_name: "min{{ rpfx }}"
    name: default-new2
    count: 1
    vm_size: Standard_B2s
    type_properties_type: VirtualMachineScaleSets
    mode: System
    node_labels: {"release":"stable"}
    max_pods: 42
    enable_auto_scaling: true
    min_count: 1
    max_count: 10
    orchestrator_version: 1.23.5
    availability_zones:
      - 1
    kubelet_config:
      cpu_manager_policy: static
      cpu_cfs_quota: true
      fail_swap_on: false
    linux_os_config:
      transparent_huge_page_enabled: madvise
      swap_file_size_mb: 1500
      transparent_huge_page_defrag: defer+madvise
- name: Delete node agent pool
  azure.azcollection.azure_rm_aksagentpool:
    resource_group: "{{ resource_group }}"
    cluster_name: aksfred01
    name: default-new