Модуль azure.azcollection.azure_rm_hdinsightcluster – Управление экземпляром кластера Azure HDInsight

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.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 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"`
append_tags boolean	Используйте для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. Если канонический, любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices: `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. Choices: `"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`. Choices: `"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_definition dictionary	Определение кластера.
gateway_rest_password string	Пароль REST-шлюза.
gateway_rest_username string	Имя пользователя REST-шлюза.
kind string	Тип кластера. Choices: `"hadoop"` `"spark"` `"hbase"` `"storm"`
cluster_version string	Версия кластера. Например `3.6`.
compute_profile_roles list / elements=dictionary	Список ролей в кластере.
linux_profile dictionary	Профиль ОС Linux.
password string	Пароль SSH.
username string	Имя пользователя SSH.

min_instance_count integer	Минимальное количество экземпляров кластера.
name string	Имя роли. Выбираемые значения: `"headnode"` `"workernode"` `"zookepernode"`
target_instance_count integer	Количество экземпляров кластера.
vm_size string	Размер виртуальной машины.
disable_instance_discovery boolean добавлен в azure.azcollection 2.3.0	Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Установка в значение true полностью отключит как обнаружение экземпляров, так и проверку подлинности полномочий. Эта функция предназначена для использования в сценариях, когда метаданные endpoint недоступны, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает получение метаданных полномочий с https://login.microsoft.com/ для проверки полномочий. Установив это значение в True, проверка подлинности полномочий отключается. Поэтому крайне важно убедиться, что настроенный хост полномочий является корректным и надёжным. Устанавливается через профиль файла с данными или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Выбираемые значения: `false` ← (по умолчанию) `true`
location string	Расположение ресурса. Если не задано, в качестве значения по умолчанию используется расположение из группы ресурсов.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
name string / обязательно	Имя кластера.
os_type string	Тип операционной системы. Выбираемые значения: `"linux"`
password string	Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо службы-принципала.
profile string	Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group string / обязательно	Имя группы ресурсов.
secret string	Секрет клиента Azure. Используйте при аутентификации с помощью службы-принципала.
state string	Установить состояние кластера. Используйте `present` для создания или обновления кластера и `absent` для его удаления. Выбираемые значения: `"absent"` `"present"` ← (по умолчанию)
storage_accounts list / элементы=словарь	Список хранилищ данных в кластере.
container string	Контейнер в хранилище данных.
is_default boolean	Является ли хранилище данных хранилищем по умолчанию. Выбираемые значения: `false` `true`
key string	Ключ доступа к хранилищу данных.
name string	Конечная точка хранилища BLOB. Например, storage_account_name.blob.core.windows.net.
subscription_id string	Ваш идентификатор подписки Azure.

метки словарь	Словарь пар строка:строка, назначаемых в качестве метаданных для объекта. Метаданные метки объекта будут обновлены с любыми предоставленными значениями. Чтобы удалить метки, установите параметр append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использование пробелов в метке. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 меток для ресурсов.
арендатор строка	Идентификатор арендатора Azure. Используйте при аутентификации с помощью принципала службы.
отпечаток строка добавлено в azure.azcollection 1.14.0	Отпечаток частного ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью принципала службы. Требуется, если определён x509_certificate_path.
уровень строка	Уровень кластера. Варианты: `"standard"` `"premium"`
x509_certificate_path путь добавлено в azure.azcollection 1.14.0	Путь к сертификату X509, используемому для создания принципала службы в формате PEM. Сертификат должен быть добавлен к закрытому ключу. Используйте при аутентификации с помощью принципала службы.

Примечания

Примечание

Для аутентификации с 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 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: MuABCPassword!!@123
    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: MuABCPassword!!@123
      - name: workernode
        target_instance_count: 2
        vm_size: Standard_D3
        linux_profile:
          username: sshuser
          password: MuABCPassword!!@123

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

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

Ключ	Описание
id строка	Полный квалифицированный идентификатор ресурса кластера. Возвращается: всегда Пример: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.HDInsight/clusters/myCluster"`

Авторы

Zim Kalinowski (@zikalino)

Ссылки на сборку

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