google.cloud.gcp_tpu_node_info 模块 – 收集 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_info。

注意

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

概要

  • 收集 GCP 节点的信息

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

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

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

env_type

字符串

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

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

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

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / elements=字符串

要使用的作用域数组

service_account_contents

jsonarg

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

service_account_email

字符串

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

service_account_file

路径

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

zone

字符串

TPU 的 GCP 位置。如果未提供，则使用提供程序区域。

注意

注意

  • 对于身份验证，您可以使用 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: get info on a node
  gcp_tpu_node_info:
    zone: us-central1-b
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

复合

资源列表

返回： 总是

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

字符串

用于在节点内运行 tensor flow 服务的服务帐户。要与节点中运行的 Tensorflow 作业共享资源（包括 Google Cloud Storage 数据），此帐户必须具有对该数据的权限。

返回： 成功

tensorflowVersion

字符串

节点中运行的 Tensorflow 版本。

返回： 成功

useServiceNetworking

布尔值

是否通过服务网络 API 设置节点的 VPC 对等互连。

应在配置节点之前设置 VPC 对等互连。如果设置此字段，则不应指定 cidr_block 字段。如果要将 TPU 节点对等的网络是共享 VPC 网络，则必须启用此字段才能创建节点。

返回： 成功

zone

字符串

TPU 的 GCP 位置。如果未提供，则使用提供程序区域。

返回： 成功

作者

  • Google Inc. (@googlecloudplatform)