google.cloud.gcp_tpu_node – Creates a GCP Node

Note

This plugin is part of the google.cloud collection (version 1.0.2).

To install it use: ansible-galaxy collection install google.cloud.

To use it in a playbook, specify: google.cloud.gcp_tpu_node.

Synopsis

  • A Cloud TPU instance.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

Parameters

Parameter Choices/Defaults Comments
accelerator_type
string / required
The type of hardware accelerators associated with this node.
auth_kind
string / required
    Choices:
  • application
  • machineaccount
  • serviceaccount
The type of credential used.
cidr_block
string
The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address).
Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block.
description
string
The user-supplied description of the TPU. Maximum of 512 characters.
env_type
string
Specifies which Ansible environment you're running this module within.
This should not be set unless you know what you're doing.
This only alters the User Agent string for any API requests.
labels
dictionary
Resource labels to represent user provided metadata.
name
string / required
The immutable name of the TPU.
network
string
The name of a network to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used.
project
string
The Google Cloud Platform project to use.
scheduling_config
dictionary
Sets the scheduling options for this TPU instance.
preemptible
boolean / required
    Choices:
  • no
  • yes
Defines whether the TPU instance is preemptible.
scopes
list / elements=string
Array of scopes to be used
service_account_contents
jsonarg
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
service_account_email
string
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file
path
The path of a Service Account JSON file if serviceaccount is selected as type.
state
string
    Choices:
  • present ←
  • absent
Whether the given object should exist in GCP
tensorflow_version
string / required
The version of Tensorflow running in the Node.
use_service_networking
boolean
    Choices:
  • no
  • yes
Default:
"false"
Whether the VPC peering for the node is set up through Service Networking API.
The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network that you want to peer the TPU Node to is a Shared VPC network, the node must be created with this this field enabled.
zone
string
The GCP location for the TPU. If it is not provided, the provider zone is used.

Notes

Note

  • API Reference: https://cloud.google.com/tpu/docs/reference/rest/v1/projects.locations.nodes

  • Official Documentation: https://cloud.google.com/tpu/docs/

  • for authentication, you can set service_account_file using the gcp_service_account_file env variable.

  • for authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.

  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.

  • For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.

  • For authentication, you can set scopes using the GCP_SCOPES env variable.

  • Environment variables values will only be used if the playbook values are not set.

  • The service_account_email and service_account_file options are mutually exclusive.

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
acceleratorType
string
success
The type of hardware accelerators associated with this node.

cidrBlock
string
success
The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address).
Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block.

description
string
success
The user-supplied description of the TPU. Maximum of 512 characters.

labels
dictionary
success
Resource labels to represent user provided metadata.

name
string
success
The immutable name of the TPU.

network
string
success
The name of a network to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used.

networkEndpoints
complex
success
The network endpoints where TPU workers can be accessed and sent work.
It is recommended that Tensorflow clients of the node first reach out to the first (index 0) entry.

 
ipAddress
string
success
The IP address of this network endpoint.

 
port
integer
success
The port of this network endpoint.

schedulingConfig
complex
success
Sets the scheduling options for this TPU instance.

 
preemptible
boolean
success
Defines whether the TPU instance is preemptible.

serviceAccount
string
success
The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.

tensorflowVersion
string
success
The version of Tensorflow running in the Node.

useServiceNetworking
boolean
success
Whether the VPC peering for the node is set up through Service Networking API.
The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network that you want to peer the TPU Node to is a Shared VPC network, the node must be created with this this field enabled.

zone
string
success
The GCP location for the TPU. If it is not provided, the provider zone is used.



Authors

  • Google Inc. (@googlecloudplatform)