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 строка / обязательно	Варианты: 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 строка		Указывает тип заголовка прокси, который необходимо добавить перед отправкой данных на сервер back-end, либо NONE, либо PROXY_V1. По умолчанию - NONE. Некоторые допустимые значения: "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, используя переменную среды c(gcp_service_account_file).
для проверки подлинности можно задать service_account_contents, используя переменную среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
для проверки подлинности можно задать service_account_email, используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
для проверки подлинности можно задать auth_kind, используя переменную среды GCP_AUTH_KIND.
для проверки подлинности можно задать scopes, используя переменную среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
Параметры 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.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
  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 строка	успешно	Дата и время создания в формате RFC3339.
description строка	успешно	Необязательное описание этого ресурса.
id целое число	успешно	Уникальный идентификатор ресурса.
name строка	успешно	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. Точнее, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
proxyHeader строка	успешно	Указывает тип заголовка прокси, который необходимо добавить перед отправкой данных на сервер back-end, либо 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.9/modules/gcp_compute_target_tcp_proxy_module.html