google.cloud.gcp_compute_network_endpoint_group – Создаёт GCP NetworkEndpointGroup
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.1).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в книге задач укажите: google.cloud.gcp_compute_network_endpoint_group.
Обзор
- Группы сетевых конечных точек (NEG) — это зональные ресурсы, которые представляют собой коллекции комбинаций IP-адресов и портов для ресурсов GCP в одном подсети. Каждая комбинация IP-адреса и порта называется сетевой конечной точкой.
- Группы сетевых конечных точек могут использоваться в качестве бэкендов в службах бэкенда для балансировщиков нагрузки HTTP(S), TCP-прокси и SSL-прокси. Вы не можете использовать NEG в качестве бэкенда с внутренними балансировщиками нагрузки. Поскольку бэкенды NEG позволяют указать IP-адреса и порты, вы можете распределять трафик по отдельным приложениям или контейнерам, работающим в виртуальных машинах.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательный |
| Тип используемых учетных данных. |
| default_port целое число | Порт по умолчанию, используемый, если номер порта не указан в сетевой конечной точке. | |
| description строка | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Это не должно устанавливаться, если вам это не нужно. Это изменяет только строку User Agent для всех запросов API. | |
| name строка / обязательный | Имя ресурса; предоставляется клиентом при создании ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. То есть длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. | |
| network словарь / обязательный | Сеть, к которой принадлежат все сетевые конечные точки в NEG. Если не указано, используется сеть проекта «по умолчанию». Это поле представляет собой ссылку на ресурс Сеть в GCP. Можно указать его двумя способами. Во-первых, можно поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Во-вторых, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_network, а затем установить поле network в "{{ имя-ресурса }}" | |
| network_endpoint_type строка | По умолчанию: "GCE_VM_IP_PORT" | Тип сетевых конечных точек в этой группе сетевых конечных точек. Некоторые допустимые значения: "GCE_VM_IP_PORT" |
| project строка | Проект Google Cloud Platform, который будет использоваться. | |
| scopes список / элементы=строка | Массив областей, которые будут использоваться | |
| service_account_contents jsonarg | Содержание файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, которая его представляет. | |
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если тип выбран serviceaccount. | |
| state строка |
| Определяет, должен ли данный объект существовать в GCP |
| subnetwork словарь | Необязательная подсеть, к которой принадлежат все сетевые конечные точки в NEG. Это поле представляет собой ссылку на ресурс Подсеть в GCP. Можно указать его двумя способами. Во-первых, можно поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Во-вторых, вы можете добавить `register: имя-ресурса` к задаче gcp_compute_subnetwork, а затем установить поле subnetwork в "{{ имя-ресурса }}" | |
| zone строка / обязательный | Зона размещения группы сетевых конечных точек. |
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/beta/networkEndpointGroups
- Официальная документация: https://cloud.google.com/load-balancing/docs/negs/
- для аутентификации можно задать service_account_file, используя переменную среды
gcp_service_account_file. - для аутентификации можно задать service_account_contents, используя переменную среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно задать service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно задать auth_kind, используя переменную среды
GCP_AUTH_KIND. - Для аутентификации можно задать scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в книге задач не установлены.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a network
google.cloud.gcp_compute_network:
name: "{{ resource_name }}"
auto_create_subnetworks: 'false'
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: network
- name: create a subnetwork
google.cloud.gcp_compute_subnetwork:
name: "{{ resource_name }}"
ip_cidr_range: 10.0.0.0/16
region: us-central1
network: "{{ network }}"
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: subnetwork
- name: create a network endpoint group
google.cloud.gcp_compute_network_endpoint_group:
name: test_object
network: "{{ network }}"
subnetwork: "{{ subnetwork }}"
default_port: 90
zone: us-central1-a
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе. Ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| defaultPort целое число | успех | Порт по умолчанию, используемый, если номер порта не указан в сетевой конечной точке. |
| description строка | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. |
| id целое число | успех | Уникальный идентификатор ресурса. |
| name строка | успех | Имя ресурса; предоставляется клиентом при создании ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. То есть длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире. |
| network словарь | успех | Сеть, к которой принадлежат все сетевые конечные точки в NEG. Если не указано, используется сеть проекта «по умолчанию». |
| networkEndpointType строка | успех | Тип сетевых конечных точек в этой группе сетевых конечных точек. |
| size целое число | успех | Количество сетевых конечных точек в группе сетевых конечных точек. |
| subnetwork словарь | успех | Необязательная подсеть, к которой принадлежат все сетевые конечные точки в NEG. |
| zone строка | успех | Зона размещения группы сетевых конечных точек. |
Авторы
- 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.10/collections/google/cloud/gcp_compute_network_endpoint_group_module.html