azure_rm_aks - Manage a managed Azure Container Service (AKS) Instance.¶

New in version 2.6.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

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
azure >= 2.0.0

Parameters ¶

Parameter		Choices/Defaults	Comments
ad_user			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url (added in 2.6)		Default: None	Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
agent_pool_profiles			The agent pool profile suboptions.
	count required		Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive).
	vm_size required		The VM Size of each of the Agent Pool VM's (e.g. Standard_F1 / Standard_D2v2).
	name required		Unique name of the agent pool profile in the context of the subscription and resource group.
	os_disk_size_gb		Size of the OS disk.
api_profile (added in 2.5)		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 bool		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 (added in 2.5)		Choices: auto cli credential_file env msi	Controls the source of the credentials to use for authentication. If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to `auto` if variable is not defined. `auto` will follow the default precedence of module parameters -> environment variables -> default profile in credential file `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the default Azure CLI profile. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. 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 (added in 2.5)		Choices: validate ignore	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			Azure client ID. Use when authenticating with a Service Principal.
cloud_environment (added in 2.4)		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			DNS prefix specified when creating the managed cluster.
kubernetes_version			Version of Kubernetes specified when creating the managed cluster.
linux_profile			The linux profile suboptions.
	ssh_key required		The Public SSH Key used to access the cluster.
	admin_username required		The Admin Username for the Cluster.
location			Valid azure location. Defaults to location of the resource group.
name required			Name of the managed Azure Container Services (AKS) instance.
password			Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile			Security profile found in ~/.azure/credentials file.
resource_group required			Name of a resource group where the managed Azure Container Services (AKS) exists or will be created.
secret			Azure client secret. Use when authenticating with a Service Principal.
service_principal			The service principal suboptions.
	client_secret required		The secret password associated with the service principal.
	client_id required		The ID for the Service Principal.
state		Choices: absent present ←	Assert the state of the AKS. Use `present` to create or update an AKS and `absent` to delete it.
subscription_id			Your Azure subscription Id.
tags			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.
tenant			Azure tenant ID. Use when authenticating with a Service Principal.

Notes ¶

Note

For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is 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.

Examples ¶

- name: Create a managed Azure Container Services (AKS) instance
  azure_rm_aks:
    name: acctestaks1
    location: eastus
    resource_group: Testing
    dns_prefix: akstest
    linux_profile:
      admin_username: azureuser
      ssh_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...
    service_principal:
      client_id: "cf72ca99-f6b9-4004-b0e0-bee10c521948"
      client_secret: "[email protected]!"
    agent_pool_profiles:
      - name: default
        count: 5
        vm_size: Standard_D2_v2
    tags:
      Environment: Production

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

Return Values ¶

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

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

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

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

Hint

If you notice any issues in this documentation you can edit this document to improve it.