azure_rm_aks – Управление экземпляром управляемой Azure Container Service (AKS).

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

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

Краткое описание

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

Требования

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

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 -			Подварианты профиля пула агентов.
	count - / обязательно		Количество агентов (виртуальных машин) для размещения контейнеров Docker. Допустимые значения должны быть в диапазоне от 1 до 100 (включительно).
	name - / обязательно		Уникальное имя профиля пула агентов в контексте подписки и группы ресурсов.
	os_disk_size_gb -		Размер диска ОС.
	vm_size - / обязательно		Размер ВМ каждого агента в пуле (например, Standard_F1 / Standard_D2v2).
api_profile - добавлено в 2.5		По умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags boolean		Варианты: no yes ←	Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. Если канонический, любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
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`.
dns_prefix -			Префикс DNS, указанный при создании управляемого кластера.
kubernetes_version -			Версия Kubernetes, указанная при создании управляемого кластера.
linux_profile -			Подварианты профиля Linux.
	admin_username - / обязательно		Имя администратора для кластера.
	ssh_key - / обязательно		Публичный SSH-ключ, используемый для доступа к кластеру.
location -			Действительное расположение Azure. По умолчанию используется расположение группы ресурсов.
name - / обязательно			Имя управляемого экземпляра Azure Container Services (AKS).
password -			Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
profile -			Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group - / обязательно			Имя группы ресурсов, в которой существует или будет создан управляемый экземпляр Azure Container Services (AKS).
secret -			Секретный ключ клиента Azure. Используйте при аутентификации с помощью сервисного принципала.
service_principal -			Подварианты сервисного принципала.
	client_id - / обязательно		Идентификатор сервисного принципала.
	client_secret - / обязательно		Секретный пароль, связанный с сервисным принципалом.
state -		Варианты: absent present ←	Утвердить состояние AKS. Используйте `present` для создания или обновления AKS и `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 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: "mySPNp@ssw0rd!"
    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

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

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

Ключ	Возвращаемое значение	Описание
state словарь	всегда	Текущее состояние Azure Container Service (AKS)

Статус

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

Авторы

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

Подсказка

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

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