azure_rm_containerinstance - Управление экземпляром Azure Container Instance.
Новая версия с 2.5.
Обзор
- Создание, обновление и удаление экземпляра Azure Container Instance.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user | Значение по умолчанию: None | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. | |
| api_profile (добавлено в 2.5) |
| Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. | |
| auth_source (добавлено в 2.5) |
| Управляет источником учетных данных для аутентификации. auto будет следовать по умолчанию приоритету параметров модуля -> переменных среды -> профилю по умолчанию в файле учетных данных ~/.azure/credentials. При установке в cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. | |
| cert_validation_mode (добавлено в 2.5) |
None | Управляет поведением проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или с Azure Stack, может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. | |
| client_id | Значение по умолчанию: None | Идентификатор клиента Azure. Используется при аутентификации со Служебным принципалом. | |
| cloud_environment (добавлено в 2.4) | Значение по умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment ), или URL конечной точки обнаружения метаданных (необходимо для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. | |
| containers | Список контейнеров. | ||
| image обязательно | Имя образа контейнера. | ||
| memory | Значение по умолчанию: 1.5 | Необходимая память контейнеров в ГБ. | |
| ports | Список портов, доступных в группе контейнеров. | ||
| name обязательно | Имя экземпляра контейнера. | ||
| cpu | Значение по умолчанию: 1 | Требуемое количество ядер процессора контейнеров. | |
| force_update |
| Принудительное обновление существующего экземпляра контейнера. Любое обновление приведет к удалению и повторному созданию существующих контейнеров. | |
| ip_address |
| Тип IP-адреса группы контейнеров (по умолчанию 'none') | |
| location | Допустимое расположение Azure. По умолчанию — расположение группы ресурсов. | ||
| name обязательно | Имя группы контейнеров. | ||
| os_type |
| Тип ОС контейнеров. | |
| password | Значение по умолчанию: None | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. | |
| ports | Список портов, доступных в группе контейнеров. | ||
| profile | Значение по умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| registry_login_server | Сервер входа в регистр образов контейнеров. | ||
| registry_password | Пароль для входа в сервер регистрации образов контейнеров. | ||
| registry_username | Имя пользователя для входа в сервер регистрации образов контейнеров. | ||
| resource_group обязательно | Имя группы ресурсов. | ||
| secret | Значение по умолчанию: None | Секрет клиента Azure. Используется при аутентификации со Служебным принципалом. | |
| state |
| Утверждение состояния экземпляра контейнера. Используйте 'present' для создания или обновления экземпляра контейнера и 'absent' для его удаления. | |
| subscription_id | Значение по умолчанию: None | Идентификатор вашей подписки Azure. | |
| tenant | Значение по умолчанию: None | Идентификатор арендатора 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 | Public IP-адрес созданной группы контейнеров. Пример: 175.12.233.11 |
| provisioning_state str | всегда | Состояние подготовки контейнера. Пример: Создание |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Автор
- 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.5/modules/azure_rm_containerinstance_module.html