Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_compute_node_group – создание NodeGroup в 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.

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

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

  • Представляет ресурс NodeGroup для управления группой выделенных узлов.

Требования

Перечисленные ниже компоненты должны быть установлены на хосте, на котором выполняется этот модуль.

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Параметры

Параметр

Комментарии

access_token

string

Токен доступа OAuth2, если в качестве типа учетных данных указано accesstoken.

auth_kind

string / обязательный

Тип используемых учетных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

autoscaling_policy

dictionary

Если вы используете выделенные узлы для своих рабочих нагрузок, можно использовать автомасштабировщик группы узлов для автоматического управления размером групп узлов.

max_nodes

integer / обязательный

Максимальный размер группы узлов. Укажите значение не больше 100 и не меньше min-nodes.

min_nodes

integer

Минимальный размер группы узлов. Значение должно быть не больше max-nodes. Значение по умолчанию — 0.

mode

string / обязательный

Режим автомасштабирования. Укажите один из следующих вариантов: - OFF: отключает автомасштабировщик.

- ON: включает масштабирование как вверх, так и вниз.

- ONLY_SCALE_OUT: включает только масштабирование вверх.

Этот режим необходимо использовать, если группы узлов настроены на перезапуск размещенных на них виртуальных машин на минимальных серверах.

Допустимые варианты: “OFF”, “ON”, “ONLY_SCALE_OUT”

description

string

Необязательное текстовое описание ресурса.

env_type

string

Указывает, в какой среде Ansible выполняется этот модуль.

Не задавайте это значение, если не знаете, что делаете.

Изменяется только строка User Agent для всех запросов API.

maintenance_policy

string

Указывает, как обрабатывать экземпляры во время обслуживания узла в группе. Укажите один из вариантов: DEFAULT, RESTART_IN_PLACE или MIGRATE_WITHIN_NODE_GROUP. Значение по умолчанию — DEFAULT.

По умолчанию: "DEFAULT"

maintenance_window

dictionary

содержит свойства временного интервала обслуживания.

start_time

string / обязательный

Время начала окна обслуживания instances. Оно должно быть указано в формате UTC и соответствовать одному из значений: 00:00, 04:00, 08:00, 12:00, 16:00 или 20:00. Например, допустимы значения 13:00-5 и 08:00.

name

string

Имя ресурса.

node_template

dictionary / обязательный

URL шаблона узла, к которому относится эта группа узлов.

Это поле представляет ссылку на ресурс NodeTemplate в GCP. Его можно указать двумя способами. Во-первых, можно поместить словарь с ключом ‘selfLink’ и значением selfLink вашего ресурса. В качестве альтернативы можно добавить `register: name-of-resource` в задачу gcp_compute_node_template, а затем присвоить полю node_template значение “{{ name-of-resource }}”

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.

size

integer / обязательный

Общее количество узлов в группе узлов.

state

string

Должен ли указанный объект существовать в GCP

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

zone

string / обязательный

Зона, в которой находится эта группа узлов.

Примечания

Примечание

  • Справочник API: https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups
  • Выделенные узлы: https://cloud.google.com/compute/docs/nodes/
  • для аутентификации можно задать 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: create a node template
  google.cloud.gcp_compute_node_template:
    name: "{{ resource_name }}"
    region: us-central1
    node_type: n1-node-96-624
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: node_template

- name: create a node group
  google.cloud.gcp_compute_node_group:
    name: test_object
    zone: us-central1-a
    description: example group for ansible
    size: 1
    node_template: "{{ node_template }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ

Описание

autoscalingPolicy

complex

Если вы используете выделенные узлы для своих рабочих нагрузок, можно использовать автомасштабировщик группы узлов для автоматического управления размером групп узлов.

Возвращается: при успехе

maxNodes

integer

Максимальный размер группы узлов. Укажите значение не больше 100 и не меньше min-nodes.

Возвращается: при успехе

minNodes

integer

Минимальный размер группы узлов. Значение должно быть не больше max-nodes. Значение по умолчанию — 0.

Возвращается: при успехе

mode

string

Режим автомасштабирования. Укажите один из следующих вариантов: - OFF: отключает автомасштабировщик.

- ON: включает масштабирование как вверх, так и вниз.

- ONLY_SCALE_OUT: включает только масштабирование вверх.

Этот режим необходимо использовать, если группы узлов настроены на перезапуск размещенных на них виртуальных машин на минимальных серверах.

Возвращается: при успехе

creationTimestamp

string

Временная метка создания в текстовом формате RFC3339.

Возвращается: при успехе

description

string

Необязательное текстовое описание ресурса.

Возвращается: при успехе

maintenancePolicy

string

Указывает, как обрабатывать экземпляры во время обслуживания узла в группе. Укажите один из вариантов: DEFAULT, RESTART_IN_PLACE или MIGRATE_WITHIN_NODE_GROUP. Значение по умолчанию — DEFAULT.

Возвращается: при успехе

maintenanceWindow

complex

содержит свойства временного интервала обслуживания.

Возвращается: при успехе

startTime

string

Время начала окна обслуживания instances. Оно должно быть указано в формате UTC и соответствовать одному из значений: 00:00, 04:00, 08:00, 12:00, 16:00 или 20:00. Например, допустимы значения 13:00-5 и 08:00.

Возвращается: при успехе

name

string

Имя ресурса.

Возвращается: при успехе

nodeTemplate

dictionary

URL шаблона узла, к которому относится эта группа узлов.

Возвращается: при успехе

size

integer

Общее количество узлов в группе узлов.

Возвращается: при успехе

zone

string

Зона, в которой находится эта группа узлов.

Возвращается: при успехе

Авторы

  • Google Inc. (@googlecloudplatform)

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

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

© 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_module.html

Spec-Zone.ru

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