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 -		Необязательное описание этого ресурса.
name - / обязательно		Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. Более конкретно, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире.
project строка		Используемый проект Google Cloud Platform.
proxy_header -	Варианты: NONE PROXY_V1	Указывает тип заголовка прокси, который добавляется перед отправкой данных в бэкенд, либо NONE, либо PROXY_V1. По умолчанию значение NONE.
scopes список		Массив используемых областей.
service - / обязательно		Ссылка на ресурс BackendService. Это поле представляет ссылку на ресурс BackendService в GCP. Можно указать его двумя способами. Во-первых, можно поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Во-вторых, можно добавить `register: name-of-resource` в задачу gcp_compute_backend_service и установить это поле service в "{{ name-of-resource }}"
service_account_contents строка		Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться в качестве словаря, а как строка с точным содержимым файла service account 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_email, используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно задать service_account_contents, используя переменную среды GCP_SERVICE_ACCOUNT_CONTENTS.
Для аутентификации можно задать 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 }}"
    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 строка	успешно	Указывает тип заголовка прокси, который добавляется перед отправкой данных в бэкенд, либо 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.8/modules/gcp_compute_target_tcp_proxy_module.html