google.cloud.gcp_compute_network_endpoint_group 模块 – 创建一个 GCP 网络端点组

注意

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

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

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

要在剧本中使用它，请指定：google.cloud.gcp_compute_network_endpoint_group。

注意

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

概要

  • 网络端点组 (NEG) 是区域资源，表示单个子网内 GCP 资源的 IP 地址和端口组合的集合。每个 IP 地址和端口组合都称为网络端点。

  • 网络端点组可以用作 HTTP(S)、TCP 代理和 SSL 代理负载均衡器的后端服务。您不能将 NEG 用作内部负载均衡器的后端。由于 NEG 后端允许您指定 IP 地址和端口，因此您可以在虚拟机实例中运行的应用程序或容器之间以精细的方式分配流量。

  • 重新创建另一个资源正在使用的网络端点组将产生 `resourceInUseByAnotherResource` 错误。使用 `lifecycle.create_before_destroy` 来避免此类错误。

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

string

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

auth_kind

string / 必填

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

default_port

integer

如果网络端点中未指定端口号，则使用的默认端口。

description

string

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

env_type

string

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

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

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

name

string / 必填

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

network

dictionary / 必填

NEG 中所有网络端点所属的网络。

如果未指定，则使用“default”项目网络。

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

network_endpoint_type

string

此网络端点组中网络端点的类型。

一些有效选项包括：“GCE_VM_IP_PORT”

默认值： "GCE_VM_IP_PORT"

project

string

要使用的 Google Cloud Platform 项目。

scopes

list / elements=string

要使用的作用域数组

service_account_contents

jsonarg

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

service_account_email

string

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

service_account_file

path

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

state

string

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

选项

  • "present" ← (默认)

  • "absent"

subnetwork

dictionary

可选的子网，NEG 中的所有网络端点都属于该子网。

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

zone

string / 必填

网络端点组所在的区域。

备注

注意

  • API 参考：https://cloud.google.com/compute/docs/reference/rest/beta/networkEndpointGroups

  • 官方文档：https://cloud.google.com/load-balancing/docs/negs/

  • 对于身份验证，您可以使用 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 network
  google.cloud.gcp_compute_network:
    name: "{{ resource_name }}"
    auto_create_subnetworks: 'false'
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: network

- name: create a subnetwork
  google.cloud.gcp_compute_subnetwork:
    name: "{{ resource_name }}"
    ip_cidr_range: 10.0.0.0/16
    region: us-central1
    network: "{{ network }}"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: subnetwork

- name: create a network endpoint group
  google.cloud.gcp_compute_network_endpoint_group:
    name: test_object
    network: "{{ network }}"
    subnetwork: "{{ subnetwork }}"
    default_port: 90
    zone: us-central1-a
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

通用返回值记录在此处，以下是此模块独有的字段

键

描述

defaultPort

integer

如果网络端点中未指定端口号，则使用的默认端口。

返回： 成功

description

string

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

返回： 成功

id

integer

资源的唯一标识符。

返回： 成功

name

string

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

返回： 成功

network

dictionary

NEG 中所有网络端点所属的网络。

如果未指定，则使用“default”项目网络。

返回： 成功

networkEndpointType

string

此网络端点组中网络端点的类型。

返回： 成功

size

integer

网络端点组中的网络端点数量。

返回： 成功

subnetwork

dictionary

可选的子网，NEG 中的所有网络端点都属于该子网。

返回： 成功

zone

string

网络端点组所在的区域。

返回： 成功

作者

  • Google Inc. (@googlecloudplatform)