Connect a TPU Node to a shared VPC network

Important: This guide explains how to set up Cloud TPUs that use a centrally managed Shared VPC network. This document assumes you are familiar with VPCs and have created a shared VPC. For more information on how to create and manage Shared VPC networks, see Create and modify VPC networks.

How you connect a TPU host to a Shared VPC depends upon which TPU architecture (TPU VM or TPU Node) you are using. For more information about TPU architectures, see TPU System Architecture.

Connect a TPU VM to a Shared VPC Network

Configure a VPC host project

When you use the TPU VM architecture, you need to grant the TPU Service Account in your service project permissions to manage resources in the host project. You do this using the "TPU Shared VPC Agent" (roles/tpu.xpnAgent) role. Run the following gcloud commands to grant this role binding.

gcloud projects add-iam-policy-binding \
--member=serviceAccount:[e-mail] \
--role=roles/tpu.xpnAgent \
--project host-project-id

Note: You can find your service project number in the project info section of the Google Cloud Console dashboard.

Create a TPU VM connected to a Shared VPC Network

First determine which accelerator types and versions are available in the zone

gcloud alpha compute tpus accelerator-types list --zone zone

gcloud alpha compute tpus versions list --zone zone

You connect a TPU VM to a shared VPC network when you create your TPU. Specify your shared VPC using the --network tag:

gcloud alpha compute tpus tpu-vm create tpu-name \
--zone zone \
--accelerator-type accelerator-type \
--network projects/host-project-id/global/networks/host-network \
--version accelerator-version \
--project your-service-project-id

Note: The --network tag must be set to the fully qualified network name. For example, projects/<my-host-project-id>/global/networks/<my-network>.

You can verify your TPU VM is connected to your shared VPC using the gcloud alpha compute tpus tpu-vm describe command:

$ gcloud alpha compute tpus tpu-vm describe tpu-name --zone zone

The response includes the network to which your TPU VM is attached:

acceleratorType: v3-8
apiVersion: V2_ALPHA1
cidrBlock: 10.128.0.0/20
createTime: '2022-06-17T21:32:13.859274143Z'
health: HEALTHY
id: '0000000000000000000'
name: projects/my-project/locations/us-central1-b/nodes/my-tpu
networkConfig:
  enableExternalIps: true
  network: projects/my-project/global/networks/default
  subnetwork: projects/my-project/regions/us-central1/subnetworks/default
networkEndpoints:
- accessConfig:
    externalIp: 000.000.000.000
  ipAddress: 10.128.0.104
  port: 8470
runtimeVersion: tpu-vm-tf-2.8.0
schedulingConfig: {}
serviceAccount:
  email: [e-mail]
  scope:
  - https://www.googleapis.com/auth/devstorage.read_write
  - https://www.googleapis.com/auth/logging.write
  - https://www.googleapis.com/auth/service.management
  - https://www.googleapis.com/auth/servicecontrol
  - https://www.googleapis.com/auth/cloud-platform
  - https://www.googleapis.com/auth/pubsub
shieldedInstanceConfig: {}
state: READY

Retrieve information about a specific TPU Node

$ 

The response contains the following information:

Connecting a TPU Node to a Shared VPC

Configure Private Service Access

Before you use TPU Nodes with Shared VPCs, you need to establish a private service access connection.

1. Enable the Service Networking API using the following Google Cloud CLI command. This only needs to be done once per Cloud Platform Project.

   gcloud services enable servicenetworking.googleapis.com
   

2. Allocate a reserved address range for use by Service Networking. The prefix-length needs to be 24 or less. For example:

   gcloud compute addresses create sn-range-1 --global \
   --addresses=10.110.0.0 \
   --prefix-length=16 \
   --purpose=VPC_PEERING \
   --network=network-name

3. Establish a private service access connection.

   $ gcloud services vpc-peerings connect --service=servicenetworking.googleapis.com \
   --ranges=sn-range-1 \
   --network=network-name
   

4. Verify the VPC peering has been created. The following command lists all VPC peerings for the specified network.

   gcloud services vpc-peerings list --network=network-name
   

Connect a TPU Node with a Shared VPC Network

You connect a TPU Node to a shared VPC network when you create your TPU. Specify your shared VPC using the --network tag:

$ gcloud compute tpus execution-groups create \
  --name=tpu-name \
  --zone=zone \
  --tf-version=2.7.0 \
  --machine-type=n1-standard-1 \
  --accelerator-type=v3-8 \
  --network=network-name \
  --use-service-networking=true

Note: The --network tag must be set to the fully qualified network name. For example, projects/my-host-project-id/global/networks/my-network.

Retrieve information about a specific TPU Node

$ gcloud alpha compute tpus describe tpu-name --zone zone

Note: Set --zone to the zone where you created the TPU VM.

The response contains the following information:

FIELD                                VALUE
Compute Engine Instance IP Address:  00.000.0.000
Compute Engine Created:              2022-06-17T15:53:00.256-07:00
Compute Engine Machine Type:         https://www.googleapis.com/compute/v1/projects/your-project/zones/us-central1-b/machineTypes/n1-standard-1
TPU Accelerator Type:                v3-8
TPU IP Address:                      00.000.000.00
TPU TF Version:                      2.8.0
TPU Service Account:                 [e-mail]
TPU Created:                         2022-06-17T22:52:58.806015133Z
TPU State:                           READY
TPU Health:                          HEALTHY
TPU Preemptible:

Delete the VPC peering

A peering connection can be disconnected using the compute networking API. These calls should be made in Shared VPC host projects.

1. List all VPC peerings.

   $ gcloud compute networks peerings list --network=network-name
   

2. Delete a VPC peering.

   $ gcloud compute networks peerings delete peering-name --network=network-name