google.cloud.gcp_compute_network_endpoint_group модуль – Создаёт GCP NetworkEndpointGroup

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. Требования.

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

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

Описание

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

Требования

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

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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип аутентификации — accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
default_port целое число	Порт по умолчанию, используемый, если номер порта не указан в конечной точке сети.
description строка	Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
env_type строка	Указывает, в какой среде Ansible выполняется этот модуль. Это поле не должно устанавливаться, если вы не знаете, что делаете. Это поле изменяет только строку User Agent для всех запросов к API.
name строка / обязательно	Имя ресурса; предоставляется клиентом при создании ресурса. Длина имени должна быть от 1 до 63 символов, и оно должно соответствовать RFC1035. Точнее, длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире.
... (rest of the table) ...

Примечания

Примечание

Ссылка на 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
для аутентификации можно установить access_token используя переменную среды GCP_ACCESS_TOKEN
для аутентификации можно установить 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 целое число	Порт по умолчанию, используемый, если номер порта не указан в конечной точке сети. Возвращаемое значение: success
description строка	Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. Возвращаемое значение: success
id целое число	Уникальный идентификатор ресурса. Возвращаемое значение: success
name строка	Имя ресурса; предоставляется клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. То есть длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9][a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращаемое значение:* success
network словарь	Сеть, к которой принадлежат все конечные точки сети в группе NEG. Используется сеть проекта «по умолчанию», если не указано иное. Возвращаемое значение: success
networkEndpointType строка	Тип сетевых конечных точек в этой группе конечных точек сети. Возвращаемое значение: success
size целое число	Количество сетевых конечных точек в группе конечных точек сети. Возвращаемое значение: success
subnetwork словарь	Необязательная подсеть, к которой принадлежат все сетевые конечные точки в группе NEG. Возвращаемое значение: success
zone строка	Зона расположения группы конечных точек сети. Возвращаемое значение: success

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_network_endpoint_group_module.html