gcp_tpu_node – Creates a GCP Node
New in version 2.9.
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
|
|
The type of credential used.
|
|
| cidr_block
string / required
|
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
|
"false"
|
Defines whether the TPU instance is preemptible.
|
|
| scopes
list
|
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
|
|
Whether the given object should exist in GCP
|
|
| tensorflow_version
string / required
|
The version of Tensorflow running in the Node.
|
||
| zone
string / required
|
The GCP location for the TPU.
|
||
Notes
Note
- API Reference: https://cloud.google.com/tpu/docs/reference/rest/
- Official Documentation: https://cloud.google.com/tpu/docs/
- for authentication, you can set service_account_file using the c(gcp_service_account_file) env variable.
- for authentication, you can set service_account_contents using the c(GCP_SERVICE_ACCOUNT_CONTENTS) env variable.
- For authentication, you can set service_account_email using the
GCP_SERVICE_ACCOUNT_EMAILenv variable. - For authentication, you can set auth_kind using the
GCP_AUTH_KINDenv variable. - For authentication, you can set scopes using the
GCP_SCOPESenv 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
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.
|
|
| zone
string
|
success |
The GCP location for the TPU.
|
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Google Inc. (@googlecloudplatform)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/gcp_tpu_node_module.html