google.cloud.gcp_compute_region_target_http_proxy – Создаёт прокси GCP RegionTargetHttpProxy

Примечание

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

Для его установки используйте: ansible-galaxy collection install google.cloud.

Для использования в книге задач укажите: google.cloud.gcp_compute_region_target_http_proxy.

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

Описание

Представляет ресурс RegionTargetHttpProxy, который используется одним или несколькими правилами переадресации для перенаправления входящих HTTP-запросов на карту URL.

Требования

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

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, который будет использоваться.
region строка / обязательно		Регион, в котором находится региональный прокси.
scopes список / элементы=строка		Массив используемых областей действия
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, представленное либо словарем, либо строкой JSON, которая его представляет.
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount.
state строка	Варианты: present ← absent	Нужно ли создать указанный объект в GCP
url_map словарь / обязательно		Ссылка на ресурс RegionUrlMap, определяющий отображение URL на BackendService. Это поле представляет собой ссылку на ресурс RegionUrlMap в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом 'selfLink' и значением selfLink вашего ресурса. Вместо этого можно добавить `register: name-of-resource` к задаче gcp_compute_region_url_map, а затем установить поле url_map в "{{ name-of-resource }}"

Примечания

Примечание

Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/v1/regionTargetHttpProxies
Официальная документация: https://cloud.google.com/compute/docs/load-balancing/http/target-proxies
для аутентификации можно установить 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-targethttpproxy
    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 HTTP health check
  google.cloud.gcp_compute_http_health_check:
    name: httphealthcheck-targethttpproxy
    healthy_threshold: 10
    port: 8080
    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-targethttpproxy
    backends:
    - group: "{{ instancegroup.selfLink }}"
    health_checks:
    - "{{ healthcheck.selfLink }}"
    enable_cdn: 'true'
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: backendservice

- name: create a URL map
  google.cloud.gcp_compute_url_map:
    name: urlmap-targethttpproxy
    default_service: "{{ backendservice }}"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: urlmap

- name: create a region target HTTP proxy
  google.cloud.gcp_compute_region_target_http_proxy:
    name: test_object
    region: us-central1
    url_map: "{{ urlmap }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

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

Авторы

Google Inc. (@googlecloudplatform)

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