Модуль google.cloud.gcp_compute_region_instance_group_manager — создает GCP RegionInstanceGroupManager

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_compute_region_instance_group_manager.

Обзор
Требования
Параметры
Примеры
Возвращаемые значения

Обзор

Создает управляемую группу экземпляров на основе сведений, указанных в запросе. После создания группы планируется действие по созданию в ней экземпляров с использованием указанного шаблона экземпляра. Эта операция получает статус DONE сразу после создания группы, даже если экземпляры в ней еще не созданы. Необходимо отдельно проверить состояние каждого экземпляра.
Управляемая группа экземпляров может содержать до 1000 экземпляров VM.

Требования

На узле, выполняющем этот модуль, требуются следующие компоненты.

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

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
auto_healing_policies list / elements=dictionary	Политика автоматического восстановления для этой управляемой группы экземпляров.
health_check string	URL проверки работоспособности, запускающей автоматическое восстановление.
initial_delay_sec integer	Количество секунд, в течение которых управляемая группа экземпляров ожидает, прежде чем применить политики автоматического восстановления к новым или недавно пересозданным экземплярам.
base_instance_name string / обязательный	Базовое имя экземпляров в этой группе. Длина значения должна составлять от 1 до 58 символов. Имена экземпляров формируются добавлением дефиса и случайной четырехсимвольной строки к базовому имени. Базовое имя экземпляра должно соответствовать RFC1035.
description string	Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Он изменяет только строку User Agent для запросов API.
instance_template dictionary / обязательный	Шаблон экземпляра, указанный для этой управляемой группы экземпляров. Группа использует этот шаблон для создания всех новых экземпляров в управляемой группе. Это поле содержит ссылку на ресурс InstanceTemplate в GCP. Его можно задать двумя способами. Во-первых, можно указать словарь с ключом ‘selfLink’ и значением selfLink ресурса. Также можно добавить `register: name-of-resource` в задачу gcp_compute_instance_template, а затем присвоить полю instance_template значение “{{ name-of-resource }}”
name string / обязательный	Имя управляемой группы экземпляров. Длина имени должна составлять от 1 до 63 символов; оно должно соответствовать RFC1035.
named_ports list / elements=dictionary	Именованные порты, настроенные для групп экземпляров, связанных с этим менеджером групп экземпляров.
name string	Имя этого именованного порта. Длина имени должна составлять от 1 до 63 символов; оно должно соответствовать RFC1035.
port integer	Номер порта — значение от 1 до 65535.
project string	Проект Google Cloud Platform, который необходимо использовать.
region string / обязательный	Регион, в котором находится управляемая группа экземпляров.
scopes list / elements=string	Массив используемых областей действия
service_account_contents jsonarg	Содержимое JSON-файла учетной записи службы — в виде словаря или JSON-строки, представляющей его.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбрано machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file path	Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount.
state string	Должен ли указанный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`
target_pools list / elements=dictionary	Ресурсы TargetPool, в которые добавляются экземпляры из поля instanceGroup. Целевые пулы автоматически применяются ко всем экземплярам управляемой группы экземпляров.
target_size integer	Целевое количество работающих экземпляров в этой управляемой группе экземпляров. Удаление экземпляров или отказ от них уменьшает это число. Изменение размера группы меняет это число.

Примеры

- name: create a network
  google.cloud.gcp_compute_network:
    name: network-instancetemplate
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: network

- name: create a address
  google.cloud.gcp_compute_address:
    name: address-instancetemplate
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: address

- name: create a instance template
  google.cloud.gcp_compute_instance_template:
    name: "{{ resource_name }}"
    properties:
      disks:
      - auto_delete: 'true'
        boot: 'true'
        initialize_params:
          source_image: projects/ubuntu-os-cloud/global/images/family/ubuntu-1604-lts
      machine_type: n1-standard-1
      network_interfaces:
      - network: "{{ network }}"
        access_configs:
        - name: test-config
          type: ONE_TO_ONE_NAT
          nat_ip: "{{ address }}"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: instancetemplate

- name: create a region instance group manager
  google.cloud.gcp_compute_region_instance_group_manager:
    name: test_object
    base_instance_name: test1-child
    region: us-central1
    instance_template: "{{ instancetemplate }}"
    target_size: 3
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ	Описание
autoHealingPolicies complex	Политика автоматического восстановления для этой управляемой группы экземпляров. Возвращается: при успешном выполнении
healthCheck string	URL проверки работоспособности, который запускает автоматическое восстановление. Возвращается: при успешном выполнении
initialDelaySec integer	Количество секунд, в течение которых управляемая группа экземпляров ожидает, прежде чем применить политики автоматического восстановления к новым или недавно пересозданным экземплярам. Возвращается: при успешном выполнении
baseInstanceName string	Базовое имя, используемое для экземпляров в этой группе. Значение должно содержать от 1 до 58 символов. Имена экземпляров образуются добавлением дефиса и случайной строки из четырёх символов к базовому имени. Базовое имя экземпляра должно соответствовать RFC1035. Возвращается: при успешном выполнении
creationTimestamp string	Метка времени создания этой управляемой группы экземпляров в текстовом формате RFC3339. Возвращается: при успешном выполнении
currentActions complex	Список действий с экземплярами и количество экземпляров в этой управляемой группе, для которых запланировано каждое из этих действий. Возвращается: при успешном выполнении
abandoning integer	Общее количество экземпляров в управляемой группе, для которых запланировано отсоединение. При отсоединении экземпляр удаляется из управляемой группы, но не удаляется из системы. Возвращается: при успешном выполнении
creating integer	Количество экземпляров в управляемой группе, создание которых запланировано или уже выполняется. Если группе не удаётся создать какой-либо из этих экземпляров, она повторяет попытку, пока создание не завершится успешно. Если повторные попытки создания отключены, это поле не заполняется; вместо него заполняется поле creatingWithoutRetries. Возвращается: при успешном выполнении
creatingWithoutRetries integer	Количество экземпляров, которые управляемая группа попытается создать. Группа пытается создать каждый экземпляр только один раз. Если группе не удаётся создать какой-либо из этих экземпляров, она соответственно уменьшает значение targetSize. Возвращается: при успешном выполнении
deleting integer	Количество экземпляров в управляемой группе, удаление которых запланировано или уже выполняется. Возвращается: при успешном выполнении
none integer	Количество работающих экземпляров в управляемой группе, для которых не запланировано никаких действий. Возвращается: при успешном выполнении
recreating integer	Количество экземпляров в управляемой группе, пересоздание которых запланировано или уже выполняется. Пересоздание экземпляра удаляет существующий корневой постоянный диск и создаёт новый диск из образа, указанного в шаблоне экземпляра. Возвращается: при успешном выполнении
refreshing integer	Количество экземпляров в управляемой группе, конфигурация которых изменяется с применением свойств, не требующих перезапуска или пересоздания. Например, настройка или удаление целевых пулов для экземпляра. Возвращается: при успешном выполнении
restarting integer	Количество экземпляров в управляемой группе, перезапуск которых запланирован или уже выполняется. Возвращается: при успешном выполнении
description string	Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Возвращается: при успешном выполнении
id integer	Уникальный идентификатор этого ресурса. Возвращается: при успешном выполнении
instanceGroup dictionary	Управляемая группа экземпляров. Возвращается: при успешном выполнении
instanceTemplate dictionary	Шаблон экземпляра, указанный для этой управляемой группы. Группа использует этот шаблон для создания всех новых экземпляров в управляемой группе. Возвращается: при успешном выполнении
name string	Имя управляемой группы экземпляров. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. Возвращается: при успешном выполнении
namedPorts complex	Именованные порты, настроенные для групп экземпляров, связанных с этим диспетчером групп экземпляров. Возвращается: при успешном выполнении
name string	Имя этого именованного порта. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. Возвращается: при успешном выполнении
port integer	Номер порта; допустимые значения — от 1 до 65535. Возвращается: при успешном выполнении
region string	Регион, в котором находится управляемая группа экземпляров. Возвращается: при успешном выполнении
targetPools list / elements=string	Ресурсы TargetPool, в которые добавляются экземпляры из поля instanceGroup. Целевые пулы автоматически применяются ко всем экземплярам управляемой группы. Возвращается: при успешном выполнении
targetSize integer	Целевое количество работающих экземпляров для этой управляемой группы. Удаление или отсоединение экземпляров уменьшает это число. Изменение размера группы меняет это число. Возвращается: при успешном выполнении

Авторы

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_region_instance_group_manager_module.html