gcp_compute_instance_group – Создаёт группу виртуальных машин GCP
Новая в версии 2.6.
Описание
- Представляет ресурс группы виртуальных машин. Группы виртуальных машин управляются самостоятельно и могут содержать идентичные или разные виртуальные машины. Группы виртуальных машин не используют шаблон виртуальной машины. В отличие от управляемых групп виртуальных машин, вы должны вручную создавать и добавлять виртуальные машины в группу виртуальных машин.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_kind - / обязательно |
| Тип используемых учетных данных. | |
| description - | Необязательное описание этого ресурса. Укажите эту собственность при создании ресурса. | ||
| 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 - | Сеть, к которой принадлежат все виртуальные машины в группе. | ||
| project - | По умолчанию: null | Проект Google Cloud Platform, который использовать. | |
| region - | Регион, в котором расположена группа виртуальных машин (для региональных ресурсов). | ||
| scopes - | Массив используемых областей. | ||
| service_account_email - | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию. | ||
| service_account_file - | Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount. | ||
| state - |
| Должен ли данный объект существовать в GCP | |
| subnetwork - | Подсеть, к которой принадлежат все виртуальные машины в группе. | ||
| zone - / обязательно | Ссылка на зону, в которой расположена группа виртуальных машин. | ||
Примечания
Примечание
- Для аутентификации можно установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a network
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
gcp_compute_instance_group:
name: "test_object"
named_ports:
- name: ansible
port: 1234
network: "{{ network }}"
zone: us-central1-a
project: "test_project"
auth_kind: "service_account"
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — это поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| creation_timestamp строка | успех | Маркер создания в формате RFC3339. | |
| description строка | успех | Необязательное описание этого ресурса. Укажите эту собственность при создании ресурса. | |
| id целое число | успех | Уникальный идентификатор этой группы виртуальных машин. | |
| 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 словарь | успех | Сеть, к которой принадлежат все виртуальные машины в группе. | |
| region строка | успех | Регион, в котором расположена группа виртуальных машин (для региональных ресурсов). | |
| subnetwork словарь | успех | Подсеть, к которой принадлежат все виртуальные машины в группе. | |
| zone строка | успех | Ссылка на зону, в которой расположена группа виртуальных машин. | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [бета-версия]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/gcp_compute_instance_group_module.html