Модуль google.cloud.gcp_compute_node_group — Создаёт группу узлов 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.
Описание
- Представляет ресурс NodeGroup для управления группой узлов с выделенными ресурсами.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа OAuth2, если тип учетных данных — accesstoken. |
auth_kind строка / обязательно | Тип используемых учетных данных. Варианты:
|
autoscaling_policy словарь | Если для ваших рабочих нагрузок используются узлы с выделенным тенантом, вы можете использовать автоматическое масштабирование групп узлов для автоматического управления размерами ваших групп узлов. |
|
max_nodes целое число / обязательно |
Максимальный размер группы узлов. Установите значение меньше или равное 100 и больше или равное min-nodes. |
|
min_nodes целое число |
Минимальный размер группы узлов. Должно быть меньше или равно max-nodes. Значение по умолчанию — 0. |
|
mode строка / обязательно |
Режим автоматического масштабирования. Установите значение одного из следующих: — OFF: Отключает автоматическое масштабирование.
Этот режим необходимо использовать, если ваши группы узлов настроены на перезапуск размещенных виртуальных машин на минимальных серверах. Некоторые допустимые значения включают: «OFF», «ON», «ONLY_SCALE_OUT» |
description строка | Необязательное текстовое описание ресурса. |
env_type строка | Указывает, в какой среде Ansible вы выполняете этот модуль. Это не должно быть установлено, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API. |
maintenance_policy строка | Указывает, как обрабатывать экземпляры, когда узел в группе проходит техническое обслуживание. Установите значение одного из: DEFAULT, RESTART_IN_PLACE или MIGRATE_WITHIN_NODE_GROUP. Значение по умолчанию — DEFAULT. По умолчанию: |
maintenance_window словарь | содержит свойства для временного интервала технического обслуживания. |
|
start_time строка / обязательно |
время начала экземпляров интервала. Это должно быть в формате UTC, которое разрешается на 00:00, 04:00, 08:00, 12:00, 16:00 или 20:00. Например, 13:00-5 и 08:00 являются допустимыми. |
name строка | Имя ресурса. |
node_template словарь / обязательно | URL шаблона узла, к которому принадлежит эта группа узлов. Это поле представляет ссылку на ресурс NodeTemplate в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом ‘selfLink’ и значением selfLink вашего ресурса. Кроме того, вы можете добавить `register: name-of-resource` в задачу gcp_compute_node_template, а затем установить это поле node_template на «{{ name-of-resource }}» |
project строка | Проект Google Cloud Platform, который следует использовать. |
scopes список / элементы=строка | Массив используемых областей. |
service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в словаре, либо как строка JSON, представляющая его. |
service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию. |
service_account_file путь | Путь к файлу JSON учетной записи службы, если serviceaccount выбран в качестве типа. |
size целое число / обязательно | Общее количество узлов в группе узлов. |
state строка | Должен ли заданный объект существовать в 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. - Для аутентификации можно установить 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 сложный | Если для ваших рабочих нагрузок используются узлы с выделенным тенантом, вы можете использовать автомасштабирование группы узлов для автоматического управления размерами групп узлов. Возвращается: успех |
|
maxNodes целое число |
Максимальный размер группы узлов. Устанавливается в значение, меньшее или равное 100 и большее или равное min-узлов. Возвращается: успех |
|
minNodes целое число |
Минимальный размер группы узлов. Должен быть меньше или равен max-узлов. Значение по умолчанию — 0. Возвращается: успех |
|
mode строка |
Режим автомасштабирования. Устанавливается в одно из следующих значений: - ВЫКЛ.: отключает автомасштабирование.
Этот режим необходимо использовать, если ваши группы узлов настроены на перезапуск их размещенных виртуальных машин на минимальных серверах. Возвращается: успех |
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_module.html