Docs4dev
Docs
ansible / latest / collections / azure / azcollection / azure_rm_aks_module.html

azure.azcollection.azure_rm_aks – Manage a managed Azure Container Service (AKS) instance

Note

This plugin is part of the azure.azcollection collection (version 1.10.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection.

To use it in a playbook, specify: azure.azcollection.azure_rm_aks.

New in version 0.1.2: of azure.azcollection

Synopsis

  • Create, update and delete a managed Azure Container Service (AKS) instance.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7
  • The host that executes this module must have the azure.azcollection collection installed via galaxy
  • All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection
  • Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter Choices/Defaults Comments
aad_profile
string
Profile of Azure Active Directory configuration.
client_app_id
string
The client AAD application ID.
server_app_id
string
The server AAD application ID.
server_app_secret
string
The server AAD application secret.
tenant_id
string
The AAD tenant ID to use for authentication.
If not specified, will use the tenant of the deployment subscription.
ad_user
string
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
addon
dictionary
Profile of managed cluster add-on.
Key can be http_application_routing, monitoring, virtual_node.
Value must be a dict contains a bool variable enabled.
http_application_routing
dictionary
The HTTP application routing solution makes it easy to access applications that are deployed to your cluster.
enabled
boolean
    Choices:
  • no
  • yes
Whether the solution enabled.
monitoring
dictionary
It gives you performance visibility by collecting memory and processor metrics from controllers, nodes, and containers that are available in Kubernetes through the Metrics API.
enabled
boolean
    Choices:
  • no
  • yes
Whether the solution enabled.
log_analytics_workspace_resource_id
string / required
Where to store the container metrics.
virtual_node
dictionary
With virtual nodes, you have quick provisioning of pods, and only pay per second for their execution time.
You don't need to wait for Kubernetes cluster autoscaler to deploy VM compute nodes to run the additional pods.
enabled
boolean
    Choices:
  • no
  • yes
Whether the solution enabled.
subnet_resource_id
string / required
Subnet associated to the cluster.
adfs_authority_url
string
added in 0.0.1 of azure.azcollection
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
agent_pool_profiles
string
The agent pool profile suboptions.
availability_zones
list / elements=string
    Choices:
  • 1
  • 2
  • 3
Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType.
count
string / required
Number of agents (VMs) to host docker containers.
Allowed values must be in the range of 1 to 100 (inclusive).
enable_auto_scaling
boolean
    Choices:
  • no
  • yes
To enable auto-scaling.
max_count
integer
Maximum number of nodes for auto-scaling.
Required if enable_auto_scaling=True.
max_pods
integer
Maximum number of pods schedulable on nodes.
min_count
integer
Minmum number of nodes for auto-scaling.
Required if enable_auto_scaling=True.
mode
string
    Choices:
  • System
  • User
AgentPoolMode represents mode of an agent pool.
Possible values include System and User.
System AgentPoolMode requires a minimum VM SKU of at least 2 vCPUs and 4GB memory.
name
string / required
Unique name of the agent pool profile in the context of the subscription and resource group.
node_labels
dictionary
Agent pool node labels to be persisted across all nodes in agent pool.
os_disk_size_gb
string
Size of the OS disk.
type
string
    Choices:
  • VirtualMachineScaleSets
  • AvailabilitySet
AgentPoolType represents types of an agent pool.
Possible values include VirtualMachineScaleSets and AvailabilitySet.
vm_size
string / required
The VM Size of each of the Agent Pool VM's (e.g. Standard_F1 / Standard_D2v2).
vnet_subnet_id
string
Specifies the VNet's subnet identifier.
api_profile
string
added in 0.0.1 of azure.azcollection
Default:
"latest"
Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.
append_tags
boolean
    Choices:
  • no
  • yes ←
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
added in 0.0.1 of azure.azcollection
    Choices:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Controls the source of the credentials to use for authentication.
Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.
When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.
When set to env, the credentials will be read from the environment variables
When set to credential_file, it will read the profile from ~/.azure/credentials.
When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable 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 msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable 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 msi was added in Ansible 2.6.
cert_validation_mode
string
added in 0.0.1 of azure.azcollection
    Choices:
  • ignore
  • validate
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 ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.
client_id
string
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
string
added in 0.0.1 of azure.azcollection
Default:
"AzureCloud"
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.
dns_prefix
string
DNS prefix specified when creating the managed cluster.
enable_rbac
boolean
    Choices:
  • no ←
  • yes
Enable RBAC.
Existing non-RBAC enabled AKS clusters cannot currently be updated for RBAC use.
kubernetes_version
string
Version of Kubernetes specified when creating the managed cluster.
linux_profile
string
The Linux profile suboptions.
Optional, provide if you need an ssh access to the cluster nodes.
admin_username
string / required
The Admin Username for the cluster.
ssh_key
string / required
The Public SSH Key used to access the cluster.
location
string
Valid azure location. Defaults to location of the resource group.
log_mode
string
Parent argument.
log_path
string
Parent argument.
name
string / required
Name of the managed Azure Container Services (AKS) instance.
network_profile
string
Profile of network configuration.
dns_service_ip
string
Default:
"10.0.0.10"
An IP address assigned to the Kubernetes DNS service.
It must be within the Kubernetes service address range specified in serviceCidr.
docker_bridge_cidr
string
Default:
"172.17.0.1/16"
A CIDR notation IP range assigned to the Docker bridge network.
It must not overlap with any Subnet IP ranges or the Kubernetes service address range.
load_balancer_sku
string
    Choices:
  • standard
  • basic
The load balancer sku for the managed cluster.
network_plugin
string
    Choices:
  • azure
  • kubenet ←
Network plugin used for building Kubernetes network.
This property cannot been changed.
With kubenet, nodes get an IP address from the Azure virtual network subnet.
AKS features such as Virtual Nodes or network policies aren't supported with kubenet.
azure enables Azure Container Networking Interface(CNI), every pod gets an IP address from the subnet and can be accessed directly.
network_policy
string
    Choices:
  • azure
  • calico
Network policy used for building Kubernetes network.
pod_cidr
string
Default:
"10.244.0.0/16"
A CIDR notation IP range from which to assign pod IPs when network_plugin=kubenet is used.
It should be a large address space that isn't in use elsewhere in your network environment.
This address range must be large enough to accommodate the number of nodes that you expect to scale up to.
service_cidr
string
Default:
"10.0.0.0/16"
A CIDR notation IP range from which to assign service cluster IPs.
It must not overlap with any Subnet IP ranges.
It should be the *.10 address of your service IP address range.
node_resource_group
string
Name of the resource group containing agent pool nodes.
Unable to update.
password
string
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile
string
Security profile found in ~/.azure/credentials file.
resource_group
string / required
Name of a resource group where the managed Azure Container Services (AKS) exists or will be created.
secret
string
Azure client secret. Use when authenticating with a Service Principal.
service_principal
string
The service principal suboptions. If not provided - use system-assigned managed identity.
client_id
string / required
The ID for the Service Principal.
client_secret
string
The secret password associated with the service principal.
state
string
    Choices:
  • absent
  • present ←
Assert the state of the AKS. Use present to create or update an AKS and absent to delete it.
subscription_id
string
Your Azure subscription Id.
tags
dictionary
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.

Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.
  • Authentication is also possible using a service principal or Active Directory user.
  • To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
  • To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
  • Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: Create an AKS instance With A System Node Pool & A User Node Pool
  azure_rm_aks:
    name: myAKS
    resource_group: myResourceGroup
    location: eastus
    dns_prefix: akstest
    kubernetes_version: 1.14.6
    linux_profile:
      admin_username: azureuser
      ssh_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...
    service_principal:
      client_id: "cf72ca99-f6b9-4004-b0e0-bee10c521948"
      client_secret: "Password1234!"
    agent_pool_profiles:
      - name: default
        count: 1
        vm_size: Standard_B2s
        enable_auto_scaling: True
        type: VirtualMachineScaleSets
        mode: System
        max_count: 3
        min_count: 1
        enable_rbac: yes
      - name: user
        count: 1
        vm_size: Standard_D2_v2
        enable_auto_scaling: True
        type: VirtualMachineScaleSets
        mode: User
        max_count: 3
        min_count: 1
        enable_rbac: yes

- name: Create a managed Azure Container Services (AKS) instance
  azure_rm_aks:
    name: myAKS
    location: eastus
    resource_group: myResourceGroup
    dns_prefix: akstest
    kubernetes_version: 1.14.6
    linux_profile:
      admin_username: azureuser
      ssh_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...
    service_principal:
      client_id: "cf72ca99-f6b9-4004-b0e0-bee10c521948"
      client_secret: "Password123!"
    agent_pool_profiles:
      - name: default
        count: 5
        mode: System
        vm_size: Standard_B2s
    tags:
      Environment: Production

- name: Use minimal parameters and system-assigned identity
  azure_rm_aks:
    name: myMinimalCluster
    location: eastus
    resource_group: myExistingResourceGroup
    dns_prefix: akstest
    agent_pool_profiles:
      - name: default
        count: 1
        vm_size: Standard_D2_v2

- name: Remove a managed Azure Container Services (AKS) instance
  azure_rm_aks:
    name: myAKS
    resource_group: myResourceGroup
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
state
dictionary
always
Current state of the Azure Container Service (AKS).

Sample:
{'agent_pool_profiles': [{'count': 1, 'dns_prefix': None, 'moode': 'System', 'name': 'default', 'node_labels': {'environment': 'dev', 'release': 'stable'}, 'os_disk_size_gb': None, 'os_type': 'Linux', 'ports': None, 'storage_profile': 'ManagedDisks', 'vm_size': 'Standard_B2s', 'vnet_subnet_id': None}], 'changed': False, 'dns_prefix': 'aks9860bdcd89', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/aks9860bdc', 'kube_config': '......', 'kubernetes_version': '1.14.6', 'linux_profile': {'admin_username': 'azureuser', 'ssh_key': 'ssh-rsa AAAAB3NzaC1yc2EAAAADA.....'}, 'location': 'eastus', 'name': 'aks9860bdc', 'provisioning_state': 'Succeeded', 'service_principal_profile': {'client_id': 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'}, 'tags': {}, 'type': 'Microsoft.ContainerService/ManagedClusters'}


Authors

  • Sertac Ozercan (@sozercan)
  • Yuwei Zhou (@yuwzho)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_aks_module.html