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

Примечание

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

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

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

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

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

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

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

Требования

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

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

Параметры

Параметр	Комментарии
access_token string	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
description string	Необязательное описание этого ресурса.
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Это не должно устанавливаться, если вы не знаете, что делаете. Это только изменяет строку User Agent для любых запросов API.
name string / обязательный	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
project string	Проект Google Cloud Platform для использования.
region string / обязательный	Регион, в котором находится региональный прокси.
scopes list / elements=string	Массив областей, которые будут использоваться
service_account_contents jsonarg	Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде представляющей его JSON-строки.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file path	Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
state string	Должен ли данный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`
url_map dictionary / обязательный	Ссылка на ресурс RegionUrlMap, который определяет сопоставление URL с BackendService. Это поле представляет собой ссылку на ресурс RegionUrlMap в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом «selfLink» и значением selfLink вашего ресурса. Кроме того, вы можете добавить `register: name-of-resource` к задаче gcp_compute_region_url_map, а затем установить это поле url_map в «{{ name-of-resource }}»

Примечания

Примечание

API Reference: 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.
Для аутентификации вы можете установить 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-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 строка	Маркер создания в формате RFC3339. Возвращается: успешно
description строка	Необязательное описание этого ресурса. Возвращается: успешно
id целое число	Уникальный идентификатор ресурса. Возвращается: успешно
name строка	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. То есть, длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9][a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть тире, строчными буквами или цифрами, за исключением последнего символа, который не может быть тире. Возвращается:* успешно
region строка	Регион, в котором находится региональный прокси. Возвращается: успешно
urlMap словарь	Ссылка на ресурс RegionUrlMap, который определяет отображение URL на 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_region_target_http_proxy_module.html