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

ad_user

string

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

adfs_authority_url

string

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

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

api_profile

string

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

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

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

api_server_profile

dictionary

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

ip

string

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

url

string

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

visibility

string

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

Варианты:

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

append_tags

boolean

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

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

Варианты:

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

auth_source

string

добавлено в 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" ← (по умолчанию)
• "cli"
• "credential_file"
• "env"
• "msi"

cert_validation_mode

string

добавлено в 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

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

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

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

cluster_profile

dictionary

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

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

cluster_resource_group_id

string

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

domain

string

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

fips_validated_modules

string

Используются ли криптографические модули, прошедшие проверку FIPS

Варианты:

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

pull_secret

string

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

version

string

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

disable_instance_discovery

boolean

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

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

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

Варианты:

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

ingress_profiles

list / elements=dictionary

Конфигурация профилей входящего трафика. В текущей версии API поддерживается только один профиль.

ip

string

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

name

string

Имя входящего трафика (неизменяемое).

Варианты:

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

visibility

string

Видимость входящего трафика.

Варианты:

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

location

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

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

log_mode

string

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

log_path

string

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

master_profile

dictionary

Конфигурация главных виртуальных машин OpenShift.

disk_encryption_set_id

string

Идентификатор связанного DiskEncryptionSet, если применимо.

encryption_at_host

string

Шифруются ли главные виртуальные машины на узле.

Варианты:

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

subnet_id

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

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

vm_size

string

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

name

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

Имя ресурса.

network_profile

dictionary

Конфигурация сети OpenShift (неизменяемая).

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

outbound_type

string

Тип исходящего трафика, используемый для передачи данных наружу.

Варианты:

• "Loadbalancer"
• "UserDefinedRouting"

pod_cidr

string

Диапазон CIDR для подов OpenShift (неизменяемый).

preconfigured_nsg

string

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

Варианты:

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

service_cidr

string

Диапазон CIDR для служб OpenShift (неизменяемый).

oidc_token

string

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

Токен OpenID Connect (OIDC) (JWT), используемый напрямую для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC.

Полезно в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

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

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только необработанный токен.

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

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

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

dictionary

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

Метаданные тегов объекта будут обновлены с учетом всех указанных значений.

Чтобы удалить теги, задайте для параметра 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

list / elements=dictionary

Конфигурация виртуальных машин рабочих узлов OpenShift.

count

integer

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

disk_encryption_set_id

string

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

disk_size

integer

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

encryption_at_host

string

Шифруются ли виртуальные машины рабочих узлов на уровне узла размещения.

Варианты:

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

name

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

Имя профиля рабочих узлов (неизменяемое значение).

Варианты:

• "worker"

subnet_id

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

Идентификатор ресурса Azure подсети рабочих узлов (неизменяемое значение).

vm_size

string

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

x509_certificate_path

path

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

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

Закрытый ключ должен быть добавлен в конец сертификата.

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

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"

fipsValidatedModules

string

Используются ли криптографические модули, прошедшие проверку FIPS

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

Пример: "Enabled"

resourceGroupId

string

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

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

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

version

string

Версия OpenShift.

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

Пример: "4.4.17"

ingressProfiles

list / elements=string

Конфигурация входящего трафика.

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

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

masterProfile

complex

Конфигурация главных виртуальных машин OpenShift.

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

disk_encryption_set_id

string

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

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

encryptionAtHost

string

Шифруются ли главные виртуальные машины на уровне узла размещения.

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

Пример: "Disabled"

subnetId

string

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

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

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

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

outboundType

string

Тип исходящего подключения, используемый для исходящего трафика.

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

Пример: "Loadbalancer"

podCidr

string

Диапазон CIDR для модулей OpenShift.

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

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

preconfiguredNSG

string

Указывает, предварительно ли привязаны к подсетям группы безопасности сети (NSG)

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

Пример: "Disabled"

serviceCidr

string

Диапазон CIDR для служб OpenShift.

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

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

encryptionAtHost

string

Шифруются ли виртуальные машины рабочих узлов на уровне узла размещения.

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

Пример: "Disabled"

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"