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

Примечание

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

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

Авторы

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.10/collections/google/cloud/gcp_compute_target_tcp_proxy_module.html