Set Up VPC Peering Connections

To connect your application to TiDB Cloud, you need to set up VPC peering with TiDB Cloud. It's one step of Connect to Your TiDB Cluster. This document walks you through setting up VPC peering connections on AWS and on GCP.

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 Cloud only supports VPC peering in the same region for the same project. 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.

Prerequisites

Project CIDR (Classless Inter-Domain Routing) is the CIDR block used for network peering in a project.

Before adding VPC Peering requests to a region, you need to add a Project CIDR for your project's AWS and GCP respectively to establish a peering link to your application's VPC.

Note:

When setting the Project CIDR, avoid any conflicts with the CIDR of the VPC where your application is located.

  1. Go to the Project CIDR page of the target project.

    Project-CIDR

  2. Select your cloud provider, click Add A Project CIDR, and then specify the project CIDR.

    You can either use your own CIDR block or use the default 172.24.0.0/13 CIDR block.

    If you use your own CIDR block, ensure the following:

    • The CIDR block must be a private network.
    • The subnet mask of the CIDR block is not greater than 17.

    Project-CIDR1

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

    • The region CIDR is inactive by default. To activate the region 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.

    Project-CIDR2

On AWS

Step 1: Add VPC peering requests

  1. Go to the VPC Peering page of the target project and click Add.

  2. On the Add VPC Peering dialog, fill in the required information of your existing AWS VPC:

    • AWS Account ID
    • VPC ID
    • CIDR
    • Region

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

    VPC peering

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

    Add VPC peering

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

  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.

    # Set up the related variables.
    pcx_tidb_to_app_id="<TiDB peering id>"
    app_region="<APP Region>"
    app_vpc_id="<Your VPC ID>"
    tidb_phz_id="<TiDB private hosted zone for you>"

    For example:

    # Set up the related variables
    pcx_tidb_to_app_id="pcx-069f41efddcff66c8"
    app_region="us-west-2"
    app_vpc_id="vpc-0039fb90bb5cf8698"
    tidb_phz_id="Z07551272U929P4PN8MQT"
  4. Execute 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|xargs -d "\t" -n 1|  while read row
    do
        app_route_table_id="$row"
        aws ec2 create-route --route-table-id "$app_route_table_id" --destination-cidr-block 172.24.0.0/13 --vpc-peering-connection-id "$pcx_tidb_to_app_id"
    done
    # 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 come to the VPC service page.

      AWS dashboard

    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). Right click on the peering connection and click Accept Request to accept the request.

      AWS VPC peering requests

  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.

      Search all route tables related to VPC

    3. Edit each route table to add a route with destination to the TiDB Cloud VPC CIDR (172.24.0.0/13), and select your peering ID on the Target column.

      Edit all route tables

  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.

Step 3: Connect to the TiDB cluster on TiDB Cloud

  1. Navigate to the TiDB Cluster page and find your cluster.

  2. Click Connect. The Connect to TiDB dialog displays. You could see the Status of the VPC peering is active.

  3. Access the TiDB Cluster from the instance within the VPC. See Connect to Your TiDB Cluster.

On GCP

Steps

  1. Go to the VPC Peering page of the target project and click Add.

    VPC-Peering

  2. On the Add VPC Peering dialog, fill in the required information of your existing GCP VPC:

    • Region
    • Application GCP project ID
    • VPC Network Name

    VPC-Peering

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

  4. Check your TiDB VPC peering connection information, and accept peering link requests on the GCP side.

    VPC-Peering

  5. Execute the following command to finish the VPC peering setup:

    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.