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

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"

api_server_profile

dictionary

Конфигурация сервера API.

ip

string

IP-адрес сервера API (неизменяемый), отображается только в ответе.

url

string

URL-адрес сервера API (неизменяемый), отображается только в ответе.

visibility

string

Видимость сервера API.

Варианты:

• "Public" ← (default)
• "Private"

append_tags

boolean

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

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

Варианты:

• 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.

Варианты:

• "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.

Варианты:

• "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"

cluster_profile

dictionary

Конфигурация кластера OpenShift.

Default: {}

cluster_resource_group_id

string

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

domain

string

Домен для кластера (неизменяемый).

pull_secret

string

Секрет извлечения для кластера (неизменяемый).

version

string

Версия Openshift (неизменяемая).

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

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

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

Варианты:

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

ingress_profiles

list / elements=dictionary

Настройка профилей Ingress. В текущей версии API поддерживается только один профиль.

ip

string

IP Ingress (неизменяемый), появляется только в ответе.

name

string

Имя Ingress (неизменяемый).

Варианты:

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

visibility

string

Видимость Ingress.

Варианты:

• "Public" ← (по умолчанию)
• "Private"

location

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

Расположение ресурса.

log_mode

string

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

log_path

string

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

master_profile

dictionary

Настройка виртуальных машин OpenShift master.

subnet_id

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

Идентификатор Azure ресурса подсети master (неизменяемый).

vm_size

string

Размер виртуальных машин агентов (неизменяемый).

Варианты:

• "Standard_D8s_v3"
• "Standard_D16s_v3"
• "Standard_D32s_v3"

name

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

Имя ресурса.

network_profile

dictionary

Настройка сети OpenShift (неизменяемая).

По умолчанию: {"pod_cidr": "10.128.0.0/14", "service_cidr": "172.30.0.0/16"}

pod_cidr

string

CIDR для OpenShift Pods (неизменяемый).

service_cidr

string

CIDR для OpenShift Services (неизменяемый).

password

string

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

profile

string

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

provisioning_state

string

Текущее состояние развертывания или подготовки, которое появляется только в ответе.

resource_group

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

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

secret

string

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

service_principal_profile

dictionary

принципал службы.

client_id

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

Идентификатор клиента службы-принципала (неизменяемый).

client_secret

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

Секретный ключ клиента службы-принципала (неизменяемый).

state

string

Указывает состояние OpenShiftManagedCluster.

Используйте present для создания или обновления OpenShiftManagedCluster и absent для удаления.

Выбор:

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

subscription_id

string

Идентификатор вашей подписки Azure.

tags

словарь

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

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

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

В настоящее время зоны DNS Azure и службы 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.

worker_profiles

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

Настройка виртуальных машин OpenShift worker.

count

целое число

Количество виртуальных машин worker. Должно быть от 3 до 20 (неизменяемо).

disk_size

целое число

Размер диска виртуальных машин worker в ГБ. Должно быть 128 или больше (неизменяемо).

name

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

Имя профиля worker (неизменяемо).

Выбор:

• "worker"

subnet_id

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

Идентификатор ресурса подсети worker Azure (неизменяемо).

vm_size

строка

Размер виртуальных машин worker (неизменяемо).

Выбор:

• "Standard_D4s_v3"
• "Standard_D8s_v3"

x509_certificate_path

путь

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

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

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

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

id

строка

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

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

Пример: "/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.RedHatOpenShift/openShiftClusters/mycluster"

location

строка

Расположение ресурса.

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

Пример: "eatus"

name

строка

Имя ресурса.

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

Пример: "mycluster"

properties

сложный

Свойства управляемого кластера OpenShift.

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

apiserverProfile

сложный

Настройка API-сервера.

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

visibility

строка

Видимость API-сервера.

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

Пример: "Public"

clusterProfile

сложный

Настройка кластера OpenShift.

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

domain

строка

Домен кластера.

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

Пример: "mycluster"

resourceGroupId

строка

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

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

Пример: "/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus-cluster"

version

строка

Версия OpenShift.

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

Пример: "4.4.17"

ingressProfiles

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

Настройка Ingress.

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

Пример: [{"name": "default", "visibility": "Public"}]

masterProfile

сложный

Настройка OpenShift мастер-виртуальных машин.

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

subnetId

строка

Идентификатор Azure ресурса мастер-подсети (неизменяемый).

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

Пример: "/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.Network/ virtualNetworks/mycluster-vnet/subnets/mycluster-worker"

vmSize

строка

Размер виртуальных машин агентов (неизменяемый).

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

Пример: "Standard_D8s_v3"

networkProfile

сложный

Настройка сети OpenShift.

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

podCidr

строка

CIDR для OpenShift Pods.

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

Пример: "10.128.0.0/14"

serviceCidr

строка

CIDR для OpenShift Services.

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

Пример: "172.30.0.0/16"

provisioningState

строка

Текущее состояние развертывания или подготовки, которое отображается только в ответе.

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

Пример: "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"