google.cloud.gcp_compute_target_tcp_proxy – Создаёт GCP TargetTcpProxy

Примечание

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

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

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

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

Описание

Представляет ресурс TargetTcpProxy, который используется одним или несколькими глобальными правилами переадресации для маршрутизации входящих TCP-запросов на службу Backend.

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
description строка		Необязательное описание этого ресурса.
env_type строка		Указывает, в какой среде Ansible выполняется этот модуль. Не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API.
name строка / обязательно		Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. То есть длина должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
project строка		Проект Google Cloud Platform, который нужно использовать.
proxy_header строка		Указывает тип заголовка прокси, который следует добавлять перед отправкой данных на бэкенд. Некоторые допустимые значения: "NONE", "PROXY_V1"
scopes список / элементы=строка		Массив используемых областей.
service словарь / обязательно		Ссылка на ресурс BackendService. Это поле представляет собой ссылку на ресурс BackendService в GCP. Можно указать двумя способами. Во-первых, поместите словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Во-вторых, добавьте `register: имя-ресурса` в задачу gcp_compute_backend_service и установите это поле service в "{{ имя-ресурса }}"
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, либо в словаре, либо как строка JSON, которая его представляет.
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если в качестве типа выбрано serviceaccount.
state строка	Варианты: present ← absent	Нужно ли существование данного объекта в GCP

Примечания

Примечание

Ссылка на API: https://cloud.google.com/compute/docs/reference/v1/targetTcpProxies
Настройка TCP-прокси для балансировки нагрузки Google Cloud: https://cloud.google.com/compute/docs/load-balancing/tcp-ssl/tcp-proxy
для аутентификации можно установить 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 instance group
  google.cloud.gcp_compute_instance_group:
    name: instancegroup-targettcpproxy
    zone: us-central1-a
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: instancegroup

- name: create a health check
  google.cloud.gcp_compute_health_check:
    name: healthcheck-targettcpproxy
    type: TCP
    tcp_health_check:
      port_name: service-health
      request: ping
      response: pong
    healthy_threshold: 10
    timeout_sec: 2
    unhealthy_threshold: 5
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: healthcheck

- name: create a backend service
  google.cloud.gcp_compute_backend_service:
    name: backendservice-targettcpproxy
    backends:
    - group: "{{ instancegroup.selfLink }}"
    health_checks:
    - "{{ healthcheck.selfLink }}"
    protocol: TCP
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: backendservice

- name: create a target TCP proxy
  google.cloud.gcp_compute_target_tcp_proxy:
    name: test_object
    proxy_header: PROXY_V1
    service: "{{ backendservice }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
creationTimestamp строка	success	Дата и время создания в формате RFC3339.
description строка	success	Необязательное описание этого ресурса.
id целое число	success	Уникальный идентификатор ресурса.
name строка	success	Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. То есть длина должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
proxyHeader строка	success	Указывает тип заголовка прокси, который следует добавлять перед отправкой данных на бэкенд.
service словарь	success	Ссылка на ресурс BackendService.

Авторы

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_target_tcp_proxy_module.html