-
Notifications
You must be signed in to change notification settings - Fork 709
cloud: add private link connection docs #22192
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 94 commits into
pingcap:release-8.5
from
shiyuhang0:private-link-connection
Jan 16, 2026
Merged
Changes from 90 commits
Commits
Show all changes
94 commits
Select commit
Hold shift + click to select a range
2f7c7ba
add plc
shiyuhang0 77059dc
opt
shiyuhang0 0479792
some fix
shiyuhang0 992882e
some fix
shiyuhang0 ca4dad3
add toc
shiyuhang0 4be169d
some fix by ai
shiyuhang0 f4c6bf0
Apply suggestions from code review
shiyuhang0 ca176a2
fix
shiyuhang0 ba55775
fix lint
shiyuhang0 a5d2ad4
fix according to the preview
shiyuhang0 ccfd4fe
Apply suggestions from code review
shiyuhang0 a0ef99a
Update Alibaba Cloud RDS private link setup docs
hfxsd aed869e
Update tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md
hfxsd f6fe625
Update serverless-private-link-connection-to-alicloud-rds.md
hfxsd 203e2eb
Update serverless-private-link-connection-to-alicloud-rds.md
hfxsd 56e443e
Update serverless-private-link-connection-to-alicloud-rds.md
hfxsd fc113a1
Update docs for Private Link Connection setup
hfxsd 6466583
remove subnet group in alicloud rds
shiyuhang0 c2f9643
add link for subnet grup
shiyuhang0 156c135
add alicloud self-hosted kafka
shiyuhang0 4c5a5fa
some opt
shiyuhang0 ff6d3c0
Update private link connection docs for clarity and accuracy
hfxsd cd7c7ab
Merge branch 'private-link-connection' of https://github.com/shiyuhan…
hfxsd adfe661
Revise and clarify private link connection guides
hfxsd 5b53ba7
Update serverless-private-link-connection-to-self-hosted-kafka-in-aws.md
hfxsd 319e2f6
Update serverless-private-link-connection-to-self-hosted-kafka-in-aws.md
hfxsd 470d9ab
Update Alibaba Cloud and AWS private link docs for clarity
hfxsd d097da9
some opts for confluent
shiyuhang0 102aa34
some opts for confluent
shiyuhang0 fdb5c9d
fix provider in alibaba kafka
shiyuhang0 2b4e737
fix
shiyuhang0 d3c26e9
fix
shiyuhang0 724506b
Update TOC-tidb-cloud-essential.md
shiyuhang0 6f79fe1
opt see also
shiyuhang0 6b55ecd
Update tidb-cloud/serverless-private-link-connection.md
hfxsd a198ed6
Update serverless-private-link-connection.md
hfxsd 9883e04
Document Private Link Connections for Dataflow (Beta)
hfxsd 5f9b0d2
Update AWS Confluent and private link connection docs
hfxsd bdf8b07
Revise private link connection docs for clarity
hfxsd ffc965d
Update serverless-private-link-connection-to-alicloud-rds.md
hfxsd e1dcf14
Refactor and clarify private link domain attachment steps
hfxsd 0e69be8
Update serverless-private-link-connection-to-aws-rds.md
hfxsd 964c53c
some fix
shiyuhang0 341d238
Apply suggestions from code review
shiyuhang0 7416871
some fix
shiyuhang0 349bd46
opt ali rds network
shiyuhang0 d71b9e8
try to fix verify
shiyuhang0 c1fb427
try to fix verify
shiyuhang0 96427b9
Apply suggestions from code review
shiyuhang0 1bd17c3
add confleunt unique name link
shiyuhang0 f5535a2
fix dead link
shiyuhang0 54feec2
Restructure and clarify private link connection setup docs
hfxsd 424efe7
Update Private Link connection docs for clarity and conciseness
hfxsd e53e54f
Apply suggestions from code review
hfxsd ac95e4c
Update tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md
shiyuhang0 bf32079
add create confluent dedicated cluster
shiyuhang0 25416dc
fix verify
shiyuhang0 68664a2
Apply suggestions from code review
shiyuhang0 365607c
opt endpoint service request
shiyuhang0 14def46
Apply suggestions from code review
hfxsd e2d11ad
Apply suggestions from code review
hfxsd 83d4ac4
Apply suggestions from code review
hfxsd 6f81c0c
Remove serverless private link connection docs
hfxsd c258c10
Update TOC-tidb-cloud-essential.md
hfxsd 6e7e9eb
Apply suggestions from code review
hfxsd a6b594e
Apply suggestions from code review
hfxsd 7cd677e
Apply suggestions from code review
hfxsd 70e80ce
Merge branch 'release-8.5' into pr/22192
hfxsd 0978607
Revise private link connection guides for clarity
hfxsd 3aeb400
Clarify setup steps for RDS endpoint services
hfxsd 561d9ff
refine wording
hfxsd a6c8f42
Update serverless-private-link-connection-to-alicloud-rds.md
hfxsd 3401088
Clarify setup steps for private link connections
hfxsd 7640b22
Fix security group rule formatting in AWS RDS guide
hfxsd b272a54
Update serverless-private-link-connection-to-aws-rds.md
hfxsd 4b3477d
Remove commented-out block from See also section
hfxsd e667f59
Update TOC-tidb-cloud-essential.md
hfxsd 9698783
Update serverless-private-link-connection-to-aws-rds.md
hfxsd 551ce97
Update serverless-private-link-connection-to-aws-rds.md
hfxsd 3b9ad26
Update serverless-private-link-connection.md
hfxsd 2e28d8a
Update serverless-private-link-connection-to-alicloud-rds.md
hfxsd ecbb1fe
Apply suggestions from code review
hfxsd 6f4298f
Apply suggestions from code review
shiyuhang0 f5aa88f
use AWS or Alibaba Cloud account id
shiyuhang0 ef29ff3
Merge branch 'release-8.5' into pr/22192
qiancai c6aa5f5
Apply suggestions from code review
qiancai ba608ea
revise descriptions in serverless-private-link-connection-to-self-hos…
qiancai de34103
replace detailed steps in "Step 3. Create a Private Link Connection i…
qiancai 6534729
Apply suggestions from code review
shiyuhang0 7b16040
`Amazon linux` ->`Amazon Linux`
qiancai 4466520
Apply suggestions from code review
hfxsd 39266d0
Update serverless-private-link-connection.md
hfxsd d1bec8d
Merge branch 'private-link-connection' of https://github.com/shiyuhan…
hfxsd db818b7
Update serverless-private-link-connection-to-aws-rds.md
hfxsd 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
93 changes: 93 additions & 0 deletions
93
tidb-cloud/serverless-private-link-connection-to-alicloud-rds.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,93 @@ | ||
| --- | ||
| title: Connect to Alibaba Cloud ApsaraDB RDS for MySQL via a Private Link Connection | ||
| summary: Learn how to connect to an Alibaba Cloud ApsaraDB RDS for MySQL instance using an Alibaba Cloud Endpoint Service private link connection. | ||
| --- | ||
|
|
||
| # Connect to Alibaba Cloud ApsaraDB RDS for MySQL via a Private Link Connection | ||
|
|
||
| This document describes how to connect a {{{ .essential }}} cluster to an [Alibaba Cloud ApsaraDB RDS for MySQL](https://www.alibabacloud.com/en/product/apsaradb-for-rds-mysql) instance using an [Alibaba Cloud Endpoint Service private link connection](/tidb-cloud/serverless-private-link-connection.md). | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - You have an existing ApsaraDB RDS for MySQL instance or the permissions required to create one. | ||
|
|
||
| - Verify that your account has the following permissions to manage networking components: | ||
|
|
||
| - Manage load balancer | ||
| - Manage endpoint services | ||
|
|
||
| - Your {{{ .essential }}} cluster is on Alibaba Cloud, and it is active. Retrieve and save the following details for later use: | ||
|
|
||
| - Alibaba Cloud account ID | ||
| - Availability Zones (AZ) | ||
|
|
||
| To view the Alibaba Cloud account ID and availability zones, do the following: | ||
|
|
||
| 1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the cluster overview page of the TiDB cluster, and then click **Settings** > **Networking** in the left navigation pane. | ||
| 2. In the **Private Link Connection For Dataflow** area, click **Create Private Link Connection**. | ||
| 3. In the displayed dialog, you can find the Alibaba Cloud account ID and availability zones. | ||
|
|
||
| ## Step 1. Set up an ApsaraDB RDS for MySQL instance | ||
|
|
||
| Identify an Alibaba Cloud ApsaraDB RDS for MySQL that you want to use, or [create a new RDS](https://www.alibabacloud.com/help/en/rds/apsaradb-rds-for-mysql/step-1-create-an-apsaradb-rds-for-mysql-instance-and-configure-databases). | ||
|
|
||
| Your ApsaraDB RDS for MySQL instance must meet the following requirements: | ||
|
|
||
| - Region match: the instance must reside in the same Alibaba Cloud region as your {{{ .essential }}} cluster. | ||
| - AZ (Availability Zone) availability: the availability zones must overlap with those of your {{{ .essential }}} cluster. | ||
| - Network accessibility: the instance must be configured with a proper IP allowlist and be accessible within the VPC. | ||
|
|
||
| > **Note** | ||
| > | ||
| > Cross-region connections for ApsaraDB RDS for MySQL are not supported. | ||
|
|
||
| ## Step 2. Expose the ApsaraDB RDS for MySQL instance as an endpoint service | ||
|
|
||
| You need to set up the load balancer and the endpoint service in the Alibaba Cloud console. | ||
|
|
||
| ### Step 2.1. Set up the load balancer | ||
|
|
||
| Set up the load balancer in the same region as your ApsaraDB RDS for MySQL as follows: | ||
|
|
||
| 1. Go to [Server Groups](https://slb.console.alibabacloud.com/nlb/ap-southeast-1/server-groups) to create a server group. Provide the following information: | ||
|
|
||
| - **Server Group Type**: select `IP` | ||
| - **VPC**: enter the VPC where your ApsaraDB RDS for MySQL is located | ||
| - **Backend Server Protocol**: select `TCP` | ||
|
|
||
| 2. Click the created server group to add backend servers, and then add the IP address of your ApsaraDB RDS for MySQL instance. | ||
|
|
||
| You can ping the RDS endpoint to get the IP address. | ||
|
|
||
| 3. Go to [NLB](https://slb.console.alibabacloud.com/nlb) to create a network load balancer. Provide the following information: | ||
|
|
||
| - **Network Type**: select `Internal-facing` | ||
| - **VPC**: select the VPC where your ApsaraDB RDS for MySQL is located | ||
| - **Zone**: it must overlap with your {{{ .essential }}} cluster | ||
| - **IP Version**: select `IPv4` | ||
|
|
||
| 4. Find the load balancer you created, and then click **Create Listener**. Provide the following information: | ||
|
|
||
| - **Listener Protocol**: select `TCP` | ||
| - **Listener Port**: enter the database port, for example, `3306` for MySQL | ||
| - **Server Group**: choose the server group you created in the previous step | ||
|
|
||
| ### Step 2.2. Set up an endpoint service | ||
|
|
||
| To set up the endpoint service in the same region as your ApsaraDB RDS for MySQL, take the following steps: | ||
|
|
||
| 1. Go to [Endpoint Service](https://vpc.console.alibabacloud.com/endpointservice) to create an endpoint service. Provide the following information: | ||
|
|
||
| - **Service Resource Type**: select `NLB` | ||
| - **Select Service Resource**: select all zones that the NLB is in, and choose the NLB that you created in the previous step | ||
| - **Automatically Accept Endpoint Connections**: it is recommended to choose `No` | ||
|
|
||
| 2. Go to the details page of the endpoint service, and copy the **Endpoint Service Name**, for example, `com.aliyuncs.privatelink.<region>.xxxxx`. You need to use it for TiDB Cloud later. | ||
|
|
||
| 3. On the details page of the endpoint service, click the **Service Whitelist** tab, click **Add to Whitelist**, and then enter the Alibaba Cloud account ID that you obtained in [Prerequisites](#prerequisites) | ||
|
|
||
| ## Step 3. Create a private link connection in TiDB Cloud | ||
|
|
||
| You can create a private link connection using the TiDB Cloud console or the TiDB Cloud CLI. | ||
|
|
||
| For more information, see [Create an Alibaba Cloud Endpoint Service private link connection](/tidb-cloud/serverless-private-link-connection.md#create-an-alibaba-cloud-endpoint-service-private-link-connection). |
112 changes: 112 additions & 0 deletions
112
tidb-cloud/serverless-private-link-connection-to-aws-rds.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,112 @@ | ||
| --- | ||
| title: Connect to Amazon RDS via a Private Link Connection | ||
| summary: Learn how to connect to an Amazon RDS instance using an AWS Endpoint Service private link connection. | ||
| --- | ||
|
|
||
| # Connect to Amazon RDS via a Private Link Connection | ||
|
|
||
| This document describes how to connect a {{{ .essential }}} cluster to an [Amazon RDS](https://aws.amazon.com/rds/) instance using an [AWS Endpoint Service private link connection](/tidb-cloud/serverless-private-link-connection.md). | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - You have an existing Amazon RDS instance or the permissions required to create one. | ||
|
|
||
| - Your account has the following permissions to manage networking components: | ||
|
|
||
| - Manage security groups | ||
| - Manage load balancer | ||
| - Manage endpoint services | ||
|
|
||
| - Your {{{ .essential }}} is hosted on AWS, and it is active. Retrieve and save the following details for later use: | ||
|
|
||
| - AWS Account ID | ||
| - Availability Zones (AZ) | ||
|
|
||
| To view the AWS account ID and availability zones, do the following: | ||
|
|
||
| 1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the cluster overview page of the TiDB cluster, and then click **Settings** > **Networking** in the left navigation pane. | ||
| 2. In the **Private Link Connection For Dataflow** area, click **Create Private Link Connection**. | ||
| 3. In the displayed dialog, you can find the AWS account ID and availability zones. | ||
|
|
||
| ## Step 1. Set up the Amazon RDS instance | ||
|
|
||
| Identify an Amazon RDS instance to use, or [create a new one](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html). | ||
|
|
||
| The Amazon RDS instance must meet the following requirements: | ||
|
|
||
| - Region match: the instance must reside in the same AWS region as your {{{ .essential }}} cluster. | ||
| - The [subnet group](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) of your Amazon RDS instance must have availability zones that overlap with those of your {{{ .essential }}} cluster. | ||
| - Set your Amazon RDS instance with a proper security group, and ensure that it is accessible within the VPC. For example, you can create a security group with the following rules: | ||
|
|
||
| - An inbound rule that allows MySQL/Aurora: | ||
| - Type: `MySQL/Aurora` | ||
| - Source: `Anywhere-IPv4` | ||
|
|
||
| - An outbound rule that allows MySQL/Aurora: | ||
| - Type: `MySQL/Aurora` | ||
| - Destination: `Anywhere-IPv4` | ||
|
|
||
| > **Note** | ||
| > | ||
| > To connect to a cross-region RDS instance, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). | ||
|
|
||
| ## Step 2. Expose the Amazon RDS instance as an endpoint service | ||
|
|
||
| You need to set up the load balancer and the AWS Endpoint Service in the AWS console. | ||
|
|
||
| ### Step 2.1. Set up the load balancer | ||
|
|
||
| To set up the load balancer in the same region as your RDS, take the following steps: | ||
|
|
||
| 1. Go to [Target groups](https://console.aws.amazon.com/ec2/home#CreateTargetGroup) to create a target group. Provide the following information: | ||
|
|
||
| - **Target type**: select `IP addresses`. | ||
| - **Protocol and Port**: set the protocol to `TCP` and the port to your database port, for example `3306` for MySQL. | ||
| - **IP address type**: select `IPv4`. | ||
| - **VPC**: select the VPC where your RDS is located. | ||
| - **Register targets**: register the IP addresses of your Amazon RDS instance. You can ping the RDS endpoint to get the IP address. | ||
|
|
||
| For more information, see [Create a target group for your Network Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-target-group.html). | ||
|
|
||
| 2. Go to [Load balancers](https://console.aws.amazon.com/ec2/home#LoadBalancers) to create a network load balancer. Provide the following information: | ||
|
|
||
| - **Schema**: select `Internal` | ||
| - **Load balancer IP address type**: select `IPv4` | ||
| - **VPC**: select the VPC where your RDS is located | ||
| - **Availability Zones**: select the availability zones that overlap with your {{{ .essential }}} cluster | ||
| - **Security groups**: create a new security group with the following rules: | ||
| - An inbound rule that allows MySQL/Aurora: | ||
| - Type: `MySQL/Aurora` | ||
| - Source: `Anywhere-IPv4` | ||
|
|
||
| - An outbound rule that allows MySQL/Aurora: | ||
| - Type: `MySQL/Aurora` | ||
| - Destination: `Anywhere-IPv4` | ||
|
|
||
| - **Listeners and routing**: | ||
| - **Protocol and Port**: set the protocol to `TCP` and the port to your database port, for example `3306` for MySQL | ||
| - **Target group**: select the target group that you created in the previous step | ||
|
|
||
| For more information, see [Create a Network Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-network-load-balancer.html). | ||
|
|
||
| ### Step 2.2. Set up the AWS Endpoint Service | ||
|
|
||
| To set up the endpoint service in the same region as your RDS, take the following steps: | ||
|
|
||
| 1. Go to [Endpoint services](https://console.aws.amazon.com/vpcconsole/home#EndpointServices) to create an endpoint service. Provide the following information: | ||
|
|
||
| - **Load balancer type**: select `Network` | ||
| - **Available load balancers**: enter the load balancer you created in the previous step | ||
| - **Supported Regions**: leave it empty if you do not have cross-region requirements | ||
| - **Require acceptance for endpoint**: it is recommended to select `Acceptance required` | ||
| - **Supported IP address types**: select `IPv4` | ||
|
|
||
| 2. Go to the details page of the endpoint service, and then copy the endpoint service name, in the format of `com.amazonaws.vpce.<region>.vpce-svc-xxxxxxxxxxxxxxxxx`. You need to provide it to TiDB Cloud. | ||
|
|
||
| 3. On the details page of the endpoint service, click the **Allow principals** tab, and then add the AWS account ID that you obtained in [Prerequisites](#prerequisites) to the allowlist, for example, `arn:aws:iam::<account_id>:root`. | ||
|
|
||
| ## Step 3. Create an AWS Endpoint Service private link connection in TiDB Cloud | ||
|
|
||
| You can create a private link connection using the TiDB Cloud console or the TiDB Cloud CLI. | ||
|
|
||
| For more information, see [Create an AWS Endpoint Service private link connection](/tidb-cloud/serverless-private-link-connection.md#create-an-aws-endpoint-service-private-link-connection). |
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.