Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_openshiftmanagedcluster_info — получение сведений об управляемом кластере Azure Red Hat OpenShift

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_openshiftmanagedcluster_info.

Добавлено в azure.azcollection 1.11.0

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

Краткое описание

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

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

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

Параметры

Параметр

Комментарии

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"

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; в противном случае используется подписка Azure 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"

disable_instance_discovery

boolean

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

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

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

Варианты:

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

log_mode

string

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

log_path

string

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

name

string

Имя ресурса.

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.

resource_group

string

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

secret

string

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

subscription_id

string

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

tenant

string

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

thumbprint

string

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

Отпечаток закрытого ключа, указанного в x509_certificate_path.

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

Обязателен, если задан x509_certificate_path.

x509_certificate_path

path

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

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

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

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

Примечания

Примечание

  • Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль из ~/.azure/credentials или выполнить вход перед запуском задач или плейбука с помощью az login.
  • Аутентификация также возможна с помощью субъекта-службы или пользователя Active Directory.
  • Для аутентификации через OIDC передайте client_id, tenant и oidc_token либо oidc_token_file_path или задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN либо AZURE_FEDERATED_TOKEN_FILE.
  • Для аутентификации с помощью субъекта-службы передайте 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: List all Azure Red Hat OpenShift Managed Clusters for a given subscription
  azure_rm_openshiftmanagedcluster_info:
- name: List all Azure Red Hat OpenShift Managed Clusters for a given resource group
  azure_rm_openshiftmanagedcluster_info:
    resource_group: myResourceGroup
- name: Get Azure Red Hat OpenShift Managed Clusters
  azure_rm_openshiftmanagedcluster_info:
    resource_group: myResourceGroup
    name: myAzureFirewall

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

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

Ключ

Описание

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"

Авторы

  • Paul Czarkowski (@paulczar)

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

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

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

Spec-Zone.ru

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