Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_containerinstance — Управление Azure Container Instance

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_containerinstance.

Новый в azure.azcollection 0.1.2

  • Описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Описание

  • Создание, обновление и удаление Azure Container Instance.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • python >= 2.7
  • На хосте, на котором выполняется данный модуль, должна быть установлена коллекция azure.azcollection через galaxy
  • Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
  • Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

acr_identity

string

added in azure.azcollection 2.5.0

Идентификатор, используемый для доступа к серверу реестра.

ad_user

string

Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не субъекта безопасности.

adfs_authority_url

string

added in azure.azcollection 0.0.1

URL-адрес узла проверки подлинности Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и имеет собственный узел проверки подлинности ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

append_tags

boolean

Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам.

В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.

Choices:

  • false
  • true ← (default)

auth_source

string

added in azure.azcollection 0.0.1

Управляет источником учетных данных, используемых для аутентификации.

Может также быть установлено через переменную среды 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.

Choices:

  • "auto" ← (default)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав ignore. Может также быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Choices:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi).

Может также быть установлено через переменную среды AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Может также быть установлено через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

containers

list / elements=dictionary

Список контейнеров.

Обязательно при создании.

commands

list / elements=string

Список команд для выполнения в экземпляре контейнера в формате exec.

При обновлении существующего контейнера все существующие команды будут заменены новыми.

cpu

float

Требуемое количество ядер ЦП контейнеров.

Default: 1.0

environment_variables

list / elements=dictionary

Список переменных среды контейнера.

При обновлении существующего контейнера все существующие переменные будут заменены новыми.

is_secure

boolean

Является ли переменная защищенной.

Choices:

  • false
  • true

name

string / required

Имя переменной среды.

value

string / required

Значение переменной среды.

image

строка / обязательно

Имя образа контейнера.

memory

число с плавающей точкой

Требуемая память контейнеров в ГБ.

По умолчанию: 1.5

name

строка / обязательно

Имя экземпляра контейнера.

ports

список / элементы=целое число

Список портов, открытых в группе контейнеров.

volume_mounts

список / элементы=словарь

Точки подключения томов для экземпляра контейнера

mount_path

строка / обязательно

Путь внутри контейнера, где должен быть смонтирован том

name

строка / обязательно

Имя точки подключения тома

read_only

булево

Флаг, указывающий, является ли точка подключения тома только для чтения

Варианты:

  • false
  • true

disable_instance_discovery

булево

добавлен в azure.azcollection 2.3.0

Определяет, будет ли выполнено обнаружение экземпляра при попытке проверки подлинности. Установка этого значения в true полностью отключит как обнаружение экземпляра, так и проверку подлинности авторизации. Эта функциональность предназначена для использования в сценариях, где не может быть достигнут конечный пункт метаданных, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра предполагает получение метаданных авторизации с https://login.microsoft.com/ для проверки авторизации. Установив это значение в **True**, проверка подлинности авторизации отключается. В результате крайне важно убедиться, что настроенный хост авторизации действителен и заслуживает доверия.

Устанавливается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY

Варианты:

  • false ← (по умолчанию)
  • true

dns_name_label

строка

Метка имени DNS для IP-адреса.

force_update

булево

Принудительное обновление существующего экземпляра контейнера. Любое обновление приведет к удалению и повторному созданию существующих контейнеров.

Варианты:

  • false ← (по умолчанию)
  • true

identity

словарь

добавлен в azure.azcollection 2.5.0

Идентификатор для сервера.

type

строка

Тип управляемого идентификатора

Варианты:

  • "SystemAssigned"
  • "SystemAssigned, UserAssigned"
  • "UserAssigned"

По умолчанию: "None"

user_assigned_identities

словарь

Пользовательские назначенные управляемые идентификаторы и их параметры

По умолчанию: {}

id

список / элементы=строка

Список идентификаторов назначенных пользователями идентификаторов, связанных с ВМ

По умолчанию: []

ip_address

строка

Тип IP-адреса группы контейнеров.

По умолчанию none, и создание экземпляра без публичного IP.

Варианты:

  • "public"
  • "none" ← (по умолчанию)
  • "private"

location

строка

Действительное расположение azure. По умолчанию - расположение группы ресурсов.

log_mode

строка

Родительский аргумент.

log_path

строка

Родительский аргумент.

name

строка / обязательно

Имя группы контейнеров.
END_OF_DOCUMENT_MARKER

os_type

string

Тип ОС контейнеров.

Выберите:

  • "linux" ← (по умолчанию)
  • "windows"

password

string

Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.

ports

list / elements=integer

Список портов, доступных в группе контейнеров.

Этот параметр устарел, используйте ports в containers.

По умолчанию: []

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

registry_login_server

string

Сервер входа в реестр контейнерных образов.

registry_password

string

Пароль для входа на сервер реестра контейнерных образов.

registry_username

string

Имя пользователя для входа на сервер реестра контейнерных образов.

resource_group

string / обязательно

Имя группы ресурсов.

restart_policy

string

Политика перезапуска для всех контейнеров в группе контейнеров.

Выберите:

  • "always"
  • "on_failure"
  • "never"

secret

string

Секретный ключ клиента Azure. Используется при аутентификации с принципалом службы.

state

string

Утверждение состояния экземпляра контейнера. Используйте present, чтобы создать или обновить экземпляр контейнера, и absent, чтобы удалить его.

Выберите:

  • "absent"
  • "present" ← (по умолчанию)

subnet_ids

list / elements=string

Идентификаторы ресурсов подсети для группы контейнеров.

Поддержка нескольких подсетей пока не реализована. Можно использовать только 1 подсеть.

subscription_id

string

Ваш идентификатор подписки Azure.

tags

dictionary

Словарь пар «строка:строка» для назначения метаданных объекту.

Метаданные теги объекта будут обновлены с любыми предоставленными значениями.

Для удаления тегов установите параметр append_tags в false.

В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в теге.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах.

tenant

string

Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток цифровой подписи для закрытого ключа, указанного в x509_certificate_path.

Используется при аутентификации с принципалом службы.

Требуется, если определён x509_certificate_path.

volumes

list / elements=dictionary

Список томов, которые могут быть смонтированы контейнерами в этой группе контейнеров.

azure_file

dictionary

Том Azure File.

read_only

boolean

Флаг, указывающий, является ли общий ресурс Azure File, смонтированный как том, только для чтения.

Выберите:

  • false
  • true

share_name

string / обязательно

Имя общего ресурса Azure File, которое нужно смонтировать как том.

storage_account_key

string / обязательно

Ключ доступа к учетной записи хранилища Azure, используемый для доступа к общему ресурсу Azure File.
END_OF_DOCUMENT_MARKER

storage_account_name

string / обязательно

Имя хранилища данных, содержащего общий доступ к файлам Azure

empty_dir

словарь

Том пустого каталога

git_repo

словарь

Том репозитория Git

directory

строка

Имя целевого каталога

repository

строка / обязательно

URL репозитория

revision

строка

Хеш коммита для указанной ревизии

name

строка / обязательно

Имя тома

secret

словарь

Том секретов

x509_certificate_path

путь

добавлен в azure.azcollection 1.14.0

Путь к X509 сертификату, используемому для создания служебного принципала в формате PEM.

Сертификат должен быть добавлен к закрытому ключу.

Используйте при аутентификации с помощью служебного принципала.

Примечания

Примечание

  • Для аутентификации с 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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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

- name: Create sample container group with azure file share volume
  azure_rm_containerinstance:
    resource_group: myResourceGroup
    name: myContainerInstanceGroupz
    os_type: linux
    ip_address: public
    containers:
      - name: mycontainer1
        image: httpd
        memory: 1
        volume_mounts:
          - name: filesharevolume
            mount_path: "/data/files"
        ports:
          - 80
          - 81
    volumes:
      - name: filesharevolume
        azure_file:
          storage_account_name: mystorageaccount
          share_name: acishare
          storage_account_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

- name: Create sample container group with git repo volume
  azure_rm_containerinstance:
    resource_group: myResourceGroup
    name: myContainerInstanceGroup
    os_type: linux
    ip_address: public
    containers:
      - name: mycontainer1
        image: httpd
        memory: 1
        volume_mounts:
          - name: myvolume1
            mount_path: "/mnt/test"
        ports:
          - 80
          - 81
    volumes:
      - name: myvolume1
        git_repo:
          repository: "https://github.com/Azure-Samples/aci-helloworld.git"

- name: Create sample container instance with subnet
  azure_rm_containerinstance:
    resource_group: myResourceGroup
    name: myContainerInstanceGroup
    os_type: linux
    ip_address: private
    location: eastus
    subnet_ids:
      - "{{ subnet_id }}"
    ports:
      - 80
    containers:
      - name: mycontainer1
        image: httpd
        memory: 1.5
        ports:
          - 80
          - 81

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ

Описание

containers

список / элементы=словарь

Контейнеры в группе контейнеров.

Возвращается: всегда

Пример: [{"commands": null, "cpu": 1.0, "environment_variables": null, "image": "httpd", "memory": 1.0, "name": "mycontainer1", "ports": [80, 81], "volume_mounts": [{"mount_path": "/data/files", "name": "filesharevolume", "read_only": false}]}]

id

строка

Идентификатор ресурса.

Возвращается: всегда

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance/containerGroups/aci1b6dd89"

ip_address

строка

Общедоступный IP-адрес созданной группы контейнеров.

Возвращается: если адрес общедоступный

Пример: "175.12.233.11"

provisioning_state

строка

Состояние подготовки контейнера.

Возвращается: всегда

Пример: "Creating"

volumes

список / элементы=словарь

Список томов, смонтированных контейнерами в группе контейнеров.

Возвращается: если указаны тома

azure_file

словарь

Подробная информация о томе Azure файлового хранилища.

Возвращается: Если тип тома — Azure файловое хранилище

Пример: {"read_only": null, "share_name": "acishare", "storage_account_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "storage_account_name": "mystorageaccount"}

empty_dir

словарь

Подробная информация о томе пустого каталога.

Возвращается: Если тип тома — пустой каталог

Пример: {}

git_repo

словарь

Подробная информация о томе Git репозитория.

Возвращается: Если тип тома — Git репозиторий

Пример: {"directory": null, "repository": "https://github.com/Azure-Samples/aci-helloworld.git", "revision": null}

name

строка

Имя тома.

Возвращается: всегда

Пример: "filesharevolume"

secret

словарь

Подробная информация о секретном томе.

Возвращается: Если тип тома — секрет

Пример: {}

Авторы

  • Zim Kalinowski (@zikalino)

Ссылки на коллекцию

  • Система отслеживания задач
  • Главная страница
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_containerinstance_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API