google.cloud.gcp_compute_region_target_https_proxy – Создаёт GCP RegionTargetHttpsProxy

Примечание

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

Для его установки используйте: 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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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.
ssl_certificates список / элементы=словарь / обязательно		Список ресурсов RegionSslCertificate, которые используются для проверки подлинности соединений между пользователями и балансировщиком нагрузки. В настоящее время необходимо указать ровно один сертификат SSL.
state строка	Варианты: present ← absent	Требуется ли существование данного объекта в GCP
url_map словарь / обязательно		Ссылка на ресурс 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
для проверки подлинности можно установить 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 строка	success	Дата и время создания в формате RFC3339.
description строка	success	Необязательное описание этого ресурса.
id целое число	success	Уникальный идентификатор ресурса.
name строка	success	Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. То есть длина должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
region строка	success	Регион, в котором находится региональный прокси.
sslCertificates список / элементы=строка	success	Список ресурсов RegionSslCertificate, которые используются для проверки подлинности соединений между пользователями и балансировщиком нагрузки. В настоящее время необходимо указать ровно один сертификат SSL.
urlMap словарь	success	Ссылка на ресурс RegionUrlMap, который определяет отображение URL на RegionBackendService.

Авторы

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_https_proxy_module.html