-
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
base: release-8.5
Are you sure you want to change the base?
cloud: add private link connection docs #22192
Conversation
Summary of ChangesHello @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
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this 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.
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-aws.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md
Outdated
Show resolved
Hide resolved
|
Warning Gemini encountered an error creating the review. You can try again by commenting |
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
726c985 to
ca176a2
Compare
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
6798c24 to
94b06af
Compare
94b06af to
a5d2ad4
Compare
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Grace Cai <[email protected]>
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.
tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md
Outdated
Show resolved
Hide resolved
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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 4. Enter the required information in the **Create Private Link Connection** dialog: | |
| 4. In the **Create Private Link Connection** dialog, enter the required information: |
| ```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> | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ```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> | |
| ``` | |
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Grace Cai <[email protected]>
Co-authored-by: xixirangrang <[email protected]>
Co-authored-by: Grace Cai <[email protected]>
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
| 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). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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). |
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Grace Cai <[email protected]>
tidb-cloud/serverless-private-link-connection-to-aws-confluent.md
Outdated
Show resolved
Hide resolved
|
@shiyuhang0: The following test failed, say
Full PR test history. Your PR dashboard. DetailsInstructions 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. |
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?