azure_rm_acs - Manage an Azure Container Service Instance (ACS).
New in version 2.4.
Synopsis
- Create, update and delete an Azure Container Service Instance.
Requirements (on host that executes module)
- python >= 2.7
- azure >= 2.0.0
Options
| parameter | required | default | choices | comments | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ad_user | no | Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |||||||||||||||||||||||||||
| agent_pool_profiles | yes | The agent pool profile suboptions. |
|||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
| append_tags | no | 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. | ||||||||||||||||||||||||||
| client_id | no | Azure client ID. Use when authenticating with a Service Principal. | |||||||||||||||||||||||||||
| cloud_environment | no | 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. | ||||||||||||||||||||||||||
| diagnostics_profile | yes | Should VM Diagnostics be enabled for the Container Service VM's. | |||||||||||||||||||||||||||
| linux_profile | yes | The linux profile suboptions. |
|||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
| location | no | resource_group location | Valid azure location. Defaults to location of the resource group. | ||||||||||||||||||||||||||
| master_profile | yes | Master profile suboptions. |
|||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
| name | yes | Name of the Container Services instance. | |||||||||||||||||||||||||||
| orchestration_platform | yes | Specifies the Container Orchestration Platform to use. Currently can be either DCOS, Kubernetes or Swarm. | |||||||||||||||||||||||||||
| password | no | Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |||||||||||||||||||||||||||
| profile | no | Security profile found in ~/.azure/credentials file. | |||||||||||||||||||||||||||
| resource_group | yes | Name of a resource group where the Container Services exists or will be created. | |||||||||||||||||||||||||||
| secret | no | Azure client secret. Use when authenticating with a Service Principal. | |||||||||||||||||||||||||||
| service_principal | no | The service principal suboptions. |
|||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
| state | no | present |
| Assert the state of the ACS. Use 'present' to create or update an ACS and 'absent' to delete it. | |||||||||||||||||||||||||
| subscription_id | no | Your Azure subscription Id. | |||||||||||||||||||||||||||
| tags | no | 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 | no | Azure tenant ID. Use when authenticating with a Service Principal. | |||||||||||||||||||||||||||
Examples
- name: Create an azure container services instance running Kubernetes
azure_rm_acs:
name: acctestcontservice1
location: eastus
resource_group: Testing
orchestration_platform: Kubernetes
master_profile:
- count: 3
dns_prefix: acsk8smasterdns
linux_profile:
- admin_username: azureuser
ssh_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...
service_principal:
- client_id: "cf72ca99-f6b9-4004-b0e0-bee10c521948"
client_secret: "mySPNp@ssw0rd!"
agent_pool_profiles:
- name: default
count: 5
dns_prefix: acsk8sagent
vm_size: Standard_D2_v2
diagnostics_profile: false
tags:
Environment: Production
- name: Create an azure container services instance running DCOS
azure_rm_acs:
name: acctestcontservice2
location: eastus
resource_group: Testing
orchestration_platform: DCOS
master_profile:
- count: 3
dns_prefix: acsdcosmasterdns
linux_profile:
- admin_username: azureuser
ssh_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...
agent_pool_profiles:
- name: default
count: 5
dns_prefix: acscdcosagent
vm_size: Standard_D2_v2
diagnostics_profile: false
tags:
Environment: Production
- name: Create an azure container services instance running Swarm
azure_rm_acs:
name: acctestcontservice3
location: eastus
resource_group: Testing
orchestration_platform: Swarm
master_profile:
- count: 3
dns_prefix: acsswarmmasterdns
linux_profile:
- admin_username: azureuser
ssh_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...
agent_pool_profiles:
- name: default
count: 5
dns_prefix: acsswarmagent
vm_size: Standard_D2_v2
diagnostics_profile: false
tags:
Environment: Production
# Deletes the specified container service in the specified subscription and resource group.
# The operation does not delete other resources created as part of creating a container service,
# including storage accounts, VMs, and availability sets. All the other resources created with the container
# service are part of the same resource group and can be deleted individually.
- name: Remove an azure container services instance
azure_rm_acs:
name: acctestcontservice3
location: eastus
resource_group: Testing
state: absent
orchestration_platform: Swarm
master_profile:
- count: 1
dns_prefix: acstestingmasterdns5
linux_profile:
- admin_username: azureuser
ssh_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...
service_principal:
- client_id: 7fb4173c-3ca3-4d5b-87f8-1daac941207a
client_secret: MPNSuM1auUuITefiLGBrpZZnLMDKBLw2
agent_pool_profiles:
- name: default
count: 4
dns_prefix: acctestagent15
vm_size: Standard_A0
diagnostics_profile: false
tags:
Ansible: azure_rm_acs
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| state | Current state of the azure container service | always | dict |
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.
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_acs_module.html