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 | Подварианты профиля пула агентов. | ||
| name обязательно | Уникальное имя профиля пула агентов в контексте подписки и группы ресурсов. | ||
| count обязательно | Количество агентов (виртуальных машин) для размещения контейнеров Docker. Допустимые значения должны быть в диапазоне от 1 до 100 (включительно). | ||
| vm_size обязательно | Размер виртуальной машины каждого агента пула (например, Standard_F1 / Standard_D2v2). | ||
| os_disk_size_gb | Размер системного диска. | ||
| api_profile (добавлено в 2.5) | По умолчанию: "latest" | Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. | |
| append_tags bool |
| Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. | |
| auth_source (добавлено в 2.5) |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная среды 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) |
| Управляет поведением проверки сертификата для 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 Service (AKS). | ||
| password | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным принципом службы. | ||
| profile | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| resource_group обязательно | Имя группы ресурсов, где существует или будет создан управляемый Azure Container Service (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. Аутентификация возможна с использованием главного принципа службы или пользователя 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 dict | всегда | Текущее состояние Azure Container Service (AKS) |
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Для просмотра списка других модулей, также поддерживаемых сообществом 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.6/modules/azure_rm_aks_module.html
