Node

A Cloud TPU instance.

To get more information about Node, see:

API documentation
How-to Guides
- Official Documentation

Create a Node Resource

new Node(name: string, args: NodeArgs, opts?: CustomResourceOptions);

def Node(resource_name, opts=None, accelerator_type=None, cidr_block=None, description=None, labels=None, name=None, network=None, project=None, scheduling_config=None, tensorflow_version=None, zone=None, __props__=None);

func NewNode(ctx *Context, name string, args NodeArgs, opts ...ResourceOption) (*Node, error)

public Node(string name, NodeArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args NodeArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args NodeArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NodeArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Node Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Node resource accepts the following input properties:

AcceleratorType string: The type of hardware accelerators associated with this node.
CidrBlock 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.
TensorflowVersion string: The version of Tensorflow running in the Node.
Zone string: The GCP location for the TPU.
Description string: The user-supplied description of the TPU. Maximum of 512 characters.
Labels Dictionary<string, string>: Resource labels to represent user provided metadata.
Name string: 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 ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SchedulingConfig NodeSchedulingConfigArgs: Sets the scheduling options for this TPU instance. Structure is documented below.

AcceleratorType string: The type of hardware accelerators associated with this node.
CidrBlock 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.
TensorflowVersion string: The version of Tensorflow running in the Node.
Zone string: The GCP location for the TPU.
Description string: The user-supplied description of the TPU. Maximum of 512 characters.
Labels map[string]string: Resource labels to represent user provided metadata.
Name string: 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 ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SchedulingConfig NodeSchedulingConfig: Sets the scheduling options for this TPU instance. Structure is documented below.

acceleratorType string: The type of hardware accelerators associated with this node.
cidrBlock 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.
tensorflowVersion string: The version of Tensorflow running in the Node.
zone string: The GCP location for the TPU.
description string: The user-supplied description of the TPU. Maximum of 512 characters.
labels {[key: string]: string}: Resource labels to represent user provided metadata.
name string: 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 ID of the project in which the resource belongs. If it is not provided, the provider project is used.
schedulingConfig NodeSchedulingConfig: Sets the scheduling options for this TPU instance. Structure is documented below.

accelerator_type str: The type of hardware accelerators associated with this node.
cidr_block str: 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.
tensorflow_version str: The version of Tensorflow running in the Node.
zone str: The GCP location for the TPU.
description str: The user-supplied description of the TPU. Maximum of 512 characters.
labels Dict[str, str]: Resource labels to represent user provided metadata.
name str: The immutable name of the TPU.
network str: 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 str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
scheduling_config Dict[NodeSchedulingConfig]: Sets the scheduling options for this TPU instance. Structure is documented below.

Outputs

All input properties are implicitly available as output properties. Additionally, the Node resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
NetworkEndpoints List<NodeNetworkEndpoint>: 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.
ServiceAccount string: 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.

Id string: The provider-assigned unique ID for this managed resource.
NetworkEndpoints []NodeNetworkEndpoint: 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.
ServiceAccount string: 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.

id string: The provider-assigned unique ID for this managed resource.
networkEndpoints NodeNetworkEndpoint[]: 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.
serviceAccount string: 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.

id str: The provider-assigned unique ID for this managed resource.
network_endpoints List[NodeNetworkEndpoint]: 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.
service_account str: 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.

Look up an Existing Node Resource

Get an existing Node resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: NodeState, opts?: CustomResourceOptions): Node

static get(resource_name, id, opts=None, accelerator_type=None, cidr_block=None, description=None, labels=None, name=None, network=None, network_endpoints=None, project=None, scheduling_config=None, service_account=None, tensorflow_version=None, zone=None, __props__=None);

func GetNode(ctx *Context, name string, id IDInput, state *NodeState, opts ...ResourceOption) (*Node, error)

public static Node Get(string name, Input<string> id, NodeState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AcceleratorType string: The type of hardware accelerators associated with this node.
CidrBlock 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.
Labels Dictionary<string, string>: Resource labels to represent user provided metadata.
Name string: 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.
NetworkEndpoints List<NodeNetworkEndpointArgs>: 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.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SchedulingConfig NodeSchedulingConfigArgs: Sets the scheduling options for this TPU instance. Structure is documented below.
ServiceAccount string: 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: The version of Tensorflow running in the Node.
Zone string: The GCP location for the TPU.

AcceleratorType string: The type of hardware accelerators associated with this node.
CidrBlock 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.
Labels map[string]string: Resource labels to represent user provided metadata.
Name string: 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.
NetworkEndpoints []NodeNetworkEndpoint: 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.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SchedulingConfig NodeSchedulingConfig: Sets the scheduling options for this TPU instance. Structure is documented below.
ServiceAccount string: 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: The version of Tensorflow running in the Node.
Zone string: The GCP location for the TPU.

acceleratorType string: The type of hardware accelerators associated with this node.
cidrBlock 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.
labels {[key: string]: string}: Resource labels to represent user provided metadata.
name string: 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.
networkEndpoints NodeNetworkEndpoint[]: 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.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
schedulingConfig NodeSchedulingConfig: Sets the scheduling options for this TPU instance. Structure is documented below.
serviceAccount string: 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: The version of Tensorflow running in the Node.
zone string: The GCP location for the TPU.

accelerator_type str: The type of hardware accelerators associated with this node.
cidr_block str: 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 str: The user-supplied description of the TPU. Maximum of 512 characters.
labels Dict[str, str]: Resource labels to represent user provided metadata.
name str: The immutable name of the TPU.
network str: 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.
network_endpoints List[NodeNetworkEndpoint]: 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.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
scheduling_config Dict[NodeSchedulingConfig]: Sets the scheduling options for this TPU instance. Structure is documented below.
service_account str: 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.
tensorflow_version str: The version of Tensorflow running in the Node.
zone str: The GCP location for the TPU.

Supporting Types

NodeNetworkEndpoint

See the output API doc for this type.

IpAddress string
Port int

IpAddress string
Port int

ipAddress string
port number

ip_address str
port float

NodeSchedulingConfig

See the input and output API doc for this type.

Preemptible bool: Defines whether the TPU instance is preemptible.

Preemptible bool: Defines whether the TPU instance is preemptible.

preemptible boolean: Defines whether the TPU instance is preemptible.

preemptible bool: Defines whether the TPU instance is preemptible.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud