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

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

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

Обзор

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
aad_profile - добавлен в 2.8				Профиль конфигурации Azure Active Directory.
	client_app_id -			Идентификатор приложения клиента AAD.
	server_app_id -			Идентификатор приложения сервера AAD.
	server_app_secret -			Секрет приложения сервера AAD.
	tenant_id -			Идентификатор клиента AAD для аутентификации. Если не указано, будет использоваться клиент из подписки развертывания.
ad_user строка				Имя пользователя Active Directory. Используется при аутентификации пользователем Active Directory, а не сервисным принципалом.
addon словарь добавлен в 2.8				Профиль плагина управляемого кластера. Ключ может быть `http_application_routing`, `monitoring`, `virtual_node`. Значение должно быть словарем, содержащим булеву переменную `enabled`.
	http_application_routing словарь			Решение для маршрутизации HTTP-приложений упрощает доступ к приложениям, развернутым в вашем кластере.
		enabled булево	Варианты: нет да	Включено ли решение.
	monitoring словарь			Предоставляет видимость производительности, собирая метрики памяти и процессора с контроллеров, узлов и контейнеров, доступных в Kubernetes через API метрик.
		enabled булево	Варианты: нет да	Включено ли решение.
		log_analytics_workspace_resource_id -		Место хранения метрик контейнеров.
	virtual_node словарь			Виртуальные узлы обеспечивают быстрое предоставление под-процессов и оплату только за время их выполнения. Нет необходимости ждать, пока масштабировщик Kubernetes развернёт узлы вычислительных машин VM для запуска дополнительных под-процессов.
		enabled булево	Варианты: нет да	Включено ли решение.
		subnet_resource_id -		Подсеть, связанная с кластером.
adfs_authority_url строка добавлен в 2.6				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 булево			Варианты: нет да ←	Управление тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом режиме любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
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 строка				Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала.
cloud_environment строка добавлен в 2.4			По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (необходим для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
dns_prefix -				Префикс DNS, указанный при создании управляемого кластера.
enable_rbac булево добавлен в 2.8			Варианты: нет ← да	Включить RBAC. Существующие AKS-кластеры без RBAC в настоящее время не могут быть обновлены для использования RBAC.
kubernetes_version -				Версия Kubernetes, указанная при создании управляемого кластера.
linux_profile -				Подварианты профиля Linux.

	admin_username - / обязательно		Имя пользователя администратора кластера.
	ssh_key - / обязательно		Открытый ключ SSH, используемый для доступа к кластеру.
location -			Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.
name - / обязательно			Имя управляемого экземпляра Azure Container Services (AKS).
network_profile - добавлен в 2.8			Профиль конфигурации сети.
	dns_service_ip -		IP-адрес, назначенный службе DNS Kubernetes. Он должен находиться в диапазоне адресов службы Kubernetes, указанном в serviceCidr.
	docker_bridge_cidr -		Диапазон IP-адресов в CIDR-нотации, назначенный сети Docker bridge. Он не должен перекрываться с IP-диапазонами подсетей или диапазоном адресов службы Kubernetes.
	network_plugin -	Варианты: azure kubenet	Плагин сети, используемый для построения сети Kubernetes. Это свойство изменить нельзя. В `kubenet`, узлы получают IP-адрес из подсети виртуальной сети Azure. Функции AKS, такие как виртуальные узлы или политики сети, не поддерживаются с `kubenet`. `azure` включает интерфейс Azure Container Networking Interface (CNI), каждый контейнер получает IP-адрес из подсети и может быть доступен напрямую.
	network_policy -		Политика сети, используемая для построения сети Kubernetes.
	pod_cidr -		Диапазон IP-адресов в CIDR-нотации для назначения IP-адресов контейнерам при использовании kubenet. Он должен быть большим адресным пространством, которое не используется в вашей сетевой среде. Этот диапазон адресов должен быть достаточно большим для ожидаемого количества узлов, масштабируемых вверх.
	service_cidr -		Диапазон IP-адресов в CIDR-нотации для назначения IP-адресов кластеру служб. Он не должен перекрываться с IP-диапазонами подсетей. Он должен быть адресом *.10 диапазона IP-адресов вашей службы.
password -			Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо принципала службы.
profile строка			Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group - / обязательно			Имя группы ресурсов, в которой существует или будет создан управляемый экземпляр Azure Container Services (AKS).
secret строка			Секретный ключ клиента Azure. Используйте при аутентификации с принципалом службы.
service_principal -			Дополнительные параметры принципала службы.
	client_id - / обязательно		Идентификатор принципала службы.
	client_secret - / обязательно		Секретный пароль, связанный с принципалом службы.
state -		Варианты: отсутствует присутствует ←	Утвердить состояние AKS. Используйте `present` для создания или обновления AKS и `absent` для его удаления.
subscription_id строка			Ваш идентификатор подписки Azure.
tags словарь			Словарь пар строка:строка для назначения в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false.
tenant строка			Идентификатор клиента 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. Также возможно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

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

Примеры

- name: Create a managed Azure Container Services (AKS) instance
  azure_rm_aks:
    name: acctestaks1
    location: eastus
    resource_group: myResourceGroup
    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: myResourceGroup
    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.8/modules/azure_rm_aks_module.html