модуль google.cloud.gcp_compute_node_group_info — сбор сведений о группе узлов GCP
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 string | Токен доступа OAuth2, если в качестве типа учетных данных выбран accesstoken. |
auth_kind string / обязательный | Тип используемых учетных данных. Варианты:
|
env_type string | Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Он изменяет только строку User Agent для всех запросов API. |
filters list / элементы=string | Список пар значений фильтров. Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый следующий фильтр в списке добавляется как условие AND (filter1 и filter2). |
project string | Проект Google Cloud Platform, который следует использовать. |
scopes list / элементы=string | Массив используемых областей доступа |
service_account_contents jsonarg | Содержимое JSON-файла учетной записи службы: словарь или строка JSON, представляющая его. |
service_account_email string | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию. |
service_account_file path | Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount. |
zone string / обязательный | Зона, в которой находится эта группа узлов. |
Примечания
Примечание
- Для аутентификации можно задать 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 complex | Список ресурсов Возвращается: всегда |
|
autoscalingPolicy complex |
Если для рабочих нагрузок используются узлы с выделенным хостингом, можно задействовать автомасштабирование группы узлов для автоматического управления ее размером. Возвращается: success |
|
maxNodes integer |
Максимальный размер группы узлов. Укажите значение не больше 100 и не меньше min-nodes. Возвращается: success |
|
minNodes integer |
Минимальный размер группы узлов. Должен быть меньше или равен max-nodes. Значение по умолчанию — 0. Возвращается: success |
|
mode string |
Режим автомасштабирования. Задайте одно из следующих значений: - OFF: отключает автомасштабирование. - ON: включает масштабирование как вверх, так и вниз. - ONLY_SCALE_OUT: включает только масштабирование вверх. Этот режим необходимо использовать, если группы узлов настроены на перезапуск размещенных на них виртуальных машин при минимальном количестве серверов. Возвращается: success |
|
creationTimestamp string |
Временная метка создания в текстовом формате RFC3339. Возвращается: success |
|
description string |
Необязательное текстовое описание ресурса. Возвращается: success |
|
maintenancePolicy string |
Указывает, как обрабатывать экземпляры во время обслуживания узла в группе. Возможные значения: DEFAULT, RESTART_IN_PLACE или MIGRATE_WITHIN_NODE_GROUP. Значение по умолчанию — DEFAULT. Возвращается: success |
|
maintenanceWindow complex |
Содержит свойства временного интервала обслуживания. Возвращается: success |
|
startTime string |
Время начала окна обслуживания экземпляров. Оно должно быть указано в формате UTC и соответствовать одному из значений: 00:00, 04:00, 08:00, 12:00, 16:00 или 20:00. Например, допустимы значения 13:00-5 и 08:00. Возвращается: success |
|
name string |
Имя ресурса. Возвращается: success |
|
nodeTemplate dictionary |
URL шаблона узла, к которому относится эта группа узлов. Возвращается: success |
|
size integer |
Общее количество узлов в группе узлов. Возвращается: success |
|
zone string |
Зона, в которой находится эта группа узлов. Возвращается: success |
Ссылки на коллекцию
© 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/google/cloud/gcp_compute_node_group_info_module.html
