-
Notifications
You must be signed in to change notification settings - Fork 708
premium: add alibaba cloud private endpoint doc #21954
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
ti-chi-bot
merged 24 commits into
pingcap:release-8.5
from
wildpcww:alibabacloud-privatelink
Nov 5, 2025
Merged
Changes from all commits
Commits
Show all changes
24 commits
Select commit
Hold shift + click to select a range
3699489
tidbcloud: add aliyun private link doc
wildpcww c3a36b5
pic added
wildpcww ec003a4
Update tidb-cloud/set-up-private-endpoint-connections-on-alibaba-clou…
wildpcww 963825d
Rename the doc file and fix image name
lilin90 5a4163b
Merge branch 'release-8.5' into pr/21954
lilin90 bc7bde6
Fix an anchor link
lilin90 8e13710
Merge branch 'release-8.5' into pr/21954
lilin90 943c3cc
Update titles for consistency
lilin90 92217f3
Update tidb-cloud/premium/connect-to-premium-via-alibaba-cloud-privat…
wildpcww e0f5518
Update tidb-cloud/premium/connect-to-premium-via-alibaba-cloud-privat…
wildpcww aacea88
Update tidb-cloud/premium/connect-to-premium-via-alibaba-cloud-privat…
wildpcww 6fb0eab
Update tidb-cloud/premium/connect-to-premium-via-alibaba-cloud-privat…
wildpcww 7f7302e
Update tidb-cloud/premium/connect-to-premium-via-alibaba-cloud-privat…
wildpcww 5a3fe0b
Update tidb-cloud/premium/connect-to-premium-via-alibaba-cloud-privat…
wildpcww aa77f86
Update tidb-cloud/premium/connect-to-premium-via-alibaba-cloud-privat…
wildpcww 11da8c2
Update tidb-cloud/premium/connect-to-premium-via-alibaba-cloud-privat…
wildpcww f98720d
Update tidb-cloud/premium/connect-to-premium-via-alibaba-cloud-privat…
wildpcww 18b000c
Update tidb-cloud/premium/connect-to-premium-via-alibaba-cloud-privat…
wildpcww 414d241
Apply suggestions from code review
lilin90 e91807a
Update alicloud private endpoint info image
lilin90 ea2c1c9
Update private endpoint links for premium docs
lilin90 ef384ae
Apply suggestions from code review
lilin90 dbe380d
Apply suggestions from code review
lilin90 d29f1ac
Update wording for consistency
lilin90 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
88 changes: 88 additions & 0 deletions
88
tidb-cloud/premium/connect-to-premium-via-alibaba-cloud-private-endpoint.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| --- | ||
lilin90 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| title: Connect to {{{ .premium }}} via Alibaba Cloud Private Endpoint | ||
| summary: Learn how to connect to your {{{ .premium }}} instance via a private endpoint on Alibaba Cloud. | ||
| --- | ||
|
|
||
| # Connect to {{{ .premium }}} via Alibaba Cloud Private Endpoint | ||
|
|
||
| This document describes how to connect to your {{{ .premium }}} instance via a private endpoint on Alibaba Cloud. Connecting through a private endpoint enables secure and private communication between your services and your TiDB instance without using the public internet. | ||
|
|
||
| > **Tip:** | ||
| > | ||
| > To learn how to connect to a {{{ .premium }}} instance via AWS PrivateLink, see [Connect to {{{ .premium }}} via AWS PrivateLink](/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md). | ||
|
|
||
| ## Restrictions | ||
|
|
||
| - Currently, TiDB Premium supports private endpoint connections when the endpoint service is hosted on AWS or Alibaba Cloud. If the service is hosted on another cloud provider, the private endpoint is not applicable. | ||
| - Cross-region private endpoint connections are not supported. | ||
|
|
||
| ## Set up a private endpoint with Alibaba Cloud | ||
|
|
||
| To connect to your Premium instance via a private endpoint, perform the following steps. | ||
|
|
||
| ### Step 1. Choose a TiDB instance | ||
|
|
||
| 1. On the [**TiDB Instances**](https://{{{.console-url}}}/instances) page, click the name of your target TiDB instance 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**. | ||
| 4. Take a note of **Service Name**, **Availability Zone ID**, and **Region ID**. | ||
|
|
||
| ### Step 2. Create a private endpoint on Alibaba Cloud | ||
|
|
||
| To use the Alibaba Cloud Management Console to create a VPC interface endpoint, perform the following steps: | ||
|
|
||
| 1. Sign in to the [Alibaba Cloud Management Console](https://account.alibabacloud.com/login/login.htm). | ||
| 2. Navigate to **VPC** > **Endpoints**. | ||
| 3. Click the **Interface Endpoints** tab, and then click **Create Endpoint**. | ||
| 4. Fill in the endpoint details: | ||
| - **Region**: select the same region as your TiDB Cloud instance. | ||
| - **Endpoint Name**: enter a name for the endpoint. | ||
| - **Endpoint Type**: choose **Interface Endpoint**. | ||
| - **Endpoint Service**: select **Other Endpoint Services**. | ||
| 5. In the **Endpoint Service Name** field, paste the service name you copied from TiDB Cloud. | ||
| 6. Click **Verify**. A green check mark indicates that the service is valid. | ||
| 7. Choose the **VPC**, **Security Group**, and **Zone** to associate with the endpoint. | ||
| 8. Click **OK** to create the endpoint. | ||
| 9. Wait until the endpoint status is **Active** and the connection status is **Connected**. | ||
|
|
||
| After creating the interface endpoint, navigate to the **EndPoints** page and select the newly created endpoint. | ||
|
|
||
| - In the **Basic Information** section, copy the **Endpoint ID**. You will use this value later as the *Endpoint Resource ID*. | ||
|
|
||
| - In the **Domain name of Endpoint Service** section, copy the **Default Domain Name**. You will use this value later as the *Domain Name*. | ||
|
|
||
|  | ||
|
|
||
| ### Step 3. Accept the endpoint and create the endpoint connection | ||
|
|
||
| 1. Return to the **Create Alibaba Cloud Private Endpoint Connection** dialog in the TiDB Cloud console. | ||
|
|
||
| 2. Paste the *Endpoint Resource ID* and *Domain Name* that you copied earlier into the corresponding fields. | ||
|
|
||
| 3. Click **Create Private Endpoint Connection** to accept the connection from your private endpoint. | ||
|
|
||
| ### Step 4. Connect to your TiDB instance | ||
|
|
||
| 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). To check the status, navigate to the **Networking** page by clicking **Settings** > **Networking** in the left navigation pane. | ||
|
|
||
| 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 instance using the connection string. | ||
|
|
||
| ## Private endpoint status reference | ||
|
|
||
| To view the statuses of private endpoints or private endpoint services, navigate to the **Networking** page by clicking **Settings** > **Networking** in the left navigation pane. | ||
|
|
||
| The possible statuses of a private endpoint are explained as follows: | ||
|
|
||
| - **Pending**: waiting for processing. | ||
| - **Active**: the private endpoint is ready for use. | ||
| - **Deleting**: the private endpoint is being deleted. | ||
| - **Failed**: the private endpoint creation fails. You can delete the private endpoint and create a new one. | ||
|
|
||
| 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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.