google.cloud.gcp_compute_target_ssl_proxy 模块 – 创建 GCP TargetSslProxy
注意
此模块是 google.cloud 集合 (版本 1.4.1) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，有关详细信息，请参见 要求。
要在 playbook 中使用它，请指定：google.cloud.gcp_compute_target_ssl_proxy。
注意
由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中移除。该集合存在 未解决的健全性测试失败。有关更多信息，请参见 讨论主题。
概要
表示 TargetSslProxy 资源，一个或多个全局转发规则使用它将传入的 SSL 请求路由到后端服务。
要求
在执行此模块的主机上需要以下要求。
python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0
参数
参数 |
注释 |
|---|---|
如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。 |
|
使用的凭据类型。 选项
|
|
此资源的可选描述。 |
|
指定您在此模块中运行的 Ansible 环境。 除非您知道自己在做什么，否则不应设置此项。 这只会更改任何 API 请求的用户代理字符串。 |
|
资源的名称。创建资源时由客户端提供。名称必须为 1-63 个字符长，并符合 RFC1035。具体来说，名称必须为 1-63 个字符长，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是破折号、小写字母或数字，最后一个字符不能是破折号。 |
|
要使用的 Google Cloud Platform 项目。 |
|
指定在发送数据到后端之前要附加的代理标头类型。 一些有效的选项包括：“NONE”、“PROXY_V1” |
|
要使用的作用域数组 |
|
对 BackendService 资源的引用。 此字段表示 GCP 中 BackendService 资源的链接。它可以通过两种方式指定。首先，您可以放置一个键为 'selfLink' 值为您的资源 selfLink 的字典；或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_backend_service 任务，然后将此 service 字段设置为 "{{ name-of-resource }}"。 |
|
服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。 |
|
如果选择 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。 |
|
如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。 |
|
用于验证用户和负载均衡器之间连接的 SslCertificate 资源列表。必须指定至少一个 SSL 证书。 |
|
将与 TargetSslProxy 资源关联的 SslPolicy 资源的引用。如果未设置，则 TargetSslProxy 资源将没有任何 SSL 策略配置。 此字段表示 GCP 中 SslPolicy 资源的链接。它可以通过两种方式指定。首先，您可以放置一个键为 'selfLink' 值为您的资源 selfLink 的字典；或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_ssl_policy 任务，然后将此 ssl_policy 字段设置为 "{{ name-of-resource }}"。 |
|
给定对象是否应该存在于 GCP 中 选项
|
备注
注意
API 参考：https://cloud.google.com/compute/docs/reference/v1/targetSslProxies
为 Google Cloud 负载平衡设置 SSL 代理：https://cloud.google.com/compute/docs/load-balancing/tcp-ssl/
为了身份验证，您可以使用环境变量
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。只有在未设置剧本值时，才会使用环境变量值。
service_account_email 和 service_account_file 选项是互斥的。
示例
- name: create a instance group
google.cloud.gcp_compute_instance_group:
name: instancegroup-targetsslproxy
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 health check
google.cloud.gcp_compute_health_check:
name: healthcheck-targetsslproxy
type: TCP
tcp_health_check:
port_name: service-health
request: ping
response: pong
healthy_threshold: 10
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-targetsslproxy
backends:
- group: "{{ instancegroup.selfLink }}"
health_checks:
- "{{ healthcheck.selfLink }}"
protocol: SSL
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: backendservice
- name: create a SSL certificate
google.cloud.gcp_compute_ssl_certificate:
name: sslcert-targetsslproxy
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 SSL proxy
google.cloud.gcp_compute_target_ssl_proxy:
name: test_object
ssl_certificates:
- "{{ sslcert }}"
service: "{{ backendservice }}"
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
返回值
常见的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
RFC3339文本格式的创建时间戳。 返回：成功 |
|
此资源的可选描述。 返回：成功 |
|
资源的唯一标识符。 返回：成功 |
|
资源的名称。创建资源时由客户端提供。名称必须为 1-63 个字符长，并符合 RFC1035。具体来说，名称必须为 1-63 个字符长，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是破折号、小写字母或数字，最后一个字符不能是破折号。 返回：成功 |
|
指定在发送数据到后端之前要附加的代理标头类型。 返回：成功 |
|
对 BackendService 资源的引用。 返回：成功 |
|
用于验证用户和负载均衡器之间连接的 SslCertificate 资源列表。必须指定至少一个 SSL 证书。 返回：成功 |
|
将与 TargetSslProxy 资源关联的 SslPolicy 资源的引用。如果未设置，则 TargetSslProxy 资源将没有任何 SSL 策略配置。 返回：成功 |