Spec-Zone.ru › Ansible 2.4

azure_rm_acs - Управление экземпляром Azure Container Service (ACS).

Новое в версии 2.4.

  • Обзор
  • Требования (к хосту, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус

Обзор

  • Создание, обновление и удаление экземпляра Azure Container Service.

Требования (к хосту, на котором выполняется модуль)

  • python >= 2.7
  • azure >= 2.0.0

Параметры

параметр обязателен по умолчанию возможные значения комментарии
ad_user
нет
Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
agent_pool_profiles
да
Подпараметры профиля пула агентов.
Объект словаря agent_pool_profiles
параметр обязателен по умолчанию возможные значения комментарии
count
да 1
Количество агентов (виртуальных машин) для размещения контейнеров docker. Допустимые значения находятся в диапазоне от 1 до 100 (включительно).
vm_size
да Standard_D2v2
Размер ВМ каждого агента пула (например, Standard_F1 / Standard_D2v2).
name
да
Уникальное имя профиля пула агентов в контексте подписки и группы ресурсов.
dns_prefix
да
Префикс DNS, назначенный агентам в этом пуле агентов.
append_tags
нет True
Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При канонических значениях любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
client_id
нет
Идентификатор клиента Azure. Используйте при аутентификации с помощью сервисного принципала.
cloud_environment
нет AzureCloud
Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (необходим для Azure Stack). Также может быть задан через файл профиля учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.
diagnostics_profile
да
Должны ли быть включены диагностические данные для ВМ Container Service.
linux_profile
да
Подпараметры профиля linux.
Объект словаря linux_profile
параметр обязателен по умолчанию возможные значения комментарии
ssh_key
да
Открытый ключ SSH, используемый для доступа к кластеру.
admin_username
да azureuser
Имя администратора для кластера.
location
нет местоположение группы ресурсов
Действительное местоположение azure. По умолчанию используется местоположение группы ресурсов.
master_profile
да
Подпараметры профиля мастера.
Объект словаря master_profile
параметр обязателен по умолчанию возможные значения комментарии
count
да
  • 1
  • 3
  • 5
Количество мастеров (ВМ) в кластере службы контейнеров. Допустимые значения: 1, 3 и 5.
dns_prefix
да
Префикс DNS для узлов-мастеров службы контейнеров.
name
да
Имя экземпляра службы контейнеров.
orchestration_platform
да
Указывает платформу контейнерной оркестрации. В настоящее время может быть DCOS, Kubernetes или Swarm.
password
нет
Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
profile
нет
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
да
Имя группы ресурсов, где существует или будет создана служба контейнеров.
secret
нет
Секретный ключ Azure клиента. Используйте при аутентификации с помощью сервисного принципала.
service_principal
нет
Подпараметры сервисного принципала.
Объект словаря service_principal
параметр обязателен по умолчанию возможные значения комментарии
client_secret
нет
Секретный пароль, связанный с сервисным принципалом.
client_id
нет
Идентификатор сервисного принципала.
state
нет present
  • absent
  • present
Укажите состояние ACS. Используйте 'present' для создания или обновления ACS и 'absent' для удаления.
subscription_id
нет
Ваш идентификатор подписки Azure.
tags
нет
Словарь пар строка:строка для назначения метаданных объекту. Метаданные тегов объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false.
tenant
нет
Идентификатор Azure-аренды. Используйте при аутентификации с помощью сервисного принципала.

Примеры

    - name: Create an azure container services instance running Kubernetes
      azure_rm_acs:
        name: acctestcontservice1
        location: eastus
        resource_group: Testing
        orchestration_platform: Kubernetes
        master_profile:
            - count: 3
              dns_prefix: acsk8smasterdns
        linux_profile:
            - admin_username: azureuser
              ssh_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...
        service_principal:
            - client_id: "cf72ca99-f6b9-4004-b0e0-bee10c521948"
              client_secret: "mySPNp@ssw0rd!"
        agent_pool_profiles:
            - name: default
              count: 5
              dns_prefix: acsk8sagent
              vm_size: Standard_D2_v2
        diagnostics_profile: false
        tags:
            Environment: Production

    - name: Create an azure container services instance running DCOS
      azure_rm_acs:
        name: acctestcontservice2
        location: eastus
        resource_group: Testing
        orchestration_platform: DCOS
        master_profile:
            - count: 3
              dns_prefix: acsdcosmasterdns
        linux_profile:
            - admin_username: azureuser
              ssh_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...
        agent_pool_profiles:
            - name: default
              count: 5
              dns_prefix: acscdcosagent
              vm_size: Standard_D2_v2
        diagnostics_profile: false
        tags:
            Environment: Production

    - name: Create an azure container services instance running Swarm
      azure_rm_acs:
        name: acctestcontservice3
        location: eastus
        resource_group: Testing
        orchestration_platform: Swarm
        master_profile:
            - count: 3
              dns_prefix: acsswarmmasterdns
        linux_profile:
            - admin_username: azureuser
              ssh_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...
        agent_pool_profiles:
            - name: default
              count: 5
              dns_prefix: acsswarmagent
              vm_size: Standard_D2_v2
        diagnostics_profile: false
        tags:
            Environment: Production

# Deletes the specified container service in the specified subscription and resource group.
# The operation does not delete other resources created as part of creating a container service,
# including storage accounts, VMs, and availability sets. All the other resources created with the container
# service are part of the same resource group and can be deleted individually.
    - name: Remove an azure container services instance
      azure_rm_acs:
        name: acctestcontservice3
        location: eastus
        resource_group: Testing
        state: absent
        orchestration_platform: Swarm
        master_profile:
            - count: 1
              dns_prefix: acstestingmasterdns5
        linux_profile:
            - admin_username: azureuser
              ssh_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA...
        service_principal:
            - client_id: 7fb4173c-3ca3-4d5b-87f8-1daac941207a
              client_secret: MPNSuM1auUuITefiLGBrpZZnLMDKBLw2
        agent_pool_profiles:
            - name: default
              count: 4
              dns_prefix: acctestagent15
              vm_size: Standard_A0
        diagnostics_profile: false
        tags:
            Ansible: azure_rm_acs

Возвращаемые значения

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

имя описание возвращается тип пример
state
Текущее состояние службы Azure контейнеров
всегда dict

Примечания

Примечание

  • Для аутентификации с 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 в среде.

Статус

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

Для получения помощи в разработке модулей, если вы так решите, ознакомьтесь с Информация о сообществе и сотрудничество, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_acs_module.html

Spec-Zone.ru

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