Skip to content

tidb-cloud: add Azure private link support #20873

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 34 commits into from
May 19, 2025
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
905a0af
Create set-up-private-endpoint-connections-on-azure.md
nicole-yc Apr 27, 2025
9c6276d
Azure private link user doc
nicole-yc Apr 28, 2025
c4f073f
Update tidb-cloud/set-up-private-endpoint-connections-on-azure.md
nicole-yc Apr 30, 2025
25fecc2
Update tidb-cloud/set-up-private-endpoint-connections-on-azure.md
nicole-yc Apr 30, 2025
d90fc2e
Update tidb-cloud/set-up-private-endpoint-connections-on-azure.md
nicole-yc Apr 30, 2025
b31a567
Update tidb-cloud/set-up-private-endpoint-connections-on-azure.md
nicole-yc Apr 30, 2025
2b57e20
Update tidb-cloud/set-up-private-endpoint-connections-on-azure.md
nicole-yc Apr 30, 2025
7669a41
Update tidb-cloud/set-up-private-endpoint-connections-on-azure.md
nicole-yc Apr 30, 2025
7ad640c
Update tidb-cloud/set-up-private-endpoint-connections-on-azure.md
nicole-yc Apr 30, 2025
cc944a2
Update tidb-cloud/set-up-private-endpoint-connections-on-azure.md
nicole-yc Apr 30, 2025
45db46d
Update tidb-cloud/set-up-private-endpoint-connections-on-azure.md
nicole-yc Apr 30, 2025
bcdc47e
Update tidb-cloud/set-up-private-endpoint-connections-on-azure.md
nicole-yc Apr 30, 2025
1f4dece
Update tidb-cloud/set-up-private-endpoint-connections-on-azure.md
nicole-yc Apr 30, 2025
f2d1625
Update tidb-cloud/set-up-private-endpoint-connections-on-azure.md
nicole-yc Apr 30, 2025
41cbba5
Update tidb-cloud/set-up-private-endpoint-connections-on-azure.md
nicole-yc Apr 30, 2025
bc19146
Update tidb-cloud/set-up-private-endpoint-connections-on-azure.md
nicole-yc Apr 30, 2025
1b216b1
Update tidb-cloud/set-up-private-endpoint-connections-on-azure.md
nicole-yc Apr 30, 2025
2c9cc85
commit after rework
nicole-yc Apr 30, 2025
c5e8d6c
commit after rework again
nicole-yc Apr 30, 2025
21c46db
commit after rework again again
nicole-yc May 1, 2025
702c1bf
Update set-up-private-endpoint-connections-on-azure.md
nicole-yc May 1, 2025
c7e4d7d
Update set-up-private-endpoint-connections-on-azure.md
nicole-yc May 3, 2025
b5c953c
minor formatting and wording updates
qiancai May 6, 2025
8db01fc
Update TOC-tidb-cloud.md
qiancai May 6, 2025
f91fca0
refine faq descriptions
qiancai May 8, 2025
fcd7287
add necessary links
qiancai May 9, 2025
76c8756
Apply suggestions from code review
qiancai May 14, 2025
82e5bbf
unify the naming of private endpoint docs
qiancai May 14, 2025
d3cad6b
update the images to follow a consistent screenshot style
qiancai May 14, 2025
9ee72f7
Apply suggestions from code review
qiancai May 14, 2025
804c317
update the steps of creating endpoints
qiancai May 15, 2025
b624026
correct endpoint names
qiancai May 15, 2025
dcd65ae
Merge branch 'azure-private-link' of https://github.com/nicole-yc/tid…
qiancai May 15, 2025
13916ab
add a footnote about the architecture of Azure Private Link
qiancai May 15, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tidb-cloud/azure-private-endpoint-arch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might need to add a blur effect to the contents of Suscription ID and Resource ID in this image?

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
115 changes: 115 additions & 0 deletions tidb-cloud/set-up-private-endpoint-connections-on-azure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
---
title: Connect to a TiDB Cloud Dedicated Cluster via Private Endpoint with Azure
summary: Learn how to connect to your TiDB Cloud cluster via Azure Private Endpoint.
---

# Connect to a TiDB Dedicated Cluster via Azure Private Endpoint

This document describes how to connect to your TiDB Dedicated cluster via Azure Private Endpoint.

> **Tip:**
>
> - To learn how to connect to a TiDB Dedicated cluster via private endpoint with AWS, see [Connect to TiDB Dedicated via Private Endpoint with AWS](/tidb-cloud/set-up-private-endpoint-connections.md).
> - To learn how to connect to a TiDB Dedicated cluster via private endpoint with Google Cloud, see [Connect to TiDB Dedicated via Private Service Connect with Google Cloud](/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md)
> - To learn how to connect to a TiDB Serverless cluster via private endpoint, see [Connect to TiDB Serverless via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md).

TiDB Cloud supports highly secure and one-way access to the TiDB Cloud service hosted in an Azure VNET via the [Azure Private Link](https://learn.microsoft.com/en-us/azure/private-link/private-link-overview), as if the service were in your own VNET. A private endpoint is exposed in your VNET and you can create a connection to the TiDB Cloud service via the endpoint with permission.

Powered by Azure Private Link, the endpoint connection is secure and private, and does not expose your data to the public internet. In addition, the endpoint connection supports CIDR overlap and is easier for network management.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's necessary to mention CIDR overlapping here.

Copy link
Author

@nicole-yc nicole-yc Apr 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will keep this because the sentence is same as AWS and GCP. Thanks!


The architecture of Azure private endpoint is as follows:

![Azure Private Endpoint architecture](/media/tidb-cloud/azure-private-endpoint-arch.png)

For more detailed definitions of the private endpoint and endpoint service, see the following Azure documents:

- [What is Azure Private Link?](https://learn.microsoft.com/en-us/azure/private-link/private-link-overview)
- [What is a private endpoint?](https://learn.microsoft.com/en-us/azure/private-link/private-endpoint-overview)
- [Create a private endpoint](https://learn.microsoft.com/en-us/azure/private-link/create-private-endpoint-portal?tabs=dynamic-ip)

## Restrictions

- Only the `Organization Owner` and `Project Owner` roles can create Private Endpoints.
- The private endpoint and the TiDB cluster to be connected must be located in the same region.

## Set up a private endpoint with Azure Private Link

To connect to your TiDB Cloud Dedicated cluster via a private endpoint, complete the follow these steps:

1. [Select a TiDB cluster](#step-1-select-a-tidb-cluster)
2. [Create Azure private endpoint](#step-2-create-Azure-private-endpoint)
3. [Accept endpoint](#step-3-accept-endpoint)
4. [Connect to your TiDB cluster](#step-4-connect-to-your-tidb-cluster)

If you have multiple clusters, you need to repeat these steps for each cluster that you want to connect to using Azure Private Link.

### Step 1. Select a TiDB cluster

1. On the [**Clusters**](https://tidbcloud.com/console/clusters) page, click the name of your target TiDB cluster to go to its overview page.
2. Click **Connect** in the upper-right corner. A connection dialog is displayed.
3. In the **Connection Type** drop-down list, select **Private Endpoint**, and then click **Create Private Endpoint Connection**].

> **Note:**
>
> If you have already created a private endpoint connection, the active endpoint will appear in the connection dialog. To create additional private endpoint connections, navigate to the **Networking** page in the left navigation pane.

### Step 2. Create Azure private endpoint

1. In **Create Azure Private Endpoint Connection** page, copy the value provided for **Resource ID** of private link service. Do not close the window for later use.

> **Note:**
>
> For each TiDB Cloud Dedicated cluster, the corresponding endpoint service is automatically created 3 to 4 minutes after the cluster creation.

2. Log in Azure Console and create a new private endpoint for your cluster using the copied Resource ID. For details, please refer to [Create a private endpoint](https://learn.microsoft.com/en-us/azure/private-link/create-private-endpoint-portal?tabs=dynamic-ip) in Azure documentation.
1. Set the **connection method** to "Connect to an Azure resource by resource ID or alias" in **Resource** step.
2. Paste the copied Resource ID to the field of "**Resource ID or alias**".
![Create Azure private endpoint using service resource id](/media/tidb-cloud/azure-create-private-endpoint-service-resource-id.png)
3. After the private endpoint is created, please go to Settings and copy the following information,
1. Click **Properties** and copy its **Resource ID**.
![Azure private endpoint resource id](/media/tidb-cloud/azure-private-endpoint-resource-id.png)
2. Click **DNS configuration** and copy its **IP address**.
![Azure private endpoint dns ip](/media/tidb-cloud/azure-private-endpoint-dns-ip.png)


### Step 3. Accept endpoint

1. Return to the TiDB Cloud console, and paste the copied **Resource ID** and **IP address** to the corresponding field.
2. Click **Verify Endpoint** to validate the private endpoint's information. If you meet the error, please check the information and try it again.
3. Once verification passes, click **Accept Endpoint** to approve the connection from your private endpoint.

### Step 4. Connect to your TiDB cluster

After you have accepted the endpoint connection, you are redirected back to the connection dialog.

1. Wait for the private endpoint connection status to become Active (approximately 5 minutes).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the user need to go to the Networking page to check if the private endpoint connection is active?

2. In the Connect With drop-down list, select your preferred connection method. The corresponding connection string is displayed at the bottom of the dialog.
3. Connect to your cluster with the connection string.

### Private endpoint status reference

When you use private endpoint connections, the statuses of private endpoints or private endpoint services are displayed.

The possible statuses of a private endpoint are explained as follows:

- **Discovered**: TiDB Cloud can automatically detect your private endpoint associated with the endpoint service before accepting the request to prevent the need for creating another one.
- **Pending**: waiting for processing.
- **Active**: your private endpoint is ready to use. You cannot edit the private endpoint of this status.
- **Deleting**: the private endpoint is being deleted.
- **Failed**: the private endpoint creation fails. You can click **Edit** of that row to retry the creation.

The possible statuses of a private endpoint service are explained as follows:

- **Creating**: the endpoint service is being created, which takes 3 to 5 minutes.
- **Active**: the endpoint service is created, no matter whether the private endpoint is created or not.

## Troubleshooting

### TiDB Cloud fails to create an endpoint service. What should I do?

The endpoint service is created automatically after you open the **Create Azure Private Endpoint** page and choose the TiDB cluster. If it shows as failed or remains in the **Creating** state for a long time, submit a [support ticket](/tidb-cloud/tidb-cloud-support.md) for assistance.


### If I cancel the action during set up, what should I do before accepting private endpoint?

Azure private endpoint connection feature can automatically detect your private endpoints. This means if you cancel your action during the setup of a private endpoint connection, you can still view your created endpoint on the networking page. If the cancellation is unintentional, you can continue to edit it to complete the setup. If the cancellation is deliberate, you can delete it directly in TiDB Cloud side.
Loading