Модуль google.cloud.gcp_compute_target_tcp_proxy – Создает GCP TargetTcpProxy

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.

Для использования в playbook, укажите: google.cloud.gcp_compute_target_tcp_proxy.

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

Краткое описание

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

Требования

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

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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind строка / обязательно	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
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_bind логическое	Это поле применяется только тогда, когда правило переадресации, которое ссылается на этот прокси-сервер, имеет loadBalancingScheme, установленный в INTERNAL_SELF_MANAGED. Варианты: `false` `true`
proxy_header строка	Указывает тип заголовка прокси-сервера, который нужно добавить перед отправкой данных в бэкэнд. Некоторые допустимые варианты включают: «NONE», «PROXY_V1»
scopes список / элементы=строка	Массив областей для использования
service словарь / обязательно	Ссылка на ресурс BackendService. Это поле представляет собой ссылку на ресурс BackendService в GCP. Его можно указать двумя способами. Во-первых, вы можете разместить словарь с ключом ‘selfLink’ и значением selfLink вашего ресурса. В качестве альтернативы вы можете добавить `register: name-of-resource` в задачу gcp_compute_backend_service, а затем установить это поле service в «{{ name-of-resource }}»
service_account_contents jsonarg	Содержимое файла JSON учетной записи службы, либо в словаре, либо в виде строки JSON, которая его представляет.
service_account_email строка	Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file путь	Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
state строка	Должен ли данный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Справочник по 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.
Для аутентификации вы можете установить access_token с помощью переменной среды GCP_ACCESS_TOKEN.
Для аутентификации вы можете установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации вы можете установить scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения playbook не установлены.
Параметры 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])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. Возвращается:* успех
proxyBind булево	Это поле применимо только в том случае, если у правила маршрутизации, ссылающегося на этот целевой прокси, параметр loadBalancingScheme установлен в значение INTERNAL_SELF_MANAGED. Возвращается: успех
proxyHeader строка	Указывает тип заголовка прокси, который нужно добавить перед отправкой данных на бэкенд. Возвращается: успех
service словарь	Ссылка на ресурс BackendService. Возвращается: успех

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_target_tcp_proxy_module.html