Модуль google.cloud.gcp_compute_node_group_info — Сбор информации о группе узлов GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.4.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить ее, используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. Требования.
Для использования в книге задач укажите: google.cloud.gcp_compute_node_group_info.
Обзор
- Сбор информации о группе узлов GCP
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
env_type строка | Указывает, в какой среде Ansible выполняется данный модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов к API. |
filters список / элементы=строка | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2). |
project строка | Проект Google Cloud Platform для использования. |
scopes список / элементы=строка | Массив используемых областей |
service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, представленного либо в виде словаря, либо в виде строки JSON. |
service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. |
service_account_file путь | Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount. |
zone строка / обязательно | Зона расположения данной группы узлов. |
Примечания
Примечание
- для аутентификации можно задать service_account_file, используя переменную среды
GCP_SERVICE_ACCOUNT_FILE. - для аутентификации можно задать service_account_contents, используя переменную среды
GCP_SERVICE_ACCOUNT_CONTENTS. - для аутентификации можно задать service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно задать access_token, используя переменную среды
GCP_ACCESS_TOKEN. - для аутентификации можно задать auth_kind, используя переменную среды
GCP_AUTH_KIND. - для аутентификации можно задать scopes, используя переменную среды
GCP_SCOPES. - значения переменных среды будут использоваться только в том случае, если значения в книге задач не заданы.
- параметры service_account_email и service_account_file взаимно исключают друг друга.
Примеры
- name: get info on a node group
gcp_compute_node_group_info:
zone: us-central1-a
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
resources сложное | Список ресурсов Возвращается: всегда |
|
autoscalingPolicy сложное |
Если для своих рабочих нагрузок вы используете узлы с полным выделением ресурсов, вы можете использовать автоматический масштабировщик групп узлов для автоматического управления размерами групп узлов. Возвращается: успешно |
|
maxNodes целое число |
Максимальный размер группы узлов. Устанавливается значением, меньшим или равным 100 и большим или равным min-nodes. Возвращается: успешно |
|
minNodes целое число |
Минимальный размер группы узлов. Должно быть меньше или равно max-nodes. Значение по умолчанию равно 0. Возвращается: успешно |
|
mode строка |
Режим автоматического масштабирования. Устанавливается в одно из следующих значений: - OFF: Отключает автоматический масштабировщик.
Этот режим необходимо использовать, если ваши группы узлов настроены на перезапуск размещенных виртуальных машин при минимальном числе серверов. Возвращается: успешно |
|
creationTimestamp строка |
Дата и время создания в формате RFC3339. Возвращается: успешно |
|
description строка |
Необязательное текстовое описание ресурса. Возвращается: успешно |
|
maintenancePolicy строка |
Указывает, как обработать экземпляры при проведении технического обслуживания узла в группе. Устанавливается в одно из значений: DEFAULT, RESTART_IN_PLACE или MIGRATE_WITHIN_NODE_GROUP. Значение по умолчанию — DEFAULT. Возвращается: успешно |
|
maintenanceWindow сложное |
содержит свойства для временных рамок технического обслуживания. Возвращается: успешно |
|
startTime строка |
Время начала окна для экземпляров. Оно должно быть в формате UTC, соответствующем одному из значений 00:00, 04:00, 08:00, 12:00, 16:00 или 20:00. Например, 13:00-5 и 08:00 — допустимые значения. Возвращается: успешно |
|
name строка |
Имя ресурса. Возвращается: успешно |
|
nodeTemplate словарь |
URL шаблона узла, к которому принадлежит эта группа узлов. Возвращается: успешно |
|
size целое число |
Общее количество узлов в группе узлов. Возвращается: успешно |
|
zone строка |
Зона расположения этой группы узлов. Возвращается: успешно |
Ссылки на коллекции
© 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/google/cloud/gcp_compute_node_group_info_module.html
