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		Проект 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

Примечания

Примечание

Для аутентификации можно задать service_account_file, используя переменную среды GCP_SERVICE_ACCOUNT_FILE.
Для аутентификации можно задать 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 }}"
      scopes:
        - https://www.googleapis.com/auth/compute
      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 }}"
      scopes:
        - https://www.googleapis.com/auth/compute
      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 }}"
      scopes:
        - https://www.googleapis.com/auth/compute
      state: present
  register: backendservice
- name: create a target tcp proxy
  gcp_compute_target_tcp_proxy:
      name: testObject
      proxy_header: 'PROXY_V1'
      service: "{{ backendservice }}"
      project: testProject
      auth_kind: service_account
      service_account_file: /tmp/auth.pem
      scopes:
        - https://www.googleapis.com/auth/compute
      state: present

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

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

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

Статус

Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется обратной совместимостью.

Техническое обслуживание

Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

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