google.cloud.gcp_compute_network_endpoint_group – Создаёт GCP NetworkEndpointGroup

Примечание

Этот плагин входит в коллекцию google.cloud (версия 1.0.2).

Для его установки используйте: ansible-galaxy collection install google.cloud.

Для использования в книге задач укажите: google.cloud.gcp_compute_network_endpoint_group.

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

Обзор

Группы сетевых конечных точек (NEG) — это зональные ресурсы, представляющие коллекции сочетаний IP-адресов и портов для ресурсов GCP в пределах одного подсети. Каждое сочетание IP-адреса и порта называется сетевой конечной точкой.
Группы сетевых конечных точек могут использоваться в качестве бэкендов в службах бэкенда для балансировщиков нагрузки HTTP(S), TCP-прокси и SSL-прокси. Вы не можете использовать NEG в качестве бэкенда с внутренними балансировщиками нагрузки. Поскольку бэкенды NEG позволяют указать IP-адреса и порты, вы можете распределять трафик по отдельным приложениям или контейнерам, работающим в виртуальных машинах.
Повторное создание группы сетевых конечных точек, используемой другим ресурсом, вызовет ошибку resourceInUseByAnotherResource. Используйте lifecycle.create_before_destroy для предотвращения этой ошибки.

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
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. Использует сеть проекта «по умолчанию», если не указано иное. Это поле представляет ссылку на ресурс Network в GCP. Оно может быть указано двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Кроме того, вы можете добавить `register: name-of-resource` к задаче gcp_compute_network и затем установить это поле network в "{{ name-of-resource }}"
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 строка	Варианты: present ← absent	Определяет, должен ли данный объект существовать в GCP
subnetwork словарь		Необязательная подсеть, к которой принадлежат все сетевые конечные точки в NEG. Это поле представляет ссылку на ресурс Subnetwork в GCP. Оно может быть указано двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Кроме того, вы можете добавить `register: name-of-resource` к задаче gcp_compute_subnetwork и затем установить это поле subnetwork в "{{ name-of-resource }}"
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–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_network_endpoint_group_module.html