Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_compute_target_https_proxy – Создаёт GCP TargetHttpsProxy

Примечание

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

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

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

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

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

Описание

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

Требования

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

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

Параметры

Параметр

Комментарии

access_token

string

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

string / required

Тип используемых учетных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

description

string

Необязательное описание этого ресурса.

env_type

string

Указывает, в какой среде Ansible выполняется этот модуль.

Это не должно быть установлено, если вы не знаете, что делаете.

Это только изменяет строку User Agent для любых запросов API.

name

string / required

Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.

project

string

Проект Google Cloud Platform для использования.

proxy_bind

boolean

Это поле применяется только тогда, когда правило переадресации, которое ссылается на этот целевой прокси, имеет значение loadBalancingScheme, установленное в INTERNAL_SELF_MANAGED.

Варианты:

  • false
  • true

quic_override

string

Указывает политику переопределения QUIC для этого ресурса. Это определяет, будет ли балансировщик нагрузки пытаться договариваться о QUIC с клиентами или нет. Может указать один из NONE, ENABLE или DISABLE. Если указано NONE, используется политика QUIC без переопределений пользователя, что эквивалентно DISABLE.

Некоторые допустимые варианты включают: «NONE», «ENABLE», «DISABLE»

scopes

list / elements=string

Массив областей, которые будут использоваться

service_account_contents

jsonarg

Содержимое файла Service Account JSON, либо в виде словаря, либо в виде представляющей его JSON-строки.

service_account_email

string

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

service_account_file

path

Путь к файлу Service Account JSON, если в качестве типа выбран serviceaccount.

ssl_certificates

list / elements=dictionary / required

Список ресурсов SslCertificate, которые используются для аутентификации соединений между пользователями и балансировщиком нагрузки. Должен быть указан как минимум один сертификат SSL.

ssl_policy

dictionary

Ссылка на ресурс SslPolicy, который будет связан с ресурсом TargetHttpsProxy. Если не указано, ресурс TargetHttpsProxy не будет иметь никакой настроенной политики SSL.

Это поле представляет собой ссылку на ресурс SslPolicy в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом «selfLink» и значением selfLink вашего ресурса. В качестве альтернативы вы можете добавить `register: name-of-resource` в задачу gcp_compute_ssl_policy, а затем установить это поле ssl_policy в «{{ name-of-resource }}»

state

string

Должен ли данный объект существовать в GCP

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

url_map

dictionary / required

Ссылка на ресурс UrlMap, который определяет сопоставление URL с BackendService.

Это поле представляет собой ссылку на ресурс UrlMap в GCP. Его можно указать двумя способами. Во-первых, вы можете поместить словарь с ключом «selfLink» и значением selfLink вашего ресурса. В качестве альтернативы вы можете добавить `register: name-of-resource` в задачу gcp_compute_url_map, а затем установить это поле url_map в «{{ name-of-resource }}»

Примечания

Примечание

  • Справочник по API: https://cloud.google.com/compute/docs/reference/v1/targetHttpsProxies
  • Официальная документация: 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-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 HTTP health check
  google.cloud.gcp_compute_http_health_check:
    name: httphealthcheck-targethttpsproxy
    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-targethttpsproxy
    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-targethttpsproxy
    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 target HTTPS proxy
  google.cloud.gcp_compute_target_https_proxy:
    name: test_object
    ssl_certificates:
    - "{{ sslcert }}"
    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])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефис, строчная буква или цифра, за исключением последнего символа, который не может быть дефисом.

Возвращается: успешно

proxyBind

булево

Это поле применимо только в том случае, если в правиле переадресации, ссылающемся на этот прокси-сервер назначения, параметр loadBalancingScheme установлен в INTERNAL_SELF_MANAGED.

Возвращается: успешно

quicOverride

строка

Указывает политику переопределения QUIC для данного ресурса. Это определяет, будет ли балансировщик нагрузки пытаться договориться о QUIC с клиентами или нет. Можно указать одно из значений NONE, ENABLE или DISABLE. Если указано NONE, используется политика QUIC без пользовательских переопределений, что эквивалентно DISABLE.

Возвращается: успешно

sslCertificates

список / элементы=строка

Список ресурсов SslCertificate, которые используются для аутентификации подключений между пользователями и балансировщиком нагрузки. Необходимо указать хотя бы один сертификат SSL.

Возвращается: успешно

sslPolicy

словарь

Ссылка на ресурс SslPolicy, который будет связан с ресурсом TargetHttpsProxy. Если не задано, ресурс TargetHttpsProxy не будет иметь никакой конфигурации политики SSL.

Возвращается: успешно

urlMap

словарь

Ссылка на ресурс UrlMap, который определяет отображение 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_target_https_proxy_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API