gcp_compute_target_tcp_proxy – Создаёт GCP TargetTcpProxy

Новое в версии 2.6.

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

Описание

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

Требования

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

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

Параметры

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

Примечания

Примечание

Ссылка на API: https://cloud.google.com/compute/docs/reference/latest/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_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в данном плейбуке не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: create a instance group
  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
  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
  gcp_compute_backend_service:
      name: "backendservice-targettcpproxy"
      backends:
      - group: "{{ instancegroup }}"
      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
  gcp_compute_target_tcp_proxy:
      name: "test_object"
      proxy_header: PROXY_V1
      service: "{{ backendservice }}"
      project: "test_project"
      auth_kind: "service_account"
      service_account_file: "/tmp/auth.pem"
      state: present

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

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

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

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.7/modules/gcp_compute_target_tcp_proxy_module.html