google.cloud.gcp_compute_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_forwarding_rule。

注意

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

概要

  • 转发规则资源。转发规则资源指定如果数据包与给定的 [IP 地址、IP 协议、端口范围] 元组匹配，则将数据包转发到哪个目标虚拟机池。

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

string

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

all_ports

boolean

对于内部 TCP/UDP 负载均衡（即负载均衡方案为 INTERNAL 且协议为 TCP/UDP），将此设置为 true 以允许寻址到任何端口的数据包转发到使用此转发规则配置的后端。与后端服务一起使用。如果设置了端口或 portRange，则不能设置此项。

选择

  • false

  • true

allow_global_access

boolean

如果为 true，则客户端可以从所有区域访问 ILB。

否则，仅允许从 ILB 所在的本地区域访问。

选择

  • false

  • true

auth_kind

string / required

使用的凭据类型。

选择

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

backend_service

dictionary

接收匹配流量的后端服务。这仅用于内部负载均衡。

此字段表示 GCP 中后端服务资源的链接。可以通过两种方式指定它。首先，您可以放置一个带有键 ‘selfLink’ 和您的资源的 selfLink 值的字典。或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_backend_service 任务，然后将此 backend_service 字段设置为 “{{ name-of-resource }}”

description

string

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

env_type

string

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

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

这只会更改任何 API 请求的用户代理字符串。

ip_address

string

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

地址受限于转发规则的负载均衡方案（外部或内部）和范围（全局或区域）。

当负载均衡方案为 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

string

此规则应用到的 IP 协议。

当负载均衡方案为 INTERNAL 时，只有 TCP 和 UDP 有效。

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

is_mirroring_collector

boolean

指示此负载均衡器是否可以用作数据包镜像的收集器。为了防止镜像循环，即使数据包镜像规则应用于它们，此负载均衡器后面的实例也不会镜像其流量。仅当负载均衡器的 loadBalancingScheme 设置为 INTERNAL 时，才能将其设置为 true。

选择

  • false

  • true

load_balancing_scheme

string

这表示 ForwardingRule 将用于什么，可以是 EXTERNAL、INTERNAL 或 INTERNAL_MANAGED。EXTERNAL 用于经典云 VPN 网关、从外部 IP 地址到 VM 的协议转发，以及 HTTP(S)、SSL 代理、TCP 代理和网络 TCP/UDP 负载均衡器。

INTERNAL 用于从内部 IP 地址到 VM 的协议转发，以及内部 TCP/UDP 负载均衡器。

INTERNAL_MANAGED 用于内部 HTTP(S) 负载均衡器。

一些有效的选择包括：“EXTERNAL”、“INTERNAL”、“INTERNAL_MANAGED”

名称

string / required

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

网络

dictionary

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

此字段仅用于 INTERNAL 负载均衡。

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

网络层级

string

用于配置此地址的网络层级。如果未指定此字段，则假定为 PREMIUM。

一些有效的选择包括：“PREMIUM”、“STANDARD”

端口范围

string

此字段与 TargetHttpProxy、TargetHttpsProxy、TargetSslProxy、TargetTcpProxy、TargetVpnGateway、TargetPool、TargetInstance 的 target 字段一起使用。

仅当 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。

端口

列表 / 元素=字符串

此字段与内部负载均衡的 backend_service 字段一起使用。

当负载均衡方案为 INTERNAL 时，可以配置单个端口或逗号分隔的端口列表。只有寻址到这些端口的数据包才会被转发到使用此转发规则配置的后端。

您最多可以指定 5 个端口。

项目

string

要使用的 Google Cloud Platform 项目。

区域

string / required

对区域转发规则所在区域的引用。

此字段不适用于全局转发规则。

作用域

列表 / 元素=字符串

要使用的作用域数组

服务帐户内容

jsonarg

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

服务帐户电子邮件

string

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

服务帐户文件

路径

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

服务标签

string

此转发规则的服务名称的可选前缀。

如果指定，将成为完全限定服务名称的第一个标签。

标签长度必须为 1-63 个字符，并符合 RFC1035 规范。

具体而言，标签长度必须为 1-63 个字符，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是短划线、小写字母或数字，但最后一个字符不能是短划线。

此字段仅用于 INTERNAL 负载均衡。

状态

string

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

选择

  • "present" ← (默认)

  • "absent"

子网

dictionary

负载均衡 IP 所属的子网，用于此转发规则。此字段仅用于 INTERNAL 负载均衡。

如果指定的网络处于自动子网模式，则此字段是可选的。但是，如果网络处于自定义子网模式，则必须指定子网。

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

目标

string

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

目标必须与转发规则位于同一区域。

转发的流量类型必须适合目标对象。

注释

注意

  • API 参考：https://cloud.google.com/compute/docs/reference/v1/forwardingRules

  • 官方文档：https://cloud.google.com/compute/docs/load-balancing/network/forwarding-rules

  • 对于身份验证，您可以使用 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 address
  google.cloud.gcp_compute_address:
    name: address-forwardingrule
    region: us-west1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: address

- name: create a target pool
  google.cloud.gcp_compute_target_pool:
    name: targetpool-forwardingrule
    region: us-west1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: targetpool

- name: create a forwarding rule
  google.cloud.gcp_compute_forwarding_rule:
    name: test_object
    region: us-west1
    target: "{{ targetpool }}"
    ip_protocol: TCP
    port_range: 80-80
    ip_address: "{{ address.address }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

常见返回值在此处记录 here，以下是此模块独有的字段

键

描述

允许全局访问

boolean

如果为 true，则客户端可以从所有区域访问 ILB。

否则，仅允许从 ILB 所在的本地区域访问。

已返回：成功

所有端口

boolean

对于内部 TCP/UDP 负载均衡（即负载均衡方案为 INTERNAL 且协议为 TCP/UDP），将此设置为 true 以允许寻址到任何端口的数据包转发到使用此转发规则配置的后端。与后端服务一起使用。如果设置了端口或 portRange，则不能设置此项。

已返回：成功

后端服务

dictionary

接收匹配流量的后端服务。这仅用于内部负载均衡。

已返回：成功

创建时间戳

string

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

已返回：成功

description

string

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

已返回：成功

id

整数

资源的唯一标识符。

已返回：成功

IP地址

string

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

地址受限于转发规则的负载均衡方案（外部或内部）和范围（全局或区域）。

当负载均衡方案为 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协议

string

此规则应用到的 IP 协议。

当负载均衡方案为 INTERNAL 时，只有 TCP 和 UDP 有效。

已返回：成功

是镜像收集器

boolean

指示此负载均衡器是否可以用作数据包镜像的收集器。为了防止镜像循环，即使数据包镜像规则应用于它们，此负载均衡器后面的实例也不会镜像其流量。仅当负载均衡器的 loadBalancingScheme 设置为 INTERNAL 时，才能将其设置为 true。

已返回：成功

负载均衡方案

string

这表示 ForwardingRule 将用于什么，可以是 EXTERNAL、INTERNAL 或 INTERNAL_MANAGED。EXTERNAL 用于经典云 VPN 网关、从外部 IP 地址到 VM 的协议转发，以及 HTTP(S)、SSL 代理、TCP 代理和网络 TCP/UDP 负载均衡器。

INTERNAL 用于从内部 IP 地址到 VM 的协议转发，以及内部 TCP/UDP 负载均衡器。

INTERNAL_MANAGED 用于内部 HTTP(S) 负载均衡器。

已返回：成功

名称

string

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

已返回：成功

网络

dictionary

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

此字段仅用于 INTERNAL 负载均衡。

已返回：成功

网络层级

string

用于配置此地址的网络层级。如果未指定此字段，则假定为 PREMIUM。

已返回：成功

端口范围

string

此字段与 TargetHttpProxy、TargetHttpsProxy、TargetSslProxy、TargetTcpProxy、TargetVpnGateway、TargetPool、TargetInstance 的 target 字段一起使用。

仅当 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。

已返回：成功

端口

列表 / 元素=字符串

此字段与内部负载均衡的 backend_service 字段一起使用。

当负载均衡方案为 INTERNAL 时，可以配置单个端口或逗号分隔的端口列表。只有寻址到这些端口的数据包才会被转发到使用此转发规则配置的后端。

您最多可以指定 5 个端口。

已返回：成功

区域

string

对区域转发规则所在区域的引用。

此字段不适用于全局转发规则。

已返回：成功

服务标签

string

此转发规则的服务名称的可选前缀。

如果指定，将成为完全限定服务名称的第一个标签。

标签长度必须为 1-63 个字符，并符合 RFC1035 规范。

具体而言，标签长度必须为 1-63 个字符，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是短划线、小写字母或数字，但最后一个字符不能是短划线。

此字段仅用于 INTERNAL 负载均衡。

已返回：成功

服务名称

string

此转发规则的内部完全限定服务名称。

此字段仅用于 INTERNAL 负载均衡。

已返回：成功

子网

dictionary

负载均衡 IP 所属的子网，用于此转发规则。此字段仅用于 INTERNAL 负载均衡。

如果指定的网络处于自动子网模式，则此字段是可选的。但是，如果网络处于自定义子网模式，则必须指定子网。

已返回：成功

目标

string

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

目标必须与转发规则位于同一区域。

转发的流量类型必须适合目标对象。

已返回：成功

作者

  • Google Inc. (@googlecloudplatform)