Connect to TiDB Dedicated via VPC Peering

To connect your application to TiDB Cloud via VPC peering, you need to set up VPC peering with TiDB Cloud. This document walks you through setting up VPC peering connections on AWS and on Google Cloud and connecting to TiDB Cloud via a VPC peering.

VPC peering connection is a networking connection between two VPCs that enables you to route traffic between them using private IP addresses. Instances in either VPC can communicate with each other as if they are within the same network.

Currently, TiDB clusters of the same project in the same region are created in the same VPC. Therefore, once VPC peering is set up in a region of a project, all the TiDB clusters created in the same region of this project can be connected in your VPC. VPC peering setup differs among cloud providers.

Prerequisite: Set a CIDR for a region

CIDR (Classless Inter-Domain Routing) is the CIDR block used for creating VPC for TiDB Dedicated clusters.

Before adding VPC Peering requests to a region, you must set a CIDR for that region and create an initial TiDB Dedicated cluster in that region. Once the first Dedicated cluster is created, TiDB Cloud will create the VPC of the cluster, allowing you to establish a peering link to your application's VPC.

You can set the CIDR when creating the first TiDB Dedicated cluster. If you want to set the CIDR before creating the cluster, perform the following operations:

1. Log in to the TiDB Cloud console.

2. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click Project Settings.

3. On the Project Settings page of your project, click Network Access in the left navigation pane, and then click the Project CIDR tab.

4. Click Create CIDR, and then click AWS CIDR or Google Cloud CIDR according to your cloud provider. Specify the region and CIDR value in the Create AWS CIDR or Create Google Cloud CIDR window, and then click Confirm.

   

   Note

   • To avoid any conflicts with the CIDR of the VPC where your application is located, you need to set a different project CIDR in this field.
   • For AWS Region, it is recommended to configure an IP range size between /16 and /23. Supported network addresses include:
     • 10.250.0.0 - 10.251.255.255
     • 172.16.0.0 - 172.31.255.255
     • 192.168.0.0 - 192.168.255.255

   • For Google Cloud Region, it is recommended to configure an IP range size between /19 and /20. If you want to configure an IP range size between /16 and /18, contact TiDB Cloud Support. Supported network addresses include:
     • 10.250.0.0 - 10.251.255.255
     • 172.16.0.0 - 172.17.255.255
     • 172.30.0.0 - 172.31.255.255

   • TiDB Cloud limits the number of TiDB Cloud nodes in a region of a project based on the CIDR block size of the region.

5. View the CIDR of the cloud provider and the specific region.

   The CIDR is inactive by default. To activate the CIDR, you need to create a cluster in the target region. When the region CIDR is active, you can create VPC Peering for the region.

   

Set up VPC peering on AWS

This section describes how to set up VPC peering connections on AWS. For Google Cloud, see Set up VPC peering on Google Cloud.

Step 1. Add VPC peering requests

1. Log in to the TiDB Cloud console.

2. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click Project Settings.

3. On the Project Settings page of your project, click Network Access in the left navigation pane, and then click the VPC Peering tab.

   The VPC Peering configuration is displayed by default.

4. Click Add, choose the AWS icon, and then fill in the required information of your existing AWS VPC:

   • Region
   • AWS Account ID
   • VPC ID
   • VPC CIDR

   You can get these information from your VPC details on the VPC dashboard.

   

5. Click Initialize. The Approve VPC Peerings dialog is displayed.

Step 2. Approve and configure the VPC peering

Use either of the following two options to approve and configure the VPC peering connection:

• Option 1: Use AWS CLI
• Option 2: Use the AWS dashboard

Option 1. Use AWS CLI

1. Install AWS Command Line Interface (AWS CLI).

   curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
   unzip awscliv2.zip
   sudo ./aws/install
   

2. Configure AWS CLI according to your account information. To get the information required by AWS CLI, see AWS CLI configuration basics.

   aws configure
   

3. Replace the following variable values with your account information.

   # Sets up the related variables.
   pcx_tidb_to_app_id="<TiDB peering id>"
   app_region="<APP Region>"
   app_vpc_id="<Your VPC ID>"
   tidbcloud_project_cidr="<TiDB Cloud Project VPC CIDR>"
   

   For example:

   # Sets up the related variables
   pcx_tidb_to_app_id="pcx-069f41efddcff66c8"
   app_region="us-west-2"
   app_vpc_id="vpc-0039fb90bb5cf8698"
   tidbcloud_project_cidr="10.250.0.0/16"
   

4. Run the following commands.

   # Accepts the VPC peering connection request.
   aws ec2 accept-vpc-peering-connection --vpc-peering-connection-id "$pcx_tidb_to_app_id"
   

   # Creates route table rules.
   aws ec2 describe-route-tables --region "$app_region" --filters Name=vpc-id,Values="$app_vpc_id" --query 'RouteTables[*].RouteTableId' --output text | tr "\t" "\n" | while read row
   do
       app_route_table_id="$row"
       aws ec2 create-route --route-table-id "$app_route_table_id" --destination-cidr-block "$tidbcloud_project_cidr" --vpc-peering-connection-id "$pcx_tidb_to_app_id"
   done
   

   Note

   Sometimes, even if the route table rules are successfully created, you might still get the An error occurred (MissingParameter) when calling the CreateRoute operation: The request must contain the parameter routeTableId error. In this case, you can check the created rules and ignore the error.

   # Modifies the VPC attribute to enable DNS-hostname and DNS-support.
   aws ec2 modify-vpc-attribute --vpc-id "$app_vpc_id" --enable-dns-hostnames
   aws ec2 modify-vpc-attribute --vpc-id "$app_vpc_id" --enable-dns-support
   

After finishing the configuration, the VPC peering has been created. You can connect to the TiDB cluster to verify the result.

Option 2. Use the AWS dashboard

You can also use the AWS dashboard to configure the VPC peering connection.

1. Confirm to accept the peer connection request in your AWS console.

   1. Sign in to the AWS console and click Services on the top menu bar. Enter VPC in the search box and go to the VPC service page.

      

   2. From the left navigation bar, open the Peering Connections page. On the Create Peering Connection tab, a peering connection is in the Pending Acceptance status.

   3. Confirm the requester owner is TiDB Cloud (380838443567 or 143458967504). Right-click the peering connection and select Accept Request to accept the request in the Accept VPC peering connection request dialog.

      

2. Add a route to the TiDB Cloud VPC for each of your VPC subnet route tables.

   1. From the left navigation bar, open the Route Tables page.

   2. Search all the route tables that belong to your application VPC.

      

   3. Right-click each route table and select Edit routes. On the edit page, add a route with a destination to the TiDB Cloud CIDR (by checking the VPC Peering configuration page in the TiDB Cloud console) and fill in your peering connection ID in the Target column.

      

3. Make sure you have enabled private DNS hosted zone support for your VPC.

   1. From the left navigation bar, open the Your VPCs page.

   2. Select your application VPC.

   3. Right click on the selected VPC. The setting drop-down list displays.

   4. From the setting drop-down list, click Edit DNS hostnames. Enable DNS hostnames and click Save.

   5. From the setting drop-down list, click Edit DNS resolution. Enable DNS resolution and click Save.

Now you have successfully set up the VPC peering connection. Next, connect to the TiDB cluster via VPC peering.

Set up VPC peering on Google Cloud

1. Log in to the TiDB Cloud console.

2. Click in the lower-left corner, switch to the target project if you have multiple projects, and then click Project Settings.

3. On the Project Settings page of your project, click Network Access in the left navigation pane, and then click the VPC Peering tab.

   The VPC Peering configuration is displayed by default.

4. Click Add, choose the Google Cloud icon, and then fill in the required information of your existing Google Cloud VPC:

   Tip

   You can follow instructions next to the Application Google Cloud Project ID and VPC Network Name fields to find the project ID and VPC network name.

   • Region
   • Application Google Cloud Project ID
   • VPC Network Name
   • VPC CIDR

5. Click Initialize. The Approve VPC Peerings dialog is displayed.

6. Check the connection information of your TiDB VPC peerings.

   

7. Execute the following command to finish the setup of VPC peerings:

   gcloud beta compute networks peerings create <your-peer-name> --project <your-project-id> --network <your-vpc-network-name> --peer-project <tidb-project-id> --peer-network <tidb-vpc-network-name>
   

   Note

   You can name <your-peer-name> as you like.

Now you have successfully set up the VPC peering connection. Next, connect to the TiDB cluster via VPC peering.

Connect to the TiDB cluster

1. On the Clusters page, click the name of your target cluster to go to its overview page.

2. Click Connect in the upper-right corner, and select the VPC Peering tab in the connection dialog.

   You can see the Status of the VPC peering is active. If Status is still system checking, wait for about 5 minutes and open the dialog again.

3. Click Get Endpoint and wait for a few minutes. Then the connection command is displayed in the dialog.

4. Under Step 2: Connect with a SQL client in the dialog box, click the tab of your preferred connection method, and then connect to your cluster with the connection string.