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 - | Список контейнеров. | ||
| cpu - | По умолчанию: 1 | Необходимое количество процессорных ядер контейнеров. | |
| image - / требуется | Имя образа контейнера. | ||
| memory - | По умолчанию: 1.5 | Необходимая память контейнеров в ГБ. | |
| name - / требуется | Имя экземпляра контейнера. | ||
| ports - | Список портов, открытых в группе контейнеров. | ||
| force_update boolean |
| Принудительное обновление существующего экземпляра контейнера. Любое обновление приведет к удалению и повторному созданию существующих контейнеров. | |
| ip_address - |
| Тип IP-адреса группы контейнеров (по умолчанию 'нет') | |
| 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 - |
| Утверждение состояния экземпляра контейнера. Используйте 'есть' для создания или обновления экземпляра контейнера и 'отсутствует' для его удаления. | |
| 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 строка | всегда | Идентификатор ресурса Пример: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.ContainerInstance/containerGroups/aci1b6dd89 |
| ip_address строка | если адрес общедоступный | Общедоступный IP-адрес созданной группы контейнеров. Пример: 175.12.233.11 |
| provisioning_state строка | всегда | Состояние подготовки контейнера. Пример: Создание |
Статус
- Для данного модуля не гарантируется обратная совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/azure_rm_containerinstance_module.html
