azure.azcollection.azure_rm_containerinstance – Управление экземпляром Azure Container Instance
Примечание
Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в книге задач, укажите: azure.azcollection.azure_rm_containerinstance.
Новое в версии 0.1.2: of azure.azcollection
Обзор
- Создание, обновление и удаление экземпляра Azure Container Instance.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | |||
| adfs_authority_url строка добавлено в 0.0.1 azure.azcollection | URL авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной службой ADFS. | |||
| api_profile строка добавлено в 0.0.1 azure.azcollection | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. | ||
| append_tags булево |
| Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | ||
| auth_source строка добавлено в 0.0.1 azure.azcollection |
| Управляет источником используемых учетных данных для аутентификации. Также может быть задан через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. При значении auto (по умолчанию) приоритет имеет параметры модуля -> env -> credential_file -> cli. При значении env, учетные данные будут считываться из переменных среды.При значении credential_file, профиль будет считан из ~/.azure/credentials. При значении cli, учетные данные будут получены из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если их несколько, иначе используется по умолчанию az cli подписка. При значении msi, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если ресурс имеет доступ к нескольким подпискам, в противном случае выбирается первая подписка. Параметр msi был добавлен в Ansible 2.6. | ||
| cert_validation_mode строка добавлено в 0.0.1 azure.azcollection |
| Управляет поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или при работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. | ||
| client_id строка | Azure client ID. Используется при аутентификации с принципалом службы. | |||
| cloud_environment строка добавлено в 0.0.1 azure.azcollection | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки доступа к метаданным (необходим для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. | ||
| containers строка | Список контейнеров. Требуется при создании. | |||
| commands список / элементы=строка | Список команд для выполнения внутри экземпляра контейнера в форме exec. При обновлении существующего контейнера все существующие команды будут заменены новыми. | |||
| cpu число с плавающей точкой | По умолчанию: 1 | Требуемое количество ядер процессора для контейнеров. | ||
| environment_variables словарь | Список переменных среды контейнера. При обновлении существующего контейнера все существующие переменные будут заменены новыми. | |||
| is_secure булево |
| Является ли переменная защищённой. | ||
| name строка | Имя переменной среды. | |||
| value строка | Значение переменной среды. | |||
| image строка / требуется | Имя образа контейнера. | |||
| memory число с плавающей точкой | По умолчанию: 1.5 | Требуемая память контейнеров в ГБ. | ||
| name строка / требуется | Имя экземпляра контейнера. | |||
| ports список / элементы=строка | Список портов, экспонированных в группе контейнеров. | |||
| dns_name_label строка | Метка имени DNS для IP-адреса. | |||
| force_update булево |
| Принудительное обновление существующего экземпляра контейнера. Любое обновление приведёт к удалению и повторному созданию существующих контейнеров. | ||
| ip_address строка |
| Тип IP-адреса группы контейнеров. По умолчанию none, и создание экземпляра без публичного IP. | ||
| location строка | Действительное расположение Azure. По умолчанию — расположение группы ресурсов. | |||
| name строка / требуется | Имя группы контейнеров. | |||
| os_type строка |
| Тип операционной системы контейнеров. | ||
| password строка | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | |||
| ports список / элементы=строка | Список портов, экспонированных в группе контейнеров. Этот параметр устарел, используйте ports в containers". | |||
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |||
| registry_login_server строка | Сервер входа в реестр образов контейнеров. | |||
| registry_password строка | Пароль для входа в сервер реестра образов контейнеров. | |||
| registry_username строка | Имя пользователя для входа в сервер реестра образов контейнеров. | |||
| resource_group строка / требуется | Имя группы ресурсов. | |||
| restart_policy строка |
| Политика перезапуска всех контейнеров в группе контейнеров. | ||
| secret строка | Секрет клиента Azure. Используется при аутентификации с принципалом службы. | |||
| state строка |
| Утверждает состояние экземпляра контейнера. Используйте present для создания или обновления экземпляра контейнера и absent для его удаления. | ||
| subscription_id строка | Идентификатор вашей подписки Azure. | |||
| tags словарь | Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. | |||
| tenant строка | Идентификатор Azure-аренды. Используется при аутентификации с принципалом службы. | |||
Примечания
Примечание
- Для аутентификации с Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед запуском задач или playbook с
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 sample container group
azure_rm_containerinstance:
resource_group: myResourceGroup
name: myContainerInstanceGroup
os_type: linux
ip_address: public
containers:
- name: myContainer1
image: httpd
memory: 1.5
ports:
- 80
- 81
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращается | Описание |
|---|---|---|
| id string | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance/containerGroups/aci1b6dd89 |
| ip_address string | если адрес общедоступный | Общедоступный IP-адрес созданной группы контейнеров. Пример: 175.12.233.11 |
| provisioning_state string | всегда | Состояние подготовки контейнера. Пример: Создание |
Авторы
- Zim Kalinowski (@zikalino)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/azure/azcollection/azure_rm_containerinstance_module.html
