google.cloud.gcp_compute_node_template 模块 – 创建 GCP 节点模板

注意

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

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

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

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

注意

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

概要 

表示 NodeTemplate 资源。节点模板指定创建专用租户节点的属性，例如节点类型、vCPU 和内存要求、节点亲和性标签和区域。

要求 

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

参数 

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。选项 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
cpu_overcommit_type 字符串	CPU 超额分配。一些有效的选项包括：“ENABLED”、“NONE” 默认值： `"NONE"`
description 字符串	资源的可选文本描述。
env_type 字符串	指定您在哪个 Ansible 环境中运行此模块。除非您知道自己在做什么，否则不应设置此项。这只会更改任何 API 请求的用户代理字符串。
name 字符串	资源名称。
node_affinity_labels 字典	用于节点亲和性的标签，这将用于实例调度。
node_type 字符串	将用于从此模板创建的节点组的节点类型。只能指定 nodeTypeFlexibility 或 nodeType 中的一个。
node_type_flexibility 字典	所需节点类型的灵活属性。使用此节点模板的节点组将创建与这些属性匹配的类型的节点。只能指定 nodeTypeFlexibility 或 nodeType 中的一个。
cpus 字符串	要使用的虚拟 CPU 数量。
memory 字符串	节点可用的物理内存，以 MB 为单位定义。
project 字符串	要使用的 Google Cloud Platform 项目。
region 字符串 / 必需	将创建使用节点模板的节点的区域。
scopes 列表 / 元素=字符串	要使用的作用域数组
server_binding 字典	使用此模板的节点的服务器绑定策略。确定维护事件后节点应在何处重新启动。
type 字符串 / 必需	服务器绑定策略的类型。如果为 `RESTART_NODE_ON_ANY_SERVER`，则使用此模板的节点将在维护事件后在任何物理服务器上重新启动。如果为 `RESTART_NODE_ON_MINIMAL_SERVER`，则使用此模板的节点将在维护事件后重新启动在同一物理服务器上，而不是被实时迁移到或重新启动到新的物理服务器上。如果您使用与底层服务器特性（例如物理插槽或核心）绑定的软件许可证，则此选项可能很有用，以避免在维护发生时需要额外的许可证。但是，在应用维护时，此类节点上的虚拟机将经历中断。一些有效的选项包括：“RESTART_NODE_ON_ANY_SERVER”、“RESTART_NODE_ON_MINIMAL_SERVERS”
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
state 字符串	给定对象是否应该存在于 GCP 中选项 `"present"` ← (默认) `"absent"`

备注 

注意

API 参考：https://cloud.google.com/compute/docs/reference/rest/v1/nodeTemplates
专用租户节点：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。
仅当未设置剧本值时，才会使用环境变量值。
*service_account_email* 和 *service_account_file* 选项是互斥的。

示例 

- name: create a node template
  google.cloud.gcp_compute_node_template:
    name: test_object
    region: us-central1
    node_type: n1-node-96-624
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值 

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

键	描述
cpuOvercommitType 字符串	CPU 超额分配。返回：成功
creationTimestamp 字符串	RFC3339文本格式的创建时间戳。返回：成功
description 字符串	资源的可选文本描述。返回：成功
name 字符串	资源名称。返回：成功
nodeAffinityLabels 字典	用于节点亲和性的标签，这将用于实例调度。返回：成功
nodeType 字符串	将用于从此模板创建的节点组的节点类型。只能指定 nodeTypeFlexibility 或 nodeType 中的一个。返回：成功
nodeTypeFlexibility complex	所需节点类型的灵活属性。使用此节点模板的节点组将创建与这些属性匹配的类型的节点。只能指定 nodeTypeFlexibility 或 nodeType 中的一个。返回：成功
cpus 字符串	要使用的虚拟 CPU 数量。返回：成功
localSsd 字符串	使用本地SSD。返回：成功
memory 字符串	节点可用的物理内存，以 MB 为单位定义。返回：成功
region 字符串	将创建使用节点模板的节点的区域。返回：成功
serverBinding complex	使用此模板的节点的服务器绑定策略。确定维护事件后节点应在何处重新启动。返回：成功
type 字符串	服务器绑定策略的类型。如果为 `RESTART_NODE_ON_ANY_SERVER`，则使用此模板的节点将在维护事件后在任何物理服务器上重新启动。如果为 `RESTART_NODE_ON_MINIMAL_SERVER`，则使用此模板的节点将在维护事件后重新启动在同一物理服务器上，而不是被实时迁移到或重新启动到新的物理服务器上。如果您使用与底层服务器特性（例如物理插槽或核心）绑定的软件许可证，则此选项可能很有用，以避免在维护发生时需要额外的许可证。但是，在应用维护时，此类节点上的虚拟机将经历中断。返回：成功

作者

Google Inc. (@googlecloudplatform)