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。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：google.cloud.gcp_compute_target_https_proxy。

注意

由于违反了 Ansible 的包含要求，google.cloud 集合将从 Ansible 12 中删除。该集合有 未解决的健全性测试失败。有关更多信息，请参阅 讨论线程。

概要

  • 表示 TargetHttpsProxy 资源，它被一个或多个全局转发规则使用，以将传入的 HTTPS 请求路由到 URL 映射。

要求

执行此模块的主机需要以下要求。

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

如果凭据类型是 accesstoken，则为 OAuth2 访问令牌。

auth_kind

字符串 / 必需

使用的凭据类型。

选择

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

description

字符串

此资源的可选描述。

env_type

字符串

指定您在其中运行此模块的 Ansible 环境。

除非您知道自己在做什么，否则不应设置此项。

这只会更改任何 API 请求的 User Agent 字符串。

name

字符串 / 必需

资源的名称。由客户端在创建资源时提供。该名称必须为 1-63 个字符长，并符合 RFC1035。具体来说，该名称必须为 1-63 个字符长，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，并且所有后续字符必须是短划线、小写字母或数字，但最后一个字符不能是短划线。

project

字符串

要使用的 Google Cloud Platform 项目。

proxy_bind

布尔值

仅当引用此目标代理的转发规则的 loadBalancingScheme 设置为 INTERNAL_SELF_MANAGED 时，此字段才适用。

选择

  • false

  • true

quic_override

字符串

指定此资源的 QUIC 覆盖策略。这决定了负载均衡器是否会尝试与客户端协商 QUIC。可以指定 NONE、ENABLE 或 DISABLE 中的一个。如果指定 NONE，则使用没有用户覆盖的 QUIC 策略，这等效于 DISABLE。

一些有效的选择包括：“NONE”、“ENABLE”、“DISABLE”

scopes

列表 / 元素=字符串

要使用的范围数组

service_account_contents

jsonarg

服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。

service_account_email

字符串

如果选择了 machineaccount 且用户不希望使用默认电子邮件，则可选的服务帐户电子邮件地址。

service_account_file

路径

如果选择 serviceaccount 作为类型，则服务帐户 JSON 文件的路径。

ssl_certificates

列表 / 元素=字典 / 必需

用于验证用户和负载均衡器之间连接的 SslCertificate 资源列表。必须指定至少一个 SSL 证书。

ssl_policy

字典

对将与 TargetHttpsProxy 资源关联的 SslPolicy 资源的引用。如果未设置，则 TargetHttpsProxy 资源将不会配置任何 SSL 策略。

此字段表示 GCP 中 SslPolicy 资源的链接。可以通过两种方式指定。首先，您可以放置一个字典，其中键为“selfLink”，值为资源的 selfLink。或者，您可以将“register: name-of-resource”添加到 gcp_compute_ssl_policy 任务，然后将此 ssl_policy 字段设置为“{{ name-of-resource }}”

state

字符串

给定的对象是否应存在于 GCP 中

选择

  • "present" ←（默认）

  • "absent"

url_map

字典 / 必需

对定义从 URL 到 BackendService 的映射的 UrlMap 资源的引用。

此字段表示 GCP 中 UrlMap 资源的链接。可以通过两种方式指定。首先，您可以放置一个字典，其中键为“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

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_FILE 环境变量设置 service_account_file。

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_CONTENTS 环境变量设置 service_account_contents。

  • 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_EMAIL 环境变量设置 service_account_email。

  • 对于身份验证，您可以使用 GCP_ACCESS_TOKEN 环境变量设置 access_token。

  • 对于身份验证，您可以使用 GCP_AUTH_KIND 环境变量设置 auth_kind。

  • 对于身份验证，您可以使用 GCP_SCOPES 环境变量设置 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

字典

对将与 TargetHttpsProxy 资源关联的 SslPolicy 资源的引用。如果未设置，则 TargetHttpsProxy 资源将不会配置任何 SSL 策略。

返回: 成功

urlMap

字典

对定义从 URL 到 BackendService 的映射的 UrlMap 资源的引用。

返回: 成功

作者

  • Google Inc. (@googlecloudplatform)