google.cloud.gcp_compute_node_group 模块 – 创建一个 GCP 节点组

注意

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

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

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

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

注意

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

概要

• 表示用于管理一组单租户节点的 NodeGroup 资源。

要求

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

• python >= 2.6

• requests >= 2.18.4

• google-auth >= 1.3.0

参数

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	所用凭据的类型。 选项 "application" "machineaccount" "serviceaccount" "accesstoken"
autoscaling_policy 字典	如果您的工作负载使用单租户节点，则可以使用节点组自动缩放器来自动管理节点组的大小。
max_nodes 整数 / 必需	节点组的最大大小。设置为小于等于 100 且大于等于 min-nodes 的值。
min_nodes 整数	节点组的最小大小。必须小于等于 max-nodes。默认值为 0。
mode 字符串 / 必需	自动缩放模式。设置为以下值之一： - OFF：禁用自动缩放器。 ON：启用横向扩展和横向缩减。 ONLY_SCALE_OUT：仅启用横向扩展。 如果您的节点组配置为在最小服务器上重新启动其托管的虚拟机，则必须使用此模式。 一些有效选择包括：“OFF”、“ON”、“ONLY_SCALE_OUT”
description 字符串	资源的文本描述（可选）。
env_type 字符串	指定您在此模块中运行的 Ansible 环境。 除非您知道自己在做什么，否则不应设置此项。 这只会更改任何 API 请求的用户代理字符串。
maintenance_policy 字符串	指定在组中的节点进行维护时如何处理实例。设置为以下值之一：DEFAULT、RESTART_IN_PLACE 或 MIGRATE_WITHIN_NODE_GROUP。默认值为 DEFAULT。 默认： "DEFAULT"
maintenance_window 字典	包含维护时间范围的属性。
start_time 字符串 / 必需	实例。窗口的开始时间。这必须采用 UTC 格式，解析为 00:00、04:00、08:00、12:00、16:00 或 20:00 之一。例如，13:00-5 和 08:00 都是有效的。
name 字符串	资源的名称。
node_template 字典 / 必需	此节点组所属的节点模板的 URL。 此字段表示指向 GCP 中 NodeTemplate 资源的链接。它可以以两种方式指定。首先，您可以放置一个带有键“selfLink”和资源 selfLink 值的字典。或者，您可以在 gcp_compute_node_template 任务中添加“register: name-of-resource”，然后将此 node_template 字段设置为“{{ name-of-resource }}”
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / 元素=字符串	要使用的范围数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
size 整数 / 必需	节点组中的节点总数。
state 字符串	给定的对象是否应该存在于 GCP 中 选项 "present" ←（默认） "absent"
zone 字符串 / 必需	此节点组所在的区域。

备注

注意

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

• 单租户节点：https://cloud.google.com/compute/docs/nodes/

• 对于身份验证，您可以使用 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 node template
  google.cloud.gcp_compute_node_template:
    name: "{{ resource_name }}"
    region: us-central1
    node_type: n1-node-96-624
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: node_template

- name: create a node group
  google.cloud.gcp_compute_node_group:
    name: test_object
    zone: us-central1-a
    description: example group for ansible
    size: 1
    node_template: "{{ node_template }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

常见的返回值记录在这里，以下是本模块特有的字段。

键	描述
autoscalingPolicy 复杂类型	如果您的工作负载使用单租户节点，则可以使用节点组自动缩放器来自动管理节点组的大小。 返回: 成功
maxNodes 整数	节点组的最大大小。设置为小于等于 100 且大于等于 min-nodes 的值。 返回: 成功
minNodes 整数	节点组的最小大小。必须小于等于 max-nodes。默认值为 0。 返回: 成功
mode 字符串	自动缩放模式。设置为以下值之一： - OFF：禁用自动缩放器。 ON：启用横向扩展和横向缩减。 ONLY_SCALE_OUT：仅启用横向扩展。 如果您的节点组配置为在最小服务器上重新启动其托管的虚拟机，则必须使用此模式。 返回: 成功
creationTimestamp 字符串	RFC3339文本格式的创建时间戳。 返回: 成功
description 字符串	资源的文本描述（可选）。 返回: 成功
maintenancePolicy 字符串	指定在组中的节点进行维护时如何处理实例。设置为以下值之一：DEFAULT、RESTART_IN_PLACE 或 MIGRATE_WITHIN_NODE_GROUP。默认值为 DEFAULT。 返回: 成功
maintenanceWindow 复杂类型	包含维护时间范围的属性。 返回: 成功
startTime 字符串	实例。窗口的开始时间。这必须采用 UTC 格式，解析为 00:00、04:00、08:00、12:00、16:00 或 20:00 之一。例如，13:00-5 和 08:00 都是有效的。 返回: 成功
name 字符串	资源的名称。 返回: 成功
nodeTemplate 字典	此节点组所属的节点模板的 URL。 返回: 成功
size 整数	节点组中的节点总数。 返回: 成功
zone 字符串	此节点组所在的区域。 返回: 成功

作者

• Google Inc. (@googlecloudplatform)

集合链接

• 问题跟踪器
• 主页
• 仓库（源代码）