Spec-Zone.ru › Ansible 2.10

azure.azcollection.azure_rm_openshiftmanagedcluster – Управление экземпляром управляемого кластера Azure Red Hat OpenShift

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в книге задач укажите: azure.azcollection.azure_rm_openshiftmanagedcluster.

Новое в версии 1.2.0: из azure.azcollection

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

Описание

  • Создание, обновление и удаление экземпляра управляемого кластера Azure Red Hat OpenShift.

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
adfs_authority_url
строка
добавлено в 0.0.1 azure.azcollection
URL авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизацией ADFS.
api_profile
строка
добавлено в 0.0.1 azure.azcollection
По умолчанию:
"latest"
Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для публичных облаков; будущие значения позволят использовать Azure Stack.
api_server_profile
словарь
Настройка API-сервера.
ip
строка
IP-адрес API-сервера (неизменяемый), отображается только в ответе.
url
строка
URL API-сервера (неизменяемый), отображается только в ответе.
visibility
строка
    Варианты:
  • Public ←
  • Private
Видимость API-сервера.
append_tags
логическое значение
    Варианты:
  • no
  • yes ←
Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам.
При каноническом значении любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.
auth_source
строка
добавлено в 0.0.1 azure.azcollection
    Варианты:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Также может быть задан через переменную окружения 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.
cert_validation_mode
строка
добавлено в 0.0.1 azure.azcollection
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.
client_id
строка
Идентификатор клиента Azure. Используется при аутентификации с сервисным принципалом.
cloud_environment
строка
добавлено в 0.0.1 azure.azcollection
По умолчанию:
"AzureCloud"
Для облачных сред, отличных от публичного облака США, используется имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL точки входа для обнаружения метаданных (необходимо для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.
cluster_profile
словарь
По умолчанию:
{}
Настройка для кластера OpenShift.
cluster_resource_group_id
строка
Идентификатор группы ресурсов кластера (неизменяемый).
domain
строка
Домен кластера (неизменяемый).
pull_secret
строка
По умолчанию:
""
Секрет pull для кластера (неизменяемый).
version
строка
Версия OpenShift (неизменяемая).
ingress_profiles
список / элементы=строка
Настройка профилей Ingress. В текущей версии API поддерживается только один профиль.
ip
строка
IP Ingress (неизменяемый), отображается только в ответе.
name
строка
    Варианты:
  • default ←
Имя Ingress (неизменяемое).
visibility
строка
    Варианты:
  • Public ←
  • Private
Видимость Ingress.
location
строка / обязательно
Расположение ресурса.
master_profile
словарь
Настройка для OpenShift мастер-виртуальных машин.
subnet_id
строка / обязательно
Идентификатор Azure ресурса мастер-подсети (неизменяемый).
vm_size
строка
    Варианты:
  • Standard_D2s_v3
  • Standard_D4s_v3
  • Standard_D8s_v3
Размер виртуальных машин агента (неизменяемый).
name
строка / обязательно
Имя ресурса.
network_profile
словарь
По умолчанию:
{"pod_cidr": "10.128.0.0/14", "service_cidr": "172.30.0.0/16"}
Настройка для OpenShift сети (неизменяемый).
pod_cidr
строка
CIDR для OpenShift Pods (неизменяемый).
service_cidr
строка
CIDR для OpenShift Services (неизменяемый).
password
строка
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
provisioning_state
строка
Текущее состояние развертывания или подготовки, отображается только в ответе.
resource_group
строка / обязательно
Имя группы ресурсов.
secret
строка
Секрет клиента Azure. Используется при аутентификации с сервисным принципалом.
service_principal_profile
словарь
Сервисный принцип.
client_id
строка / обязательно
Идентификатор клиента сервисного принципала (неизменяемый).
client_secret
строка / обязательно
Секрет клиента сервисного принципала (неизменяемый).
state
строка
    Варианты:
  • absent
  • present ←
Утверждает состояние OpenShiftManagedCluster.
Используйте present для создания или обновления OpenShiftManagedCluster и absent для его удаления.
subscription_id
строка
Ваш идентификатор подписки Azure.
tags
словарь
Словарь пар строка:строка для назначения метаданных объекту.
Метаданные теги объекта будут обновлены с предоставленными значениями.
Для удаления тегов установите опцию append_tags в false.
tenant
строка
Идентификатор Azure-аренды. Используется при аутентификации с сервисным принципалом.
worker_profiles
список / элементы=строка
Настройка для OpenShift worker-виртуальных машин.
count
целое число
Количество worker-виртуальных машин. Должно быть от 3 до 20 (неизменяемое).
disk_size
integer
Размер диска виртуальных машин рабочих узлов в ГБ. Должно быть 128 или более (неизменяемо).
name
string / required
    Choices:
  • worker
Имя профиля рабочего узла (неизменяемо).
subnet_id
string / required
Идентификатор Azure ресурса подсети рабочего узла (неизменяемо).
vm_size
string
    Choices:
  • Standard_D2s_v3
  • Standard_D4s_v3
  • Standard_D8s_v3
Размер виртуальных машин рабочих узлов (неизменяемо).

Примечания

Примечание

  • Для аутентификации с Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или выполнить вход перед запуском задач или плейбука с помощью 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. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

См. также

Вход с помощью Azure CLI

Как выполнить аутентификацию с помощью команды az login.

Примеры

- name: Create openshift cluster
  azure_rm_openshiftmanagedcluster:
    resource_group: "myResourceGroup"
    name: "myCluster"
    location: "eastus"
    cluster_profile:
      cluster_resource_group_id: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/clusterResourceGroup"
      domain: "mydomain"
    service_principal_profile:
      client_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
      client_secret: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    network_profile:
      pod_cidr: "10.128.0.0/14"
      service_cidr: "172.30.0.0/16"
    worker_profiles:
      - vm_size : "Standard_D4s_v3"
        subnet_id : "/subscriptions/xx-xx-xx-xx-xx/resourceGroups/myResourceGroup/Microsoft.Network/virtualNetworks/myVnet/subnets/worker"
        disk_size : 128
        count : 3
    master_profile:
      vm_size : "Standard_D8s_v3"
      subnet_id: "/subscriptions/xx-xx-xx-xx-xx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/master"
- name: Delete OpenShift Managed Cluster
  azure_rm_openshiftmanagedcluster:
    resource_group: myResourceGroup
    name: myCluster
    location: eastus
    state: absent

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

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

Ключ Возвращено Описание
id
string
всегда
Идентификатор ресурса.

Пример:
/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.RedHatOpenShift/openShiftClusters/mycluster
location
string
всегда
Расположение ресурса.

Пример:
eatus
name
string
всегда
Имя ресурса.

Пример:
mycluster
properties
complex
всегда
Свойства управляемого кластера OpenShift.
apiserverProfile
complex
всегда
Конфигурация API-сервера.
visibility
string
всегда
Видимость API-сервера.

Пример:
Public
clusterProfile
complex
всегда
Конфигурация кластера Openshift.
domain
string
всегда
Домен кластера.

Пример:
mycluster
resourceGroupId
string
всегда
Идентификатор группы ресурсов кластера.

Пример:
/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus-cluster
version
string
всегда
Версия OpenShift.

Пример:
4.4.17
ingressProfiles
list / elements=string
всегда
Конфигурация Ingress.

Пример:
[{'name': 'default', 'visibility': 'Public'}]
masterProfile
complex
всегда
Конфигурация виртуальных машин OpenShift master.
subnetId
string
всегда
Идентификатор Azure ресурса подсети master (неизменяемо).

Пример:
/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.Network/ virtualNetworks/mycluster-vnet/subnets/mycluster-worker
vmSize
string
всегда
Размер виртуальных машин агента (неизменяемо).

Пример:
Standard_D8s_v3
networkProfile
complex
всегда
Конфигурация сети OpenShift.
podCidr
string
всегда
CIDR для OpenShift Pods.

Пример:
10.128.0.0/14
serviceCidr
string
всегда
CIDR для OpenShift Services.

Пример:
172.30.0.0/16
provisioningState
string
всегда
Текущее состояние развертывания или подготовки, которое появляется только в ответе.

Пример:
Creating
servicePrincipalProfile
complex
всегда
Профиль службы-принципала.
clientId
string
всегда
Идентификатор клиента службы-принципала.

Пример:
xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx
workerProfiles
complex
всегда
Конфигурация виртуальных машин кластера OpenShift.
count
integer
всегда
Количество агентов (виртуальных машин) для размещения контейнеров docker.

Пример:
3
diskSizeGB
integer
всегда
Размер диска в ГБ.

Пример:
128
name
string
всегда
Уникальное имя профиля пула в контексте подписки и группы ресурсов.

Пример:
worker
subnetId
string
всегда
Идентификатор подсети для пула рабочих узлов.

Пример:
/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.Network/ virtualNetworks/mycluster-vnet/subnets/mycluster-worker
vmSize
string
всегда
Размер виртуальных машин агента.

Пример:
Standard_D4s_v3
type
string
всегда
Тип ресурса.

Пример:
Microsoft.RedHatOpenShift/openShiftClusters


Авторы

  • Haiyuan Zhang (@haiyuazhang)

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

Spec-Zone.ru

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