модуль azure.azcollection.azure_rm_hdinsightcluster — управление экземпляром кластера Azure HDInsight
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать этот модуль в плейбуке, укажите: azure.azcollection.azure_rm_hdinsightcluster.
Добавлено в azure.azcollection 0.1.2
Краткое описание
- Создание, обновление и удаление экземпляра кластера Azure HDInsight.
Требования
Следующие требования необходимы на узле, на котором выполняется этот модуль.
- 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. Значение по умолчанию По умолчанию: |
append_tags boolean | Указывает, является ли поле тегов каноническим или только дополняет существующие теги. Если поле каноническое, все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. Варианты:
|
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной окружения Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Определяет поведение проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной окружения |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, — имя среды (как определено в Azure Python SDK, например По умолчанию: |
cluster_definition dictionary | Определение кластера. |
|
gateway_rest_password string |
Пароль REST-шлюза. |
|
gateway_rest_username string |
Имя пользователя REST-шлюза. |
|
kind string |
Тип кластера. Варианты:
|
cluster_version string | Версия кластера. Например, |
compute_profile_roles list / elements=dictionary | Список ролей в кластере. |
|
linux_profile dictionary |
Профиль ОС Linux. |
|
password string |
Пароль SSH. |
|
username string |
Имя пользователя SSH. |
|
min_instance_count integer |
Минимальное количество экземпляров кластера. |
|
name string |
Имя роли. Варианты:
|
|
target_instance_count integer |
Количество экземпляров кластера. |
|
vm_size string |
Размер виртуальной машины. |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если задать значение true, обнаружение экземпляров и проверка центра сертификации будут полностью отключены. Эта функция предназначена для сценариев, в которых конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Обнаружение экземпляров включает получение метаданных центра сертификации с https://login.microsoft.com/ для проверки центра сертификации. Если задать значение **True**, проверка центра сертификации будет отключена. Поэтому крайне важно убедиться, что настроенный узел центра сертификации является допустимым и надежным. Задается в профиле файла учетных данных или с помощью переменной окружения Варианты:
|
identity dictionary добавлено в azure.azcollection 3.0.0 | Удостоверение кластера HDInsight. |
|
type string |
Тип управляемого удостоверения Варианты:
|
|
user_assigned_identities dictionary |
Назначенные пользователем управляемые удостоверения и их параметры По умолчанию: |
|
append boolean |
Указывает, нужно ли добавить список удостоверений к текущим удостоверениям (true) или заменить текущие удостоверения (false). Варианты:
|
|
id list / elements=string |
Список идентификаторов назначенных пользователем удостоверений, связанных с кластером HDInsight По умолчанию: |
location string | Расположение ресурса. Если не задано, по умолчанию используется расположение группы ресурсов. |
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. Также можно задать с помощью переменной окружения |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки. Файл должен содержать только необработанный токен. Этот метод обычно используется на платформах, которые сохраняют токены OIDC в виде файлов. Также можно задать с помощью переменной окружения |
os_type string | Тип операционной системы. Варианты:
|
password string | Пароль пользователя Active Directory. Используется при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
resource_group string / обязательный | Имя группы ресурсов. |
secret string | Секрет клиента Azure. Используется при аутентификации с помощью субъекта-службы. |
state string | Задает требуемое состояние кластера. Используйте Варианты:
|
storage_accounts list / elements=dictionary | Список учетных записей хранения в кластере. |
|
container string |
Контейнер в учетной записи хранения. |
|
is_default boolean |
Указывает, является ли учетная запись хранения учетной записью хранения по умолчанию. Варианты:
|
|
key string |
Ключ доступа к учетной записи хранения. |
|
name string |
Конечная точка хранилища больших двоичных объектов. Например, storage_account_name.blob.core.windows.net. |
subscription_id string | Идентификатор вашей подписки Azure. |
tags dictionary | Словарь пар «строка:строка», назначаемых объекту в качестве метаданных. Теги метаданных объекта будут обновлены с учетом всех предоставленных значений. Чтобы удалить теги, задайте для параметра append_tags значение false. В настоящее время в зонах Azure DNS и службах 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. |
tier string | Уровень кластера. Варианты:
|
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: Create instance of HDInsight Cluster
azure_rm_hdinsightcluster:
resource_group: myResourceGroup
name: myCluster
location: eastus2
cluster_version: 3.6
os_type: linux
tier: standard
cluster_definition:
kind: spark
gateway_rest_username: http-user
gateway_rest_password: "{{ password }}"
storage_accounts:
- name: myStorageAccount.blob.core.windows.net
is_default: true
container: myContainer
key: GExmaxH4lDNdHA9nwAsCt8t4AOQas2y9vXQP1kKALTram7Q3/5xLVIab3+nYG1x63Xyak9/VXxQyNBHA9pDWw==
compute_profile_roles:
- name: headnode
target_instance_count: 2
vm_size: Standard_D3
linux_profile:
username: sshuser
password: "{{ password }}"
- name: workernode
target_instance_count: 2
vm_size: Standard_D3
linux_profile:
username: sshuser
password: "{{ password }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
id string | Полностью квалифицированный идентификатор ресурса кластера. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_hdinsightcluster_module.html