Private link connection #22192
Private link connection #22192
Conversation
ti-chi-bot
bot
added
missing-translation-status
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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
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>
shiyuhang0
force-pushed
the
private-link-connection
branch
from
726c985 to
ca176a2
Compare
hfxsd
added
translation/no-need
ti-chi-bot
bot
added
the
do-not-merge/work-in-progress
|
[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 |
shiyuhang0
force-pushed
the
private-link-connection
branch
from
6798c24 to
94b06af
Compare
shiyuhang0
force-pushed
the
private-link-connection
branch
from
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
shiyuhang0
force-pushed
the
private-link-connection
branch
from
7c91d4c to
4c5a5fa
Compare
Improved instructions and terminology in the AliCloud RDS and AWS Confluent private link connection guides. Clarified prerequisites, step-by-step procedures, and updated language for consistency and accuracy.
Improved clarity, consistency, and accuracy in the documentation for connecting TiDB Cloud to Alibaba Cloud RDS, AWS Confluent, and AWS RDS via private link connections. Updates include more precise terminology, step-by-step instructions, and enhanced formatting for prerequisites and procedures. Added links to relevant cloud consoles and guides, and standardized naming conventions for private link connections.
Standardized terminology for Alibaba Cloud (formerly AliCloud) and improved prerequisite instructions in both Alibaba Cloud and AWS Kafka connection guides. Clarified placeholder usage for 'unique_name' and updated references to endpoint services for consistency and accuracy.
shiyuhang0
force-pushed
the
private-link-connection
branch
from
7b2267c to
d097da9
Compare
Co-authored-by: xixirangrang <hfxsd@hotmail.com>
Adds beta status notes and clarifies documentation for Private Link Connections for Dataflow in TiDB Cloud. Improves instructions for AWS and Alibaba Cloud endpoint service setup, domain attachment, and management via console and CLI. Updates TOC to indicate beta status and enhances overall guidance for users.
Improved clarity and consistency in instructions for connecting to Confluent Cloud Dedicated clusters on AWS using private link connections. Updated phrasing for better readability, clarified steps for both console and CLI usage, and fixed internal documentation links.
|
|
||
| # Connect to AWS Self-Hosted Kafka via Private Link Connection | ||
|
|
||
| The document describes how to connect to a self-hosted Kafka cluster in AWS, using AWS Endpoint Service private link connection. |
There was a problem hiding this comment.
| The document describes how to connect to a self-hosted Kafka cluster in AWS, using AWS Endpoint Service private link connection. | |
| This document describes how to connect a {{{ .essential }}} cluster to a self-hosted Kafka cluster in AWS using AWS Endpoint Service [private link connection](/tidb-cloud/serverless-private-link-connection.md). |
| 1. The private link connection connects to your endpoint service with bootstrap port, it returns broker addresses with different ports. | ||
| 2. The private link connection connects to your endpoint service with broker addresses and ports. | ||
| 3. Endpoint service forwards requests to your load balancers. | ||
| 4. Load balancers forward requests to different Kafka brokers based on the port mapping. |
There was a problem hiding this comment.
| 1. The private link connection connects to your endpoint service with bootstrap port, it returns broker addresses with different ports. | |
| 2. The private link connection connects to your endpoint service with broker addresses and ports. | |
| 3. Endpoint service forwards requests to your load balancers. | |
| 4. Load balancers forward requests to different Kafka brokers based on the port mapping. | |
| 1. The private link connection connects to your AWS Endpoint Service using the bootstrap broker address, which returns the addresses and ports of all Kafka brokers. | |
| 2. TiDB Cloud uses the returned broker addresses and ports to establish connections through the private link connection. | |
| 3. The AWS Endpoint Service forwards requests to your load balancers. | |
| 4. Load balancers route requests to the corresponding Kafka brokers based on port mapping. |
|
|
||
| ## Prerequisites | ||
|
|
||
| - Ensure that you have the following permissions to set up a Kafka cluster in your own AWS account. |
There was a problem hiding this comment.
| - Ensure that you have the following permissions to set up a Kafka cluster in your own AWS account. | |
| - Ensure that you have the following permissions to set up a Kafka cluster in your AWS account: |
| - Manage subnets | ||
| - Connect to EC2 nodes to configure Kafka nodes | ||
|
|
||
| - Ensure that you have the following authorization to set up a load balancer and endpoint service in your own AWS account. |
There was a problem hiding this comment.
| - Ensure that you have the following authorization to set up a load balancer and endpoint service in your own AWS account. | |
| - Ensure that you have the following permissions to set up a load balancer and endpoint service in your AWS account: |
| - Manage load balancer | ||
| - Manage endpoint services | ||
|
|
||
| - {{{ .essential }}} information: confirm that your {{{ .essential }}} is active in AWS. Retrieve and save the following details for later use: |
There was a problem hiding this comment.
| - {{{ .essential }}} information: confirm that your {{{ .essential }}} is active in AWS. Retrieve and save the following details for later use: | |
| - Ensure that your {{{ .essential }}} is active in AWS. Retrieve and save the following details for later use: |
| 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. On the **Private Link Connection For Dataflow**, click **Create Private Link Connection**. | ||
| 3. You can find the AWS account ID and available zones information. |
There was a problem hiding this comment.
| 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. On the **Private Link Connection For Dataflow**, click **Create Private Link Connection**. | |
| 3. You can find the AWS account ID and available zones information. | |
| 1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the cluster overview page of your TiDB cluster, and then click **Settings** > **Networking** in the left navigation pane. | |
| 2. In the **Private Link Connection For Dataflow** section, click **Create Private Link Connection**. | |
| 3. In the displayed dialog, you can find the AWS account ID and available zones. |
| - Account ID | ||
| - Availability Zones (AZ) | ||
|
|
||
| To view the the AWS account ID and available zones, do the following: |
There was a problem hiding this comment.
| To view the the AWS account ID and available zones, do the following: | |
| To view the AWS account ID and available zones, do the following: |
| - {{{ .essential }}} information: confirm that your {{{ .essential }}} is active in AWS. Retrieve and save the following details for later use: | ||
|
|
||
| - Account ID | ||
| - Availability Zones (AZ) |
There was a problem hiding this comment.
| - Availability Zones (AZ) | |
| - Availability Zones (AZs) |
| - Manage EC2 nodes | ||
| - Manage VPC | ||
| - Manage subnets | ||
| - Connect to EC2 nodes to configure Kafka nodes |
There was a problem hiding this comment.
| - Manage EC2 nodes | |
| - Manage VPC | |
| - Manage subnets | |
| - Connect to EC2 nodes to configure Kafka nodes | |
| - Manage EC2 instances | |
| - Manage VPCs | |
| - Manage subnets | |
| - Connect to EC2 instances to configure Kafka nodes |
Improved wording, consistency, and clarity in instructions for creating, attaching, and detaching private link connections in TiDB Cloud. Updated references to AWS and Alibaba Cloud consoles, refined step descriptions, and standardized terminology for better user guidance.
|
@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. |
| - [Connect via Private Endpoint with Alibaba Cloud](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md) | ||
| - [Configure Firewall Rules for Public Endpoints](/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md) | ||
| - [TLS Connections to TiDB Cloud](/tidb-cloud/secure-connections-to-serverless-clusters.md) | ||
| - Private Link Connection  |
|
|
||
| > **Note:** | ||
| > | ||
| > The Private Link Connections for Dataflow feature is in beta. It might be changed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub. |
|
|
||
| - 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 accessible within the VPC, with an appropriately configured IP allowlist. |
4 participants
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?