Skip to content

Conversation

@shiyuhang0
Copy link
Member

First-time contributors' checklist

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Dec 16, 2025
@gemini-code-assist
Copy link

Summary of Changes

Hello @shiyuhang0, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a suite of new documentation focused on establishing secure and efficient Private Link connections for TiDB Cloud's dataflow services. These guides provide detailed, step-by-step instructions for connecting TiDB Cloud to various external data sources, including AWS RDS, Alibaba Cloud RDS, AWS Confluent Dedicated clusters, and self-hosted Kafka clusters on AWS, all leveraging cloud-native private link services. The aim is to facilitate private, direct, and secure data transmission, improving both security posture and network performance for users integrating TiDB Cloud with their existing cloud infrastructure.

Highlights

  • New Private Link Connection Documentation: Introduced a comprehensive set of documentation for establishing Private Link connections from TiDB Cloud to various external data sources.
  • Support for AWS RDS and Alibaba Cloud RDS: Added detailed guides for setting up secure Private Link connections to both AWS RDS and Alibaba Cloud RDS instances.
  • Integration with AWS Confluent and Self-Hosted Kafka: Provided new documentation for connecting TiDB Cloud to AWS Confluent Dedicated clusters and self-hosted Kafka clusters on AWS via Private Link.
  • Overview and Management of Private Link Connections: Included an overview document explaining the Private Link Connection for Dataflow feature, its types, domain attachment, and general management steps via Console and CLI.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds several new documentation pages related to setting up Private Link connections for TiDB Cloud Dataflow services. The new documents cover connections to Alibaba Cloud RDS, AWS Confluent, AWS RDS, and self-hosted Kafka on AWS, along with a general overview page. My review focuses on improving clarity, correcting grammatical errors and typos, and ensuring consistency with the repository's style guide. I've provided suggestions to improve sentence structure, use consistent terminology, and fix formatting for better readability.

@gemini-code-assist
Copy link

Warning

Gemini encountered an error creating the review. You can try again by commenting /gemini review.

shiyuhang0 and others added 3 commits December 17, 2025 10:40
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@shiyuhang0 shiyuhang0 force-pushed the private-link-connection branch from 726c985 to ca176a2 Compare December 17, 2025 03:01
@hfxsd hfxsd self-assigned this Dec 17, 2025
@hfxsd hfxsd added translation/no-need No need to translate this PR. area/tidb-cloud This PR relates to the area of TiDB Cloud. and removed missing-translation-status This PR does not have translation status info. labels Dec 17, 2025
@shiyuhang0 shiyuhang0 changed the title Private link connection [wip] Private link connection Dec 17, 2025
@ti-chi-bot ti-chi-bot bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 17, 2025
@ti-chi-bot
Copy link

ti-chi-bot bot commented Dec 17, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from hfxsd. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

github-actions bot pushed a commit to hfxsd/pingcap-docsite-preview that referenced this pull request Dec 17, 2025
@shiyuhang0 shiyuhang0 force-pushed the private-link-connection branch from 6798c24 to 94b06af Compare December 17, 2025 04:33
@shiyuhang0 shiyuhang0 force-pushed the private-link-connection branch from 94b06af to a5d2ad4 Compare December 17, 2025 04:35
shiyuhang0 and others added 4 commits December 29, 2025 13:28
Reorganizes the documentation for creating and managing AWS and Alibaba Cloud private link connections in TiDB Cloud. The update separates the creation steps for each cloud provider, clarifies prerequisites, and improves the step-by-step instructions for both the console and CLI. The process for attaching and detaching domains is now more clearly described, with tables and examples for supported domain types.
Refactored the Confluent Cloud Private Link connection guide to remove beta feature note, clarify network requirements, and replace step-by-step instructions with references to shared documentation. Updated instructions to indicate that accepting endpoint connection requests in AWS is not required for Confluent Cloud Dedicated clusters. Minor wording improvements and added a direct AWS console link in the general Private Link connection guide.

3. In the **Private Link Connection For Dataflow** area, click **Create Private Link Connection**.

4. Enter the required information in the **Create Private Link Connection** dialog:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
4. Enter the required information in the **Create Private Link Connection** dialog:
4. In the **Create Private Link Connection** dialog, enter the required information:


3. In the **Private Link Connection For Dataflow** area, click **Create Private Link Connection**.

4. Enter the required information in the **Create Private Link Connection** dialog:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
4. Enter the required information in the **Create Private Link Connection** dialog:
4. In the **Create Private Link Connection** dialog, enter the required information:

Comment on lines 177 to 179
```shell
ticloud serverless private-link-connection create -c <cluster-id> --display-name <display-name> --type AWS_ENDPOINT_SERVICE --aws.endpoint-service-name <endpoint-service-name>
```
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
```shell
ticloud serverless private-link-connection create -c <cluster-id> --display-name <display-name> --type AWS_ENDPOINT_SERVICE --aws.endpoint-service-name <endpoint-service-name>
```
To create a private link connection using the TiDB Cloud CLI:
1. Run the following command:
```shell
ticloud serverless private-link-connection create -c <cluster-id> --display-name <display-name> --type AWS_ENDPOINT_SERVICE --aws.endpoint-service-name <endpoint-service-name>
```

@shiyuhang0
Copy link
Member Author

@qiancai a new commit has been pushed to add the step of create dedicated cluster. PTAL again
bf32079

Comment on lines 62 to 64
Please create a Confluent Cloud Dedicated cluster under the network you set up in [Step 1](#step-1-set-up-a-confluent-cloud-network). For more information, see [Create a dedicated cluster in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/create-cluster.html#create-ak-clusters).

When creating the cluster, use existing Confluent Cloud network you set up in [Step 1](#step-1-set-up-a-confluent-cloud-network).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Please create a Confluent Cloud Dedicated cluster under the network you set up in [Step 1](#step-1-set-up-a-confluent-cloud-network). For more information, see [Create a dedicated cluster in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/create-cluster.html#create-ak-clusters).
When creating the cluster, use existing Confluent Cloud network you set up in [Step 1](#step-1-set-up-a-confluent-cloud-network).
Create a Confluent Cloud Dedicated cluster under the network you set up in [Step 1](#step-1-set-up-a-confluent-cloud-network). For more information, see [Create a dedicated cluster in Confluent Cloud](https://docs.confluent.io/cloud/current/clusters/create-cluster.html#create-ak-clusters).

@ti-chi-bot
Copy link

ti-chi-bot bot commented Dec 29, 2025

@shiyuhang0: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-verify 83d4ac4 link true /test pull-verify

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/tidb-cloud This PR relates to the area of TiDB Cloud. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants