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

注意

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

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

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

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

注意

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

概要 

Cloud TPU 实例。

要求 

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

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

参数 

参数	注释
accelerator_type 字符串 / 必需	与此节点关联的硬件加速器类型。
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。选择 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
cidr_block 字符串	TPU 节点在选择 IP 地址时将使用的 CIDR 块。此 CIDR 块必须是 /29 块；Compute Engine 网络 API 禁止较小的块，而使用较大的块会浪费（一个节点只能使用一个 IP 地址）。如果 CIDR 块已被用于当前存在的 TPU 节点，CIDR 块与用户提供的网络中的任何子网冲突，或者提供的网络与使用该 CIDR 块的另一个网络对等，则会发生错误。
description 字符串	用户提供的 TPU 描述。最多 512 个字符。
env_type 字符串	指定您在此模块中运行的 Ansible 环境。除非您知道自己在做什么，否则不应设置此项。这只会更改任何 API 请求的用户代理字符串。
labels 字典	用于表示用户提供的元数据的资源标签。
name 字符串 / 必需	TPU 的不可变名称。
network 字符串	要将 TPU 节点对等到的网络的名称。它必须是此 API 已激活的项目中预先存在的 Compute Engine 网络。如果未提供，则将使用“default”。
project 字符串	要使用的 Google Cloud Platform 项目。
scheduling_config 字典	设置此 TPU 实例的计划选项。
preemptible 布尔值 / 必需	定义 TPU 实例是否为抢占式。选择 `false` `true`
scopes 列表 / 元素=字符串	要使用的作用域数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典形式，也可以是表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
state 字符串	给定对象是否应存在于 GCP 中选择 `"present"` ← (默认) `"absent"`
tensorflow_version 字符串 / 必需	节点中运行的 Tensorflow 版本。
use_service_networking 布尔值	是否通过 Service Networking API 设置节点的 VPC 对等互连。 VPC 对等互连应在配置节点之前设置。如果设置了此字段，则不应指定 cidr_block 字段。如果您要将 TPU 节点对等到的网络是共享 VPC 网络，则必须启用此字段才能创建节点。选择 `false` ← (默认) `true`
zone 字符串	TPU 的 GCP 位置。如果未提供，则使用提供程序区域。

注意 

注意

API 参考：https://cloud.google.com/tpu/docs/reference/rest/v1/projects.locations.nodes
官方文档：https://cloud.google.com/tpu/docs/
对于身份验证，您可以使用 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
  google.cloud.gcp_tpu_node:
    name: test_object
    zone: us-central1-b
    accelerator_type: v3-8
    tensorflow_version: '1.11'
    cidr_block: 10.2.0.0/29
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值 

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

键	描述
acceleratorType 字符串	与此节点关联的硬件加速器类型。已返回: 成功
cidrBlock 字符串	TPU 节点在选择 IP 地址时将使用的 CIDR 块。此 CIDR 块必须是 /29 块；Compute Engine 网络 API 禁止较小的块，而使用较大的块会浪费（一个节点只能使用一个 IP 地址）。如果 CIDR 块已被用于当前存在的 TPU 节点，CIDR 块与用户提供的网络中的任何子网冲突，或者提供的网络与使用该 CIDR 块的另一个网络对等，则会发生错误。已返回: 成功
description 字符串	用户提供的 TPU 描述。最多 512 个字符。已返回: 成功
labels 字典	用于表示用户提供的元数据的资源标签。已返回: 成功
name 字符串	TPU 的不可变名称。已返回: 成功
network 字符串	要将 TPU 节点对等到的网络的名称。它必须是此 API 已激活的项目中预先存在的 Compute Engine 网络。如果未提供，则将使用“default”。已返回: 成功
networkEndpoints 复杂	TPU 工作程序可以访问和发送工作的网络端点。建议节点的 Tensorflow 客户端首先联系第一个（索引 0）条目。已返回: 成功
ipAddress 字符串	此网络端点的 IP 地址。已返回: 成功
port 整数	此网络端点的端口。已返回: 成功
schedulingConfig 复杂	设置此 TPU 实例的计划选项。已返回: 成功
preemptible 布尔值	定义 TPU 实例是否为抢占式。已返回: 成功
serviceAccount 字符串	用于在节点中运行张量流服务的服务帐户。要与节点中运行的 Tensorflow 作业共享资源（包括 Google Cloud Storage 数据），此帐户必须具有该数据的权限。已返回: 成功
tensorflowVersion 字符串	节点中运行的 Tensorflow 版本。已返回: 成功
useServiceNetworking 布尔值	是否通过 Service Networking API 设置节点的 VPC 对等互连。 VPC 对等互连应在配置节点之前设置。如果设置了此字段，则不应指定 cidr_block 字段。如果您要将 TPU 节点对等到的网络是共享 VPC 网络，则必须启用此字段才能创建节点。已返回: 成功
zone 字符串	TPU 的 GCP 位置。如果未提供，则使用提供程序区域。已返回: 成功

作者

谷歌公司 (@googlecloudplatform)