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)		Значение по умолчанию: null	URL-адрес полномочий Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственного центра полномочий ADFS.
agent_pool_profiles обязательно			Подварианты профиля пула агентов.
	name обязательно		Уникальное имя профиля пула агентов в контексте подписки и группы ресурсов.
	count обязательно		Количество агентов (виртуальных машин) для размещения контейнеров Docker. Допустимые значения должны быть в диапазоне от 1 до 100 (включительно).
	dns_prefix обязательно		Префикс DNS, заданный для агентов в этом пуле агентов.
	vm_size обязательно		Размер ВМ каждого агента из пула агентов (например, Standard_F1 / Standard_D2v2).
api_profile (добавлен в 2.5)		Значение по умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с Azure-службами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят работать с Azure Stack.
append_tags bool		Варианты: no да ←	Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. Когда каноническим, любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
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)		Варианты: validate ignore	Управляет поведением проверки сертификата для Azure-точек входа. По умолчанию все модули проверяют сертификат сервера, но при использовании прокси HTTPS или работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Можно также настроить через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id			Идентификатор клиента Azure. Используется при аутентификации с помощью главного принципа службы.
cloud_environment (добавлен в 2.4)		Значение по умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки входа для обнаружения метаданных (требуется для Azure Stack). Также может быть настроен через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
diagnostics_profile bool обязательно		Варианты: no yes	Должны ли быть включены средства диагностики ВМ для ВМ службы контейнеров.
linux_profile обязательно			Подварианты профиля Linux.
	admin_username обязательно		Имя администратора для кластера.
	ssh_key обязательно		Открытый ключ SSH, используемый для доступа к кластеру.
location			Действительное расположение azure. По умолчанию используется расположение группы ресурсов.
master_profile обязательно			Подварианты профиля мастера.
	count обязательно	Варианты: 1 3 5	Количество мастеров (виртуальных машин) в кластере службы контейнеров. Допустимые значения: 1, 3 и 5.
	vm_size обязательно (добавлен в 2.5)		Размер ВМ каждого агента из пула агентов (например, Standard_F1 / Standard_D2v2).
	dns_prefix обязательно		Префикс DNS, который следует использовать для узлов-мастеров службы контейнеров.
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			Ваш идентификатор подписки Azure.
tags			Словарь пар строка:строка, назначенных в качестве метаданных объекту. Метаданные тегов объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в значение false.
tenant			Идентификатор арендатора 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

Статус

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

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Более подробную информацию см. в Поддержка и техническое обслуживание модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

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