Add cdc improved private link document. #21929

ginkgoch · 2025-10-17T05:56:57Z

First-time contributors' checklist

I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

What is changed, added or deleted? (Required)

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

Add improved private link for changefeed document
Add changefeed private link setup guide for MySQL
Modify current changefeed private link setup guide for Kafka

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)?

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 · 2025-10-17T05:57:07Z

Hi @ginkgoch. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

gemini-code-assist · 2025-10-17T05:57:13Z

Summary of Changes

Hello @ginkgoch, I'm Gemini Code Assist¹! 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 significantly enhances and clarifies the documentation for configuring private network connectivity for TiDB Cloud changefeeds. It introduces a unified guide for setting up private endpoints, which is then referenced and integrated into the existing documentation for sinking data to both self-hosted Apache Kafka and MySQL. This change aims to simplify the user experience by providing a consistent and comprehensive approach to private link configurations across different cloud providers and downstream services.

Highlights

New Private Endpoint Setup Guide: A dedicated document has been added to guide users through setting up private endpoints for changefeeds, centralizing previously scattered information.
Streamlined Kafka Private Link Configuration: The process for configuring changefeeds to Apache Kafka via private links has been simplified, now referencing the new private endpoint setup guide.
Enhanced MySQL Changefeed Connectivity: New documentation introduces the ability to connect MySQL changefeeds using private endpoints, offering a more secure and private data sinking option.

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.

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. ↩

gemini-code-assist

Code Review

This pull request introduces a new, centralized document for setting up private endpoints for changefeeds, which simplifies the documentation for Kafka and MySQL sinks. The changes are a positive step towards better organization. My review focuses on improving clarity, consistency, and adherence to the style guide. I've provided suggestions for using sentence case in titles, employing active voice, ensuring consistent terminology, and correcting minor typos and formatting issues to enhance the overall quality of the documentation.

gemini-code-assist · 2025-10-17T05:59:49Z

tidb-cloud/changefeed-sink-to-mysql.md

+<div label="Private Endpoint">
+Private Connect leverages **Private Link** or **Private Service Connect** technologies from cloud providers to enable resources in your VPC to connect to services in other VPCs using private IP addresses, as if those services were hosted directly within your VPC.
+
+- Ensure your MySQL service is connective though private endpoint. Provide the following information in the TiDB Cloud console to create the changefeed:


There's a typo here. 'connective though' should be 'connectable through'. Also, the sentence can be rephrased to be more direct and use active voice, as recommended by the style guide.¹

Suggested change

- Ensure your MySQL service is connective though private endpoint. Provide the following information in the TiDB Cloud console to create the changefeed:

- To connect through a private endpoint, provide the following information in the TiDB Cloud console to create the changefeed:

Style Guide References

Footnotes

Repository Style Guide, lines 22, 43-45: Write in second person ("you") and avoid passive voice. ↩

gemini-code-assist · 2025-10-17T05:59:49Z

tidb-cloud/changefeed-sink-to-mysql.md

+    * If using **VPC Peering** or **Public IP**, fill in your MySQL endpoint.
+    * If using **Private Endpoint**, select the **Sink Private Endpoint** which is prepared in the [Network](#network) section.
+
+4. Fill in the MySQL endpoints, user name, and password in **MySQL Connection**.


Since the MySQL endpoint is already provided in step 3 for VPC Peering/Public IP, and a Sink Private Endpoint is used for the other option, asking for 'MySQL endpoints' again here is redundant and confusing. It's better to only ask for the credentials.

Suggested change

4. Fill in the MySQL endpoints, user name, and password in **MySQL Connection**.

4. Fill in the user name and password in **MySQL Connection**.

gemini-code-assist · 2025-10-17T05:59:50Z

tidb-cloud/set-up-sink-private-endpoint.md

+title: Setup Private Endpoint for Changefeed
+summary: Learn how to setup a private endpoint for Changefeed.


According to the style guide, titles should use sentence case.¹ Also, 'setup' as a verb should be two words ('set up'), and 'Changefeed' should be lowercase for consistency with other documents.²

Suggested change

title: Setup Private Endpoint for Changefeed

summary: Learn how to setup a private endpoint for Changefeed.

title: Set up a private endpoint for changefeed

summary: Learn how to set up a private endpoint for changefeed.

Style Guide References

Footnotes

Repository Style Guide, line 32: Use sentence case for headings (e.g., ## Configure the cluster). ↩

Repository Style Guide, line 25: Use consistent terminology. ↩

gemini-code-assist · 2025-10-17T05:59:50Z

tidb-cloud/set-up-sink-private-endpoint.md

+summary: Learn how to setup a private endpoint for Changefeed.
+---
+
+# Setup Private Endpoint for Changefeed


According to the style guide, headings should use sentence case.¹ Also, 'Setup' as a verb should be two words ('set up'), and 'Changefeed' should be lowercase for consistency.²

Suggested change

# Setup Private Endpoint for Changefeed

# Set up a private endpoint for changefeed

Style Guide References

Footnotes

Repository Style Guide, line 32: Use sentence case for headings (e.g., ## Configure the cluster). ↩

Repository Style Guide, line 25: Use consistent terminology. ↩

gemini-code-assist · 2025-10-17T05:59:50Z

tidb-cloud/changefeed-sink-to-apache-kafka.md

-3. Fill in the **Service Attachment** that you have configured in [Setup Self Hosted Kafka Private Service Connect in Google Cloud](/tidb-cloud/setup-self-hosted-kafka-private-service-connect.md)
-4. Fill in the **Bootstrap Ports**. It is recommended that you provide more than one port. You can use commas `,` to separate multiple ports. 
-5. Select an **Authentication** option according to your Kafka authentication configuration.
+2. Select the **Sink Private Endpoint** which is prepared in the [Network](#network) section.


To follow the style guide's preference for active voice, it's better to rephrase 'which is prepared'.¹

Suggested change

2. Select the **Sink Private Endpoint** which is prepared in the [Network](#network) section.

2. Select the **Sink Private Endpoint** that you prepared in the [Network](#network) section.

Style Guide References

Footnotes

Repository Style Guide, lines 22, 43-45: Write in second person ("you") and avoid passive voice. ↩

gemini-code-assist · 2025-10-17T05:59:51Z

tidb-cloud/set-up-sink-private-endpoint.md

+</div>
+</SimpleTab>
+
+## Step 1. Open the Private Endpoint for Changefeed


This heading is a bit ambiguous. A clearer heading that describes the action would be better. Also, headings should be in sentence case per the style guide.¹

Suggested change

## Step 1. Open the Private Endpoint for Changefeed

## Step 1. Open the private endpoint creation page

Style Guide References

Footnotes

Repository Style Guide, line 32: Use sentence case for headings (e.g., ## Configure the cluster). ↩

gemini-code-assist · 2025-10-17T05:59:51Z

tidb-cloud/set-up-sink-private-endpoint.md

+2. Navigate to the cluster overview page of the TiDB cluster, then click **Settings** > **Networking**.
+3. Click **Create Private Endpoint** in the **Private Endpoint for Changefeed** section.
+
+## Step 2. Configure the Private Endpoint for Changefeed


According to the style guide, headings should use sentence case.¹

Suggested change

## Step 2. Configure the Private Endpoint for Changefeed

## Step 2. Configure the private endpoint for changefeed

Style Guide References

Footnotes

Repository Style Guide, line 32: Use sentence case for headings (e.g., ## Configure the cluster). ↩

gemini-code-assist · 2025-10-17T05:59:51Z

tidb-cloud/set-up-sink-private-endpoint.md

+
+3. Enter the **Endpoint Service Name** that you configured in [Set Up Self-Hosted Kafka Private Link Service in AWS](https://docs.pingcap.com/tidbcloud/setup-aws-self-hosted-kafka-private-link-service/).
+
+4. Select the **Number of Availability Zones**. Make sure you select the same **Number of AZs** and **AZ IDs** as your Kafka deployment.


The style guide recommends direct instructions.¹ Rephrasing 'Make sure you select' to a more direct command would be better.

Suggested change

4. Select the **Number of Availability Zones**. Make sure you select the same **Number of AZs** and **AZ IDs** as your Kafka deployment.

4. Select the **Number of Availability Zones**. Ensure the **Number of AZs** and **AZ IDs** are the same as your Kafka deployment.

Style Guide References

Footnotes

Repository Style Guide, line 22: Write in second person ("you") when addressing users. ↩

gemini-code-assist · 2025-10-17T05:59:51Z

tidb-cloud/set-up-sink-private-endpoint.md

+
+2. Enter a **Name** for this **Private Endpoint**.
+
+3. Enter the **Service Attachment** that you configured in [Setup Self Hosted Kafka Private Service Connect in Google Cloud](https://docs.pingcap.com/tidbcloud/setup-self-hosted-kafka-private-service-connect/).


For consistency, 'Setup' should be 'Set up' to match the verb form used elsewhere. While this is part of a link to another document, it's good practice to maintain consistency across the documentation set.

Suggested change

3. Enter the **Service Attachment** that you configured in [Setup Self Hosted Kafka Private Service Connect in Google Cloud](https://docs.pingcap.com/tidbcloud/setup-self-hosted-kafka-private-service-connect/).

3. Enter the **Service Attachment** that you configured in [Set up Self Hosted Kafka Private Service Connect in Google Cloud](https://docs.pingcap.com/tidbcloud/setup-self-hosted-kafka-private-service-connect/).

gemini-code-assist · 2025-10-17T05:59:52Z

tidb-cloud/set-up-sink-private-endpoint.md

+
+
+
+


These trailing blank lines are unnecessary and can be removed to improve file cleanliness.

tidb-cloud/changefeed-sink-to-mysql.md

WangLe1321 · 2025-10-17T06:51:28Z

tidb-cloud/set-up-sink-private-endpoint.md

+
+## Restrictions
+
+- Only Organization Owner and Project Owner roles can create private endpoints for changefeeds.


Now the project dev role also has the permission.

Co-authored-by: WangLe1321 <[email protected]>

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

ti-chi-bot · 2025-10-17T07:50:03Z

@WangLe1321: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

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.

tidb-cloud/set-up-sink-private-endpoint.md

pingcap/docs@ffa3906

tidb-cloud/set-up-sink-private-endpoint.md

Co-authored-by: xixirangrang <[email protected]>

tidb-cloud/set-up-sink-private-endpoint.md

tidb-cloud/changefeed-sink-to-mysql.md

tidb-cloud/set-up-sink-private-endpoint.md

Co-authored-by: xixirangrang <[email protected]>

tidb-cloud/set-up-sink-private-endpoint.md

ti-chi-bot · 2025-10-22T01:11:31Z

[LGTM Timeline notifier]

Timeline:

2025-10-21 06:02:57.156328877 +0000 UTC m=+765283.233581447: ☑️ agreed by hfxsd.
2025-10-22 01:11:29.602752688 +0000 UTC m=+834195.680005248: ☑️ agreed by qiancai.

qiancai · 2025-10-22T01:11:47Z

/approve

ti-chi-bot · 2025-10-22T01:11:55Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [qiancai]

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

…m/ginkgoch/pingcap-docs into pr/21929

qiancai · 2025-10-22T01:45:41Z

/retest

DM-11841: Add cdc improved private link document.

c6cf863

ti-chi-bot bot added the missing-translation-status This PR does not have translation status info. label Oct 17, 2025

ti-chi-bot bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Oct 17, 2025

gemini-code-assist bot reviewed Oct 17, 2025

View reviewed changes

ginkgoch added 2 commits October 17, 2025 14:04

DM-11841: Add sink endpoint to TOC.

cb217fc

DM-11841: Document polish.

e7df3ce

WangLe1321 reviewed Oct 17, 2025

View reviewed changes

ginkgoch and others added 6 commits October 17, 2025 15:31

Update tidb-cloud/changefeed-sink-to-mysql.md

c8373cb

Co-authored-by: WangLe1321 <[email protected]>

Update tidb-cloud/changefeed-sink-to-mysql.md

6176f8a

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Update tidb-cloud/changefeed-sink-to-mysql.md

95129f8

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Update tidb-cloud/set-up-sink-private-endpoint.md

000fc79

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Update tidb-cloud/set-up-sink-private-endpoint.md

0c941dd

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

DM-1184: Correct a role restriction.

d4cddd1

WangLe1321 approved these changes Oct 17, 2025

View reviewed changes

qiancai self-assigned this Oct 17, 2025

ginkgoch changed the title ~~DM-11841: Add cdc improved private link document.~~ Add cdc improved private link document. Oct 17, 2025

Add more info for domain.

d95c973

qiancai reviewed Oct 20, 2025

View reviewed changes

revise tidb-cloud/set-up-sink-private-endpoint.md

00816bc

move the "Create Private Endpoint" line to step 2

ffa3906

qiancai force-pushed the dm-11841-cdc-private-link-improve branch from 91a43ae to ffa3906 Compare October 21, 2025 03:13

github-actions bot pushed a commit to qiancai/pingcap-docsite-preview that referenced this pull request Oct 21, 2025

Preview PR pingcap/docs#21929 and this preview is triggered from commit

579cfe8

pingcap/docs@ffa3906

hfxsd reviewed Oct 21, 2025

View reviewed changes

tidb-cloud/set-up-sink-private-endpoint.md Outdated Show resolved Hide resolved

tidb-cloud/set-up-sink-private-endpoint.md Outdated Show resolved Hide resolved

tidb-cloud/set-up-sink-private-endpoint.md Show resolved Hide resolved

Apply suggestions from code review

6fedc1e

Co-authored-by: xixirangrang <[email protected]>

qiancai reviewed Oct 21, 2025

View reviewed changes

tidb-cloud/set-up-sink-private-endpoint.md Show resolved Hide resolved

add an empty line

5e31121

hfxsd reviewed Oct 21, 2025

View reviewed changes

hfxsd approved these changes Oct 21, 2025

View reviewed changes

ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Oct 21, 2025

qiancai reviewed Oct 21, 2025

View reviewed changes

tidb-cloud/set-up-sink-private-endpoint.md Outdated Show resolved Hide resolved

qiancai reviewed Oct 21, 2025

View reviewed changes

tidb-cloud/set-up-sink-private-endpoint.md Outdated Show resolved Hide resolved

qiancai and others added 2 commits October 21, 2025 14:41

Apply suggestions from code review

723af62

Apply suggestions from code review

e9cb1b7

Co-authored-by: xixirangrang <[email protected]>

qiancai reviewed Oct 21, 2025

View reviewed changes

tidb-cloud/set-up-sink-private-endpoint.md Outdated Show resolved Hide resolved

Update tidb-cloud/set-up-sink-private-endpoint.md

45dae5b

qiancai approved these changes Oct 22, 2025

View reviewed changes

ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Oct 22, 2025

ti-chi-bot bot added the approved label Oct 22, 2025

qiancai added 2 commits October 22, 2025 09:13

Merge branch 'release-8.5' into pr/21929

408472a

Merge branch 'dm-11841-cdc-private-link-improve' of https://github.co…

7211c4b

…m/ginkgoch/pingcap-docs into pr/21929

ti-chi-bot bot merged commit 4c1d67f into pingcap:release-8.5 Oct 22, 2025
8 of 10 checks passed

	- Ensure your MySQL service is connective though private endpoint. Provide the following information in the TiDB Cloud console to create the changefeed:
	- To connect through a private endpoint, provide the following information in the TiDB Cloud console to create the changefeed:

	4. Fill in the MySQL endpoints, user name, and password in MySQL Connection.
	4. Fill in the user name and password in MySQL Connection.

		title: Setup Private Endpoint for Changefeed
		summary: Learn how to setup a private endpoint for Changefeed.

	# Setup Private Endpoint for Changefeed
	# Set up a private endpoint for changefeed

	2. Select the Sink Private Endpoint which is prepared in the [Network](#network) section.
	2. Select the Sink Private Endpoint that you prepared in the [Network](#network) section.

	## Step 1. Open the Private Endpoint for Changefeed
	## Step 1. Open the private endpoint creation page

	## Step 2. Configure the Private Endpoint for Changefeed
	## Step 2. Configure the private endpoint for changefeed


		3. Enter the Endpoint Service Name that you configured in [Set Up Self-Hosted Kafka Private Link Service in AWS](https://docs.pingcap.com/tidbcloud/setup-aws-self-hosted-kafka-private-link-service/).

		4. Select the Number of Availability Zones. Make sure you select the same Number of AZs and AZ IDs as your Kafka deployment.


		2. Enter a Name for this Private Endpoint.

		3. Enter the Service Attachment that you configured in [Setup Self Hosted Kafka Private Service Connect in Google Cloud](https://docs.pingcap.com/tidbcloud/setup-self-hosted-kafka-private-service-connect/).


		## Restrictions

		- Only Organization Owner and Project Owner roles can create private endpoints for changefeeds.

Add cdc improved private link document. #21929

Add cdc improved private link document. #21929

Conversation

ginkgoch commented Oct 17, 2025

First-time contributors' checklist

What is changed, added or deleted? (Required)

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

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

Do your changes match any of the following descriptions?

Uh oh!

ti-chi-bot bot commented Oct 17, 2025

Uh oh!

gemini-code-assist bot commented Oct 17, 2025

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Oct 17, 2025

Choose a reason for hiding this comment

Style Guide References

Footnotes

Uh oh!

gemini-code-assist bot Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Oct 17, 2025

Choose a reason for hiding this comment

Style Guide References

Footnotes

Uh oh!

gemini-code-assist bot Oct 17, 2025

Choose a reason for hiding this comment

Style Guide References

Footnotes

Uh oh!

gemini-code-assist bot Oct 17, 2025

Choose a reason for hiding this comment

Style Guide References

Footnotes

Uh oh!

gemini-code-assist bot Oct 17, 2025

Choose a reason for hiding this comment

Style Guide References

Footnotes

Uh oh!

gemini-code-assist bot Oct 17, 2025

Choose a reason for hiding this comment

Style Guide References

Footnotes

Uh oh!

gemini-code-assist bot Oct 17, 2025

Choose a reason for hiding this comment

Style Guide References

Footnotes

Uh oh!

gemini-code-assist bot Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

WangLe1321 Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

ti-chi-bot bot commented Oct 17, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!