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

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

Описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения
Статус

Описание

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

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

subscription_id string			Ваш идентификатор подписки Azure.
tags dictionary			Словарь пар «строка:строка», используемых в качестве метаданных для объекта. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в значение false.
tenant string			Идентификатор клиента Azure. Используется при аутентификации с помощью принципала службы.

Примечания

Примечание

Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или войти в систему перед запуском задач или выполнения книги с az login.
Аутентификация также возможна с помощью принципала службы или пользователя 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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

Вход в систему с помощью Azure CLI: Как выполнить аутентификацию с помощью команды az login.

Примеры

    - name: Create an azure container services instance running Kubernetes
      azure_rm_acs:
        name: acctestcontservice1
        location: eastus
        resource_group: myResourceGroup
        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: myResourceGroup
        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: myResourceGroup
        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: myResourceGroup
        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 словарь	всегда	Текущее состояние службы Azure Container Service

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.8/modules/azure_rm_acs_module.html