google.cloud.gcp_compute_global_forwarding_rule 模块 – 创建 GCP 全局转发规则

注意

此模块是 google.cloud 集合 (版本 1.4.1) 的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

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

注意

由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中移除。该集合存在 未解决的完整性测试失败。请参阅 讨论主题 以了解更多信息。

概要

要求

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

  • 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 请求的用户代理字符串。

ip_address

字符串

此转发规则代表其服务的 IP 地址。

根据转发规则的负载均衡方案（EXTERNAL 或 INTERNAL）和范围（全局或区域），地址受到限制。

当负载均衡方案为 EXTERNAL 时，对于全局转发规则，地址必须是全局 IP，对于区域转发规则，地址必须与转发规则位于同一区域。如果此字段为空，则将分配来自同一范围（全局或区域）的临时 IPv4 地址。区域转发规则仅支持 IPv4。全局转发规则支持 IPv4 或 IPv6。

当负载均衡方案为 INTERNAL 时，这只能是属于为转发规则配置的网络/子网的 RFC 1918 IP 地址。默认情况下，如果此字段为空，则将从为此转发规则配置的子网或网络的 IP 范围内自动分配临时内部 IP 地址。

可以通过文字 IP 地址或指向现有地址资源的 URL 引用来指定地址。以下示例均有效：* 100.1.2.3 * https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address * projects/project/regions/region/addresses/address * regions/region/addresses/address * global/addresses/address * address。

ip_protocol

字符串

此规则适用的 IP 协议。当负载均衡方案为 INTERNAL_SELF_MANAGED 时，只有 TCP 有效。如果全局地址配置为 PRIVATE_SERVICE_CONNECT 的用途和 INTERNAL 的 addressType，则不得设置此字段。

一些有效的选项包括：“TCP”、“UDP”、“ESP”、“AH”、“SCTP”、“ICMP”

ip_version

字符串

此全局转发规则将使用的 IP 版本。

一些有效的选项包括：“IPV4”、“IPV6”

load_balancing_scheme

字符串

这表示 GlobalForwardingRule 将用于什么。

INTERNAL_SELF_MANAGED 的值表示这将用于内部全局 HTTP(S) LB。EXTERNAL 的值表示这将用于外部全局负载均衡（HTTP(S) LB、外部 TCP/UDP LB、SSL 代理）（[Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html) 仅限）注意：如果全局地址配置为 PRIVATE_SERVICE_CONNECT 的用途和 INTERNAL 的 addressType，则必须将此字段设置为“” 。

一些有效的选项包括：“EXTERNAL”、“INTERNAL_SELF_MANAGED”

默认值： "EXTERNAL"

元数据过滤器

列表 / 元素=字典

负载均衡器使用的透明过滤器标准，用于将路由配置限制到一组有限的符合 xDS 规范的客户端。在它们向负载均衡器发送的 xDS 请求中，xDS 客户端会提供节点元数据。如果匹配成功，则相关的路由配置将提供给这些代理。

对于此列表中的每个 metadataFilter，如果其 filterMatchCriteria 设置为 MATCH_ANY，则至少一个 filterLabels 必须与元数据中提供的相应标签匹配。如果其 filterMatchCriteria 设置为 MATCH_ALL，则所有 filterLabels 都必须与提供的元数据中的相应标签匹配。

此处指定的 metadataFilters 可以被此转发规则引用的 UrlMap 中指定的那些过滤器覆盖。

metadataFilters 仅适用于其 loadBalancingScheme 设置为 INTERNAL_SELF_MANAGED 的负载均衡器。

过滤器标签

列表 / 元素=字典 / 必需

基于 filterMatchCriteria，必须与提供的元数据中的标签匹配的标签值对列表。此列表不能为空，最多可以包含 64 个条目。

名称

字符串 / 必需

元数据标签的名称。长度必须在 1 到 1024 个字符之间（包含）。

值

字符串 / 必需

标签必须匹配的值。该值的最大长度为 1024 个字符。

过滤器匹配标准

字符串 / 必需

指定 filterLabels 列表中各个 filterLabel 匹配如何对整体 metadataFilter 匹配做出贡献。

MATCH_ANY - 至少一个 filterLabels 必须在提供的元数据中具有匹配的标签。

MATCH_ALL - 所有 filterLabels 都必须在提供的元数据中具有匹配的标签。

一些有效的选项包括：“MATCH_ANY”、“MATCH_ALL”

名称

字符串 / 必需

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

网络

字典

此字段不用于外部负载均衡。

对于 INTERNAL_SELF_MANAGED 负载均衡，此字段标识此全局转发规则的负载均衡 IP 应所属的网络。如果未指定此字段，则将使用默认网络。

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

端口范围

字符串

此字段与目标字段一起用于 TargetHttpProxy、TargetHttpsProxy、TargetSslProxy、TargetTcpProxy、TargetVpnGateway、TargetPool、TargetInstance。

仅当 IPProtocol 为 TCP、UDP 或 SCTP 时适用，只有寻址到指定范围内的端口的数据包才会转发到目标。

具有相同 [IPAddress，IPProtocol] 对的转发规则必须具有不相交的端口范围。

某些类型的转发目标对可接受的端口有限制：* TargetHttpProxy：80、8080 * TargetHttpsProxy：443 * TargetTcpProxy：25、43、110、143、195、443、465、587、700、993、995、1883、5222 * TargetSslProxy：25、43、110、143、195、443、465、587、700、993、995、1883、5222 * TargetVpnGateway：500、4500。

项目

字符串

要使用的 Google Cloud Platform 项目。

范围

列表 / 元素=字符串

要使用的范围数组

服务帐户内容

jsonarg

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

服务帐户邮箱

字符串

如果选择 machineaccount 并且用户不希望使用默认邮箱，则可以使用可选的服务帐户邮箱地址。

服务帐户文件

路径

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

状态

字符串

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

选项

  • "present" ← (默认)

  • "absent"

目标

字符串 / 必需

接收匹配流量的目标资源的 URL。

转发的流量必须与目标对象的类型相符。

对于 INTERNAL_SELF_MANAGED 负载均衡，只有 HTTP 和 HTTPS 目标有效。

（[Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html) 仅限）对于目的为 PRIVATE_SERVICE_CONNECT 且 addressType 为 INTERNAL 的全局地址，只有“all-apis”和“vpc-sc”有效。

示例

- name: create a global address
  google.cloud.gcp_compute_global_address:
    name: globaladdress-globalforwardingrule
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: globaladdress

- name: create a instance group
  google.cloud.gcp_compute_instance_group:
    name: instancegroup-globalforwardingrule
    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-globalforwardingrule
    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-globalforwardingrule
    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-globalforwardingrule
    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: targethttpproxy-globalforwardingrule
    url_map: "{{ urlmap }}"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: httpproxy

- name: create a global forwarding rule
  google.cloud.gcp_compute_global_forwarding_rule:
    name: test_object
    ip_address: "{{ globaladdress.address }}"
    ip_protocol: TCP
    port_range: 80-80
    target: "{{ httpproxy.selfLink }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

常用返回值已在 此处 记录，以下是此模块特有的字段

键

描述

creationTimestamp

字符串

以 RFC3339 文本格式表示的创建时间戳。

返回：成功

description

字符串

此资源的可选描述。创建资源时提供此属性。

返回：成功

ID

整数

资源的唯一标识符。

返回：成功

IPAddress

字符串

此转发规则代表其服务的 IP 地址。

根据转发规则的负载均衡方案（EXTERNAL 或 INTERNAL）和范围（全局或区域），地址受到限制。

当负载均衡方案为 EXTERNAL 时，对于全局转发规则，地址必须是全局 IP，对于区域转发规则，地址必须与转发规则位于同一区域。如果此字段为空，则将分配来自同一范围（全局或区域）的临时 IPv4 地址。区域转发规则仅支持 IPv4。全局转发规则支持 IPv4 或 IPv6。

当负载均衡方案为 INTERNAL 时，这只能是属于为转发规则配置的网络/子网的 RFC 1918 IP 地址。默认情况下，如果此字段为空，则将从为此转发规则配置的子网或网络的 IP 范围内自动分配临时内部 IP 地址。

可以通过文字 IP 地址或指向现有地址资源的 URL 引用来指定地址。以下示例均有效：* 100.1.2.3 * https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address * projects/project/regions/region/addresses/address * regions/region/addresses/address * global/addresses/address * address。

返回：成功

IPProtocol

字符串

此规则适用的 IP 协议。当负载均衡方案为 INTERNAL_SELF_MANAGED 时，只有 TCP 有效。如果全局地址配置为 PRIVATE_SERVICE_CONNECT 的用途和 INTERNAL 的 addressType，则不得设置此字段。

返回：成功

ipVersion

字符串

此全局转发规则将使用的 IP 版本。

返回：成功

loadBalancingScheme

字符串

这表示 GlobalForwardingRule 将用于什么。

INTERNAL_SELF_MANAGED 的值表示这将用于内部全局 HTTP(S) LB。EXTERNAL 的值表示这将用于外部全局负载均衡（HTTP(S) LB、外部 TCP/UDP LB、SSL 代理）（[Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html) 仅限）注意：如果全局地址配置为 PRIVATE_SERVICE_CONNECT 的用途和 INTERNAL 的 addressType，则必须将此字段设置为“” 。

返回：成功

metadataFilters

复杂

负载均衡器使用的透明过滤器标准，用于将路由配置限制到一组有限的符合 xDS 规范的客户端。在它们向负载均衡器发送的 xDS 请求中，xDS 客户端会提供节点元数据。如果匹配成功，则相关的路由配置将提供给这些代理。

对于此列表中的每个 metadataFilter，如果其 filterMatchCriteria 设置为 MATCH_ANY，则至少一个 filterLabels 必须与元数据中提供的相应标签匹配。如果其 filterMatchCriteria 设置为 MATCH_ALL，则所有 filterLabels 都必须与提供的元数据中的相应标签匹配。

此处指定的 metadataFilters 可以被此转发规则引用的 UrlMap 中指定的那些过滤器覆盖。

metadataFilters 仅适用于其 loadBalancingScheme 设置为 INTERNAL_SELF_MANAGED 的负载均衡器。

返回：成功

filterLabels

复杂

基于 filterMatchCriteria，必须与提供的元数据中的标签匹配的标签值对列表。此列表不能为空，最多可以包含 64 个条目。

返回：成功

名称

字符串

元数据标签的名称。长度必须在 1 到 1024 个字符之间（包含）。

返回：成功

值

字符串

标签必须匹配的值。该值的最大长度为 1024 个字符。

返回：成功

filterMatchCriteria

字符串

指定 filterLabels 列表中各个 filterLabel 匹配如何对整体 metadataFilter 匹配做出贡献。

MATCH_ANY - 至少一个 filterLabels 必须在提供的元数据中具有匹配的标签。

MATCH_ALL - 所有 filterLabels 都必须在提供的元数据中具有匹配的标签。

返回：成功

名称

字符串

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

返回：成功

网络

字典

此字段不用于外部负载均衡。

对于 INTERNAL_SELF_MANAGED 负载均衡，此字段标识此全局转发规则的负载均衡 IP 应所属的网络。如果未指定此字段，则将使用默认网络。

返回：成功

portRange

字符串

此字段与目标字段一起用于 TargetHttpProxy、TargetHttpsProxy、TargetSslProxy、TargetTcpProxy、TargetVpnGateway、TargetPool、TargetInstance。

仅当 IPProtocol 为 TCP、UDP 或 SCTP 时适用，只有寻址到指定范围内的端口的数据包才会转发到目标。

具有相同 [IPAddress，IPProtocol] 对的转发规则必须具有不相交的端口范围。

某些类型的转发目标对可接受的端口有限制：* TargetHttpProxy：80、8080 * TargetHttpsProxy：443 * TargetTcpProxy：25、43、110、143、195、443、465、587、700、993、995、1883、5222 * TargetSslProxy：25、43、110、143、195、443、465、587、700、993、995、1883、5222 * TargetVpnGateway：500、4500。

返回：成功

目标

字符串

接收匹配流量的目标资源的 URL。

转发的流量必须与目标对象的类型相符。

对于 INTERNAL_SELF_MANAGED 负载均衡，只有 HTTP 和 HTTPS 目标有效。

（[Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html) 仅限）对于目的为 PRIVATE_SERVICE_CONNECT 且 addressType 为 INTERNAL 的全局地址，只有“all-apis”和“vpc-sc”有效。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)