azure_rm_containerinstance — Управление экземпляром Azure Container Instance.
Новая версия с 2.5.
Обзор
- Создание, обновление и удаление экземпляра Azure Container Instance.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. | ||
| adfs_authority_url (добавлен в 2.6) | По умолчанию: null | URL авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизации ADFS. | |
| api_profile (добавлен в 2.5) | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. | |
| 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. | |
| containers | Список контейнеров. | ||
| name обязательно | Имя экземпляра контейнера. | ||
| image обязательно | Имя образа контейнера. | ||
| memory | По умолчанию: 1.5 | Необходимая оперативная память контейнеров в ГБ. | |
| cpu | По умолчанию: 1 | Необходимое количество ядер процессора контейнеров. | |
| ports | Список портов, открытых в группе контейнеров. | ||
| force_update bool |
| Принудительное обновление существующего экземпляра контейнера. Любое обновление приведет к удалению и повторному созданию существующих контейнеров. | |
| ip_address |
| Тип IP-адреса группы контейнеров (по умолчанию 'none') | |
| location | Допустимое расположение azure. По умолчанию — расположение группы ресурсов. | ||
| name обязательно | Имя группы контейнеров. | ||
| os_type |
| Тип ОС контейнеров. | |
| password | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. | ||
| ports | Список портов, открытых в группе контейнеров. | ||
| profile | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| registry_login_server | Сервер входа в реестр образов контейнеров. | ||
| registry_password | Пароль для входа в сервер реестра образов контейнеров. | ||
| registry_username | Имя пользователя для входа в сервер реестра образов контейнеров. | ||
| resource_group обязательно | Имя группы ресурсов. | ||
| secret | Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала. | ||
| state |
| Утверждение состояния экземпляра контейнера. Используйте 'present' для создания или обновления экземпляра контейнера, и 'absent' для его удаления. | |
| subscription_id | Идентификатор вашей подписки Azure. | ||
| 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 sample container group
azure_rm_containerinstance:
resource_group: testrg
name: mynewcontainergroup
os_type: linux
ip_address: public
ports:
- 80
- 81
containers:
- name: mycontainer1
image: httpd
memory: 1.5
ports:
- 80
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| id str | всегда | Идентификатор ресурса Пример: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.ContainerInstance/containerGroups/aci1b6dd89 |
| ip_address str | если адрес public | Общедоступный IP-адрес созданной группы контейнеров. Пример: 175.12.233.11 |
| provisioning_state str | всегда | Состояние подготовки контейнера. Пример: Создание |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратной совместимости интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Для получения списка других модулей, которые также поддерживаются сообществом Ansible, см. здесь.
Автор
- 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.6/modules/azure_rm_containerinstance_module.html
