google.cloud.gcp_compute_target_http_proxy 模块 – 创建一个 GCP TargetHttpProxy
注意
此模块是 google.cloud 集合（版本 1.4.1）的一部分。
如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install google.cloud。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定： google.cloud.gcp_compute_target_http_proxy。
注意
由于违反了 Ansible 包含要求，google.cloud 集合将从 Ansible 12 中删除。该集合存在 未解决的健全性测试失败。有关更多信息，请参阅 讨论主题。
概要
表示 TargetHttpProxy 资源，该资源由一个或多个全局转发规则用于将传入的 HTTP 请求路由到 URL 映射。
要求
执行此模块的主机需要以下要求。
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 项目。 |
|
仅当引用此目标代理的转发规则的 loadBalancingScheme 设置为 INTERNAL_SELF_MANAGED 时，此字段才适用。 选择
|
|
要使用的作用域数组 |
|
服务帐户 JSON 文件的内容，可以是字典形式，也可以是表示它的 JSON 字符串。 |
|
如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。 |
|
如果选择了 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。 |
|
给定的对象是否应存在于 GCP 中 选择
|
|
对 UrlMap 资源的引用，该资源定义了从 URL 到 BackendService 的映射。 此字段表示指向 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/targetHttpProxies
官方文档：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-targethttpproxy
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-targethttpproxy
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-targethttpproxy
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-targethttpproxy
default_service: "{{ backendservice }}"
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: urlmap
- name: create a target HTTP proxy
google.cloud.gcp_compute_target_http_proxy:
name: test_object
url_map: "{{ urlmap }}"
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])?` 匹配，这意味着第一个字符必须是小写字母，所有后续字符必须是破折号、小写字母或数字，但最后一个字符不能是破折号。 返回值：成功 |
|
仅当引用此目标代理的转发规则的 loadBalancingScheme 设置为 INTERNAL_SELF_MANAGED 时，此字段才适用。 返回值：成功 |
|
对 UrlMap 资源的引用，该资源定义了从 URL 到 BackendService 的映射。 返回值：成功 |