azure_rm_acs - Управление экземпляром Azure Container Service (ACS).

Новая в версии 2.4.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Обзор

Создание, обновление и удаление экземпляра Azure Container Service.

Требования

Ниже приведены требования, которые необходимы на хосте, на котором выполняется этот модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
ad_user		Значение по умолчанию: None	Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
agent_pool_profiles обязательно			Подварианты профиля пула агентов.
	count обязательно		Количество агентов (виртуальных машин) для размещения контейнеров Docker. Допустимые значения находятся в диапазоне от 1 до 100 (включительно).
	vm_size обязательно		Размер ВМ каждого из агентов пула (например, Standard_F1 / Standard_D2v2).
	name обязательно		Уникальное имя профиля пула агентов в контексте подписки и группы ресурсов.
	dns_prefix обязательно		Префикс DNS, предоставленный агентам в этом пуле агентов.
api_profile (добавлено в 2.5)		Варианты: latest ←	Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags		Значение по умолчанию: yes	Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source (добавлено в 2.5)		Варианты: auto ← cli credential_file env	Управляет источником учетных данных для аутентификации. `auto` будет следовать по умолчанию приоритету параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных `~/.azure/credentials`. При установке значения `cli`, учетные данные будут взяты из профиля по умолчанию Azure CLI. Также может быть задано через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`.
cert_validation_mode (добавлено в 2.5)		Варианты: validate ignore Значение по умолчанию: None	Управляет поведением проверки сертификатов для Azure-конечных точек. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack, может потребоваться отключить это поведение, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id		Значение по умолчанию: None	Azure идентификатор клиента. Используется при аутентификации с помощью сервисного принципала.
cloud_environment (добавлено в 2.4)		Значение по умолчанию: AzureCloud	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL конечной точки обнаружения метаданных (необходим для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
diagnostics_profile обязательно			Следует ли включить диагностику ВМ для ВМ Container Service.
linux_profile обязательно			Подварианты профиля Linux.
	ssh_key обязательно		Открытый SSH-ключ, используемый для доступа к кластеру.
	admin_username обязательно		Имя пользователя администратора для кластера.
location		Значение по умолчанию: location группы ресурсов	Действительное расположение Azure. По умолчанию соответствует расположению группы ресурсов.
master_profile обязательно			Подварианты профиля Master.
	count обязательно	Варианты: 1 3 5	Количество мастер-узлов (ВМ) в кластере Container Service. Допустимые значения: 1, 3 и 5.
	vm_size обязательно (добавлено в 2.5)		Размер ВМ каждого из агентов пула (например, Standard_F1 / Standard_D2v2).
	dns_prefix обязательно		Префикс DNS для использования для мастер-узлов Container Service.
name обязательно			Имя экземпляра Container Services.
orchestration_platform обязательно			Указывает платформу контейнерной оркестрации. В настоящее время может быть DCOS, Kubernetes или Swarm.
password		Значение по умолчанию: None	Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
profile		Значение по умолчанию: None	Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group обязательно			Имя группы ресурсов, в которой существует или будет создан Container Services.
secret		Значение по умолчанию: None	Секретный ключ Azure клиента. Используется при аутентификации с помощью сервисного принципала.
service_principal		Значение по умолчанию: None	Подварианты сервисного принципала.
	client_secret		Секретный пароль, связанный с сервисным принципалом.
	client_id		Идентификатор сервисного принципала.
state		Варианты: absent present ←	Утверждает состояние ACS. Используйте 'present', чтобы создать или обновить ACS, и 'absent', чтобы удалить его.
subscription_id		Значение по умолчанию: None	Ваш идентификатор подписки Azure.
tags		Значение по умолчанию: None	Словарь пар строка:строка, которые необходимо назначить как метаданные объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в false.
tenant		Значение по умолчанию: None	Идентификатор Azure-арендатора. Используется при аутентификации с помощью сервисного принципала.

Примечания

Примечание

Для аутентификации с Azure вы можете передать параметры, установить переменные среды или использовать профиль, сохраненный в ~/.azure/credentials. Аутентификация возможна с помощью сервисного принципала или пользователя Active Directory. Для аутентификации через сервисный принципал, передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации через пользователя Active Directory, передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
В качестве альтернативы учетные данные могут храниться в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также возможно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

Примеры

    - 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
              vm_size: Standard_D2_v2
        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
              vm_size: Standard_D2_v2
        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
              vm_size: Standard_D2_v2
        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
              vm_size: Standard_A0
              dns_prefix: acstestingmasterdns5
        linux_profile:
            - admin_username: azureuser
              ssh_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...
        agent_pool_profiles:
            - name: default
              count: 4
              dns_prefix: acctestagent15
              vm_size: Standard_A0
        diagnostics_profile: false
        tags:
            Ansible: azure_rm_acs

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ	Возвращаемое	Описание
state dict	всегда	Текущее состояние службы Azure Container Service

Статус

Данный модуль помечен как предварительная версия, что означает, что его интерфейс не гарантирует обратной совместимости.

Автор

Julien Stroheker (@julienstroheker)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/azure_rm_acs_module.html