google.cloud.gcp_compute_node_group – Создаёт группу узлов GCP

Примечание

Этот плагин входит в сборку google.cloud (версия 1.0.2).

Для его установки используйте: 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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно		application machineaccount serviceaccount	Тип используемых учетных данных.
autoscaling_policy словарь			Если вы используете узлы с выделенными ресурсами для своих рабочих нагрузок, вы можете использовать автомасштабирование групп узлов для автоматического управления размерами ваших групп узлов.
	max_nodes целое число / обязательно		Максимальный размер группы узлов. Установите значение меньше или равное 100 и больше или равное min-nodes.
	min_nodes целое число		Минимальный размер группы узлов. Должно быть меньше или равно max-nodes. Значение по умолчанию — 0.
	mode строка / обязательно		Режим автомасштабирования. Установите одно из следующих значений: - OFF: Отключает автомасштабирование. - ON: Включает масштабирование в и масштабирование наружу. - ONLY_SCALE_OUT: Включает только масштабирование наружу. Вам необходимо использовать этот режим, если ваши группы узлов настроены на перезапуск размещённых виртуальных машин на минимальных серверах. Допустимые значения: "OFF", "ON", "ONLY_SCALE_OUT"
description строка			Дополнительное текстовое описание ресурса.
env_type строка			Указывает, в какой среде Ansible вы запускаете этот модуль. Не устанавливайте, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API.
maintenance_policy строка		По умолчанию: "DEFAULT"	Указывает, как обрабатывать экземпляры, когда узел в группе проходит техническое обслуживание. Установите одно из значений: DEFAULT, RESTART_IN_PLACE или MIGRATE_WITHIN_NODE_GROUP. Значение по умолчанию — DEFAULT.
name строка			Имя ресурса.
node_template словарь / обязательно			URL шаблона узла, к которому принадлежит эта группа узлов. Это поле представляет собой ссылку на ресурс NodeTemplate в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Во-вторых, вы можете добавить `register: имя-ресурса` в задачу gcp_compute_node_template, а затем установить это поле node_template в "{{ имя-ресурса }}".
project строка			Проект Google Cloud Platform для использования.
scopes список / элементы=строка			Массив используемых областей.
service_account_contents jsonarg			Содержимое файла JSON учетной записи службы, либо в словаре, либо в виде JSON-строки, представляющей его.
service_account_email строка			Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь			Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
size целое число / обязательно			Общее количество узлов в группе узлов.
state строка		present ← absent	Существует ли данный объект в GCP
zone строка / обязательно			Зона расположения этой группы узлов.

Примечания

Примечание

Ссылка на 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.
для аутентификации можно установить 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 сложное		успешно	Если вы используете узлы с выделенными ресурсами для своих рабочих нагрузок, вы можете использовать автомасштабирование групп узлов для автоматического управления размерами ваших групп узлов.
	maxNodes целое число	успешно	Максимальный размер группы узлов. Установите значение меньше или равно 100 и больше или равно min-nodes.
	minNodes целое число	успешно	Минимальный размер группы узлов. Должно быть меньше или равно max-nodes. Значение по умолчанию — 0.
	mode строка	успешно	Режим автомасштабирования. Установите одно из следующих значений: - OFF: Отключает автомасштабирование. - ON: Включает масштабирование в и масштабирование наружу. - ONLY_SCALE_OUT: Включает только масштабирование наружу. Вам необходимо использовать этот режим, если ваши группы узлов настроены на перезапуск размещённых виртуальных машин на минимальных серверах.
creationTimestamp строка		успешно	Дата и время создания в формате RFC3339.
description строка		успешно	Дополнительное текстовое описание ресурса.
maintenancePolicy строка		успешно	Указывает, как обрабатывать экземпляры, когда узел в группе проходит техническое обслуживание. Установите одно из значений: DEFAULT, RESTART_IN_PLACE или MIGRATE_WITHIN_NODE_GROUP. Значение по умолчанию — DEFAULT.
name строка		успешно	Имя ресурса.
nodeTemplate словарь		успешно	URL шаблона узла, к которому принадлежит эта группа узлов.
size целое число		успешно	Общее количество узлов в группе узлов.
zone строка		успешно	Зона расположения этой группы узлов.

Авторы

Google Inc. (@googlecloudplatform)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_node_group_module.html