Модуль google.cloud.gcp_compute_instance_group_manager – создание InstanceGroupManager в GCP

Примечание

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

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

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

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

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

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

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

Требования

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

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

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
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, который будет использоваться.
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	Целевое количество работающих экземпляров в этой управляемой группе экземпляров. Удаление или исключение экземпляров уменьшает это число. Изменение размера группы меняет это число.
zone string / обязательный	Зона, в которой находится управляемая группа экземпляров.

Примеры

- 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-west1
    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 instance group manager
  google.cloud.gcp_compute_instance_group_manager:
    name: test_object
    base_instance_name: test1-child
    instance_template: "{{ instancetemplate }}"
    target_size: 3
    zone: us-west1-a
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

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

Авторы

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