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 | Проект 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 }}"
scopes:
- https://www.googleapis.com/auth/compute
state: present
register: network
- name: create a instance group
gcp_compute_instance_group:
name: testObject
named_ports:
- name: ansible
port: 1234
network: "{{ network }}"
zone: 'us-central1-a'
project: testProject
auth_kind: service_account
service_account_file: /tmp/auth.pem
scopes:
- https://www.googleapis.com/auth/compute
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. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, которые также поддерживаются сообществом 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.6/modules/gcp_compute_instance_group_module.html
