google.cloud.gcp_compute_instance_group – Создаёт группу виртуальных машин GCP
Примечание
Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).
Для установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач укажите: google.cloud.gcp_compute_instance_group.
Обзор
- Представляет ресурс группы виртуальных машин. Группы виртуальных машин являются самообслуживаемыми и могут содержать идентичные или разные виртуальные машины. Группы виртуальных машин не используют шаблон виртуальной машины. В отличие от управляемых групп виртуальных машин, вы должны вручную создавать и добавлять виртуальные машины в группу виртуальных машин.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | |
| 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 словарь | Сеть, к которой принадлежат все виртуальные машины в группе виртуальных машин. Это поле представляет собой ссылку на ресурс сети в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Во-вторых, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_network, а затем установить это поле сети на "{{ имя-ресурса }}" | ||
| project строка | Проект Google Cloud Platform для использования. | ||
| region строка | Регион, в котором расположена группа виртуальных машин (для региональных ресурсов). | ||
| scopes список / элементы=строка | Массив используемых областей | ||
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в словаре, либо как строка JSON, которая его представляет. | ||
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию. | ||
| service_account_file путь | Путь к файлу JSON учетной записи службы, если тип выбран как serviceaccount. | ||
| state строка |
| Нужно ли, чтобы данный объект существовал в GCP | |
| subnetwork словарь | Подсеть, к которой принадлежат все виртуальные машины в группе виртуальных машин. Это поле представляет собой ссылку на ресурс подсети в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Во-вторых, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_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 строка | success | Дата и время создания в формате RFC3339. | |
| description строка | success | Необязательное описание данного ресурса. Укажите это свойство при создании ресурса. | |
| id целое число | success | Уникальный идентификатор этой группы виртуальных машин. | |
| instances список / элементы=строка | success | Список виртуальных машин, связанных с данной группой виртуальных машин. Все виртуальные машины должны быть созданы до добавления в группу виртуальных машин. Все виртуальные машины, не входящие в этот список, будут удалены из группы виртуальных машин и не будут удалены. Будет возвращён только полный идентификатор виртуальной машины. | |
| name строка | success | Название группы виртуальных машин. Название должно иметь длину от 1 до 63 символов и соответствовать RFC1035. | |
| namedPorts сложное | success | Присваивает имя номеру порта. Например: {name: "http", port: 80}. Это позволяет системе ссылаться на порты по присвоенному имени вместо номера порта. Имена портов также могут содержать несколько портов. Например: [{name: "http", port: 80},{name: "http", port: 8080}] Имена портов применяются ко всем виртуальным машинам в этой группе виртуальных машин. | |
| name строка | success | Имя для данного имени порта. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. | |
| port целое число | success | Номер порта, который может быть значением от 1 до 65535. | |
| network словарь | success | Сеть, к которой принадлежат все виртуальные машины в группе виртуальных машин. | |
| region строка | success | Регион, в котором расположена группа виртуальных машин (для региональных ресурсов). | |
| subnetwork словарь | success | Подсеть, к которой принадлежат все виртуальные машины в группе виртуальных машин. | |
| zone строка | success | Ссылка на зону, в которой находится группа виртуальных машин. | |
Авторы
- 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_instance_group_module.html
