google.cloud.gcp_compute_instance_group модуль — Создаёт GCP InstanceGroup

Примечание

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

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

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

Для использования в плейбуке укажите: google.cloud.gcp_compute_instance_group.

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

Описание

Представляет ресурс Instance Group. Группы экземпляров — это самостоятельные группы, которые могут содержать идентичные или разные экземпляры. Группы экземпляров не используют шаблон экземпляра. В отличие от управляемых групп экземпляров, вы должны вручную создавать и добавлять экземпляры в группу экземпляров.

Требования

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

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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип аутентификации — accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
description строка	Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
env_type строка	Указывает, в какой среде Ansible выполняется этот модуль. Не устанавливайте это значение, если вы не знаете, что делаете. Это изменяет только строку User Agent для любых запросов к API.
instances список / элементы=словарь	Список экземпляров, связанных с этой группой экземпляров. Все экземпляры должны быть созданы перед добавлением в группу экземпляров. Все экземпляры, не входящие в этот список, будут удалены из группы экземпляров и не будут удалены. Возвращается только полный идентификатор экземпляра.
name строка	Название группы экземпляров. Название должно иметь длину от 1 до 63 символов и соответствовать RFC1035.
named_ports список / элементы=словарь	Присваивает имя номеру порта. Например: {name: “http”, port: 80}. Это позволяет системе ссылаться на порты по заданному имени вместо номера порта. Имена портов также могут содержать несколько портов. Например: [{name: “http”, port: 80},{name: “http”, port: 8080}] Имена портов применяются ко всем экземплярам в этой группе экземпляров.
name строка	Имя для этого имени порта. Название должно иметь длину от 1 до 63 символов и соответствовать RFC1035.
port целое число	Номер порта, который может быть значением от 1 до 65535.
network словарь	Сеть, к которой принадлежат все экземпляры в группе экземпляров. Это поле представляет собой ссылку на ресурс Network в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом ‘selfLink’ и значением selfLink вашего ресурса. Кроме того, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_network и установить это поле network в “{{ имя-ресурса }}”
project строка	Проект Google Cloud Platform, который нужно использовать.
region строка	Регион, в котором расположена группа экземпляров (для региональных ресурсов).
scopes список / элементы=строка	Массив используемых областей
service_account_contents jsonarg	Содержимое файла JSON учетной записи службы, либо в словаре, либо как строка JSON, которая его представляет.
service_account_email строка	Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file путь	Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
state строка	Нужно ли существование данного объекта в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`
subnetwork словарь	Подсеть, к которой принадлежат все экземпляры в группе экземпляров. Это поле представляет собой ссылку на ресурс Subnetwork в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом ‘selfLink’ и значением selfLink вашего ресурса. Кроме того, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_subnetwork и установить это поле subnetwork в “{{ имя-ресурса }}”
zone строка / обязательно	Ссылка на зону, в которой находится группа экземпляров.

Примеры

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

- name: create a instance group
  google.cloud.gcp_compute_instance_group:
    name: test_object
    named_ports:
    - name: ansible
      port: 1234
    network: "{{ network }}"
    zone: us-central1-a
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Значения возврата

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

Ключ	Описание
creationTimestamp строка	Маркер создания в формате RFC3339. Возвращается: успех
description строка	Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Возвращается: успех
id целое число	Уникальный идентификатор этой группы виртуальных машин. Возвращается: успех
instances список / элементы=строка	Список виртуальных машин, связанных с этой группой виртуальных машин. Все виртуальные машины должны быть созданы перед добавлением в группу виртуальных машин. Все виртуальные машины, не входящие в этот список, будут удалены из группы виртуальных машин, но не будут удалены. Будет возвращен только полный идентификатор виртуальной машины. Возвращается: успех
name строка	Имя группы виртуальных машин. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. Возвращается: успех
namedPorts сложный	Присваивает имя номеру порта. Например: {name: “http”, port: 80}. Это позволяет системе ссылаться на порты по назначенному имени вместо номера порта. Названные порты также могут содержать несколько портов. Например: [{name: “http”, port: 80},{name: “http”, port: 8080}] Названные порты применяются ко всем виртуальным машинам в этой группе виртуальных машин. Возвращается: успех
name строка	Имя для этого названного порта. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. Возвращается: успех
port целое число	Номер порта, значение которого может быть от 1 до 65535. Возвращается: успех
network словарь	Сеть, к которой принадлежат все виртуальные машины в группе виртуальных машин. Возвращается: успех
region строка	Регион, в котором расположена группа виртуальных машин (для региональных ресурсов). Возвращается: успех
subnetwork словарь	Подсеть, к которой принадлежат все виртуальные машины в группе виртуальных машин. Возвращается: успех
zone строка	Ссылка на зону, в которой находится группа виртуальных машин. Возвращается: успех

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на сборку

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