модуль google.cloud.gcp_compute_region_target_https_proxy – Создание GCP RegionTargetHttpsProxy

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_compute_region_target_https_proxy.

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

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

Представляет ресурс RegionTargetHttpsProxy, который используется одним или несколькими правилами переадресации для направления входящих HTTPS-запросов к карте 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 / элементы=string	Массив используемых областей действия
service_account_contents jsonarg	Содержимое JSON-файла учетной записи службы — в виде словаря или строки JSON, представляющей это содержимое.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбрано machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file path	Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount.
ssl_certificates list / элементы=dictionary / обязательный	Список ресурсов RegionSslCertificate, используемых для аутентификации соединений между пользователями и балансировщиком нагрузки. В настоящее время необходимо указать ровно один SSL-сертификат.
state string	Должен ли указанный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`
url_map dictionary / обязательный	Ссылка на ресурс RegionUrlMap, задающий соответствие между URL и RegionBackendService. Это поле содержит ссылку на ресурс 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/regionTargetHttpsProxies
Официальная документация: 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.
Значения переменных окружения используются только в том случае, если значения не заданы в плейбуке.
Параметры service_account_email и service_account_file являются взаимоисключающими.

Примеры

- name: create a instance group
  google.cloud.gcp_compute_instance_group:
    name: instancegroup-targethttpsproxy
    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 region health check
  google.cloud.gcp_compute_region_health_check:
    name: "{{ resource_name }}"
    type: HTTPS
    healthy_threshold: 10
    timeout_sec: 2
    unhealthy_threshold: 5
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: healthcheck

- name: create a region backend service
  google.cloud.gcp_compute_region_backend_service:
    name: backendservice-targethttpsproxy
    region: us-central1
    backends:
    - group: "{{ instancegroup.selfLink }}"
    healthchecks:
    - "{{ healthcheck.selfLink }}"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: backendservice

- name: create a region URL map
  google.cloud.gcp_compute_region_url_map:
    name: urlmap-targethttpsproxy
    region: us-central1
    default_service: "{{ backendservice }}"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: urlmap

- name: create a SSL certificate
  google.cloud.gcp_compute_ssl_certificate:
    name: sslcert-targethttpsproxy
    description: A certificate for testing. Do not use this certificate in production
    certificate: |-
      -----BEGIN CERTIFICATE-----
      MIICqjCCAk+gAwIBAgIJAIuJ+0352Kq4MAoGCCqGSM49BAMCMIGwMQswCQYDVQQG
      EwJVUzETMBEGA1UECAwKV2FzaGluZ3RvbjERMA8GA1UEBwwIS2lya2xhbmQxFTAT
      BgNVBAoMDEdvb2dsZSwgSW5jLjEeMBwGA1UECwwVR29vZ2xlIENsb3VkIFBsYXRm
      b3JtMR8wHQYDVQQDDBZ3d3cubXktc2VjdXJlLXNpdGUuY29tMSEwHwYJKoZIhvcN
      AQkBFhJuZWxzb25hQGdvb2dsZS5jb20wHhcNMTcwNjI4MDQ1NjI2WhcNMjcwNjI2
      MDQ1NjI2WjCBsDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCldhc2hpbmd0b24xETAP
      BgNVBAcMCEtpcmtsYW5kMRUwEwYDVQQKDAxHb29nbGUsIEluYy4xHjAcBgNVBAsM
      FUdvb2dsZSBDbG91ZCBQbGF0Zm9ybTEfMB0GA1UEAwwWd3d3Lm15LXNlY3VyZS1z
      aXRlLmNvbTEhMB8GCSqGSIb3DQEJARYSbmVsc29uYUBnb29nbGUuY29tMFkwEwYH
      KoZIzj0CAQYIKoZIzj0DAQcDQgAEHGzpcRJ4XzfBJCCPMQeXQpTXwlblimODQCuQ
      4mzkzTv0dXyB750fOGN02HtkpBOZzzvUARTR10JQoSe2/5PIwaNQME4wHQYDVR0O
      BBYEFKIQC3A2SDpxcdfn0YLKineDNq/BMB8GA1UdIwQYMBaAFKIQC3A2SDpxcdfn
      0YLKineDNq/BMAwGA1UdEwQFMAMBAf8wCgYIKoZIzj0EAwIDSQAwRgIhALs4vy+O
      M3jcqgA4fSW/oKw6UJxp+M6a+nGMX+UJR3YgAiEAvvl39QRVAiv84hdoCuyON0lJ
      zqGNhIPGq2ULqXKK8BY=
      -----END CERTIFICATE-----
    private_key: |-
      -----BEGIN EC PRIVATE KEY-----
      MHcCAQEEIObtRo8tkUqoMjeHhsOh2ouPpXCgBcP+EDxZCB/tws15oAoGCCqGSM49
      AwEHoUQDQgAEHGzpcRJ4XzfBJCCPMQeXQpTXwlblimODQCuQ4mzkzTv0dXyB750f
      OGN02HtkpBOZzzvUARTR10JQoSe2/5PIwQ==
      -----END EC PRIVATE KEY-----
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: sslcert

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

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

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

Ключ	Описание
creationTimestamp string	Временная метка создания в текстовом формате RFC3339. Возвращается: при успехе
description string	Необязательное описание этого ресурса. Возвращается: при успехе
id integer	Уникальный идентификатор ресурса. Возвращается: при успехе
name string	Имя ресурса. Задается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9][a-z0-9])?`, то есть начинаться со строчной буквы, а все последующие символы должны быть дефисами, строчными буквами или цифрами; последний символ не может быть дефисом. Возвращается:* при успехе
region string	Регион, в котором находится региональный прокси-сервер. Возвращается: при успехе
sslCertificates list / элементы=string	Список ресурсов RegionSslCertificate, используемых для аутентификации соединений между пользователями и балансировщиком нагрузки. В настоящее время необходимо указать ровно один SSL-сертификат. Возвращается: при успехе
urlMap dictionary	Ссылка на ресурс RegionUrlMap, задающий соответствие между URL и RegionBackendService. Возвращается: при успехе

Авторы

Google Inc. (@googlecloudplatform)

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

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