-
Notifications
You must be signed in to change notification settings - Fork 705
Add cdc improved private link document. #21929
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
Changes from 1 commit
c6cf863
cb217fc
e7df3ce
c8373cb
6176f8a
95129f8
000fc79
0c941dd
d4cddd1
d95c973
00816bc
cafc654
b33b50e
9ac73e9
0c9d84e
30b224c
bed99d1
c37d346
ffa3906
6fedc1e
5e31121
723af62
e9cb1b7
45dae5b
408472a
7211c4b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -54,20 +54,17 @@ TiDB Cloud currently supports Private Connect only for self-hosted Kafka. It doe | |||||
|
|
||||||
| - If your Apache Kafka service is hosted in AWS, follow [Set Up Self-Hosted Kafka Private Link Service in AWS](/tidb-cloud/setup-aws-self-hosted-kafka-private-link-service.md) to ensure that the network connection is properly configured. After setup, provide the following information in the TiDB Cloud console to create the changefeed: | ||||||
|
|
||||||
| - The ID in Kafka Advertised Listener Pattern | ||||||
| - The Endpoint Service Name | ||||||
| - The Sink Private Link, follow [Setup Private Endpoint for Changefeed](/tidb-cloud/set-up-sink-private-endpoint.md) to create one. | ||||||
| - The Bootstrap Ports | ||||||
|
|
||||||
| - If your Apache Kafka service is hosted in Google Cloud, follow [Set Up Self-Hosted Kafka Private Service Connect in Google Cloud](/tidb-cloud/setup-self-hosted-kafka-private-service-connect.md) to ensure that the network connection is properly configured. After setup, provide the following information in the TiDB Cloud console to create the changefeed: | ||||||
qiancai marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
| - The ID in Kafka Advertised Listener Pattern | ||||||
| - The Service Attachment | ||||||
| - The Sink Private Link, follow [Setup Private Endpoint for Changefeed](/tidb-cloud/set-up-sink-private-endpoint.md) to create one. | ||||||
| - The Bootstrap Ports | ||||||
|
|
||||||
| - If your Apache Kafka service is hosted in Azure, follow [Set Up Self-Hosted Kafka Private Link Service in Azure](/tidb-cloud/setup-azure-self-hosted-kafka-private-link-service.md) to ensure that the network connection is properly configured. After setup, provide the following information in the TiDB Cloud console to create the changefeed: | ||||||
qiancai marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
| - The ID in Kafka Advertised Listener Pattern | ||||||
| - The Alias of Private Link Service | ||||||
| - The Sink Private Link, follow [Setup Private Endpoint for Changefeed](/tidb-cloud/set-up-sink-private-endpoint.md) to create one. | ||||||
| - The Bootstrap Ports | ||||||
|
|
||||||
qiancai marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| </div> | ||||||
|
|
@@ -139,63 +136,55 @@ The steps vary depending on the connectivity method you select. | |||||
| <div label="Private Link (AWS)"> | ||||||
|
|
||||||
| 1. In **Connectivity Method**, select **Private Link**. | ||||||
| 2. Authorize the [AWS Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-accounts) of TiDB Cloud to create an endpoint for your endpoint service. The AWS Principal is provided in the tip on the web page. | ||||||
| 3. Make sure you select the same **Number of AZs** and **AZ IDs of Kafka Deployment**, and fill the same unique ID in **Kafka Advertised Listener Pattern** when you [Set Up Self-Hosted Kafka Private Link Service in AWS](/tidb-cloud/setup-aws-self-hosted-kafka-private-link-service.md) in the **Network** section. | ||||||
| 4. Fill in the **Endpoint Service Name** which is configured in [Set Up Self-Hosted Kafka Private Link Service in AWS](/tidb-cloud/setup-aws-self-hosted-kafka-private-link-service.md). | ||||||
| 5. Fill in the **Bootstrap Ports**. It is recommended that you set at least one port for one AZ. You can use commas `,` to separate multiple ports. | ||||||
| 6. Select an **Authentication** option according to your Kafka authentication configuration. | ||||||
| 2. Select the **Sink Private Endpoint** which is prepared in the [Network](#network) section. Make sure the Sink Private Endpoint's AZs match the same AZ of the Kafka Deployment. | ||||||
|
||||||
| 2. Select the **Sink Private Endpoint** which is prepared in the [Network](#network) section. Make sure the Sink Private Endpoint's AZs match the same AZ of the Kafka Deployment. | |
| 2. Select the **Sink Private Endpoint** that you prepared in the [Network](#network) section. Make sure the Sink Private Endpoint's AZs match the AZs of your Kafka deployment. |
Style Guide References
Footnotes
-
Repository Style Guide, lines 22, 43-45: Write in second person ("you") and avoid passive voice. ↩
Outdated
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.
To follow the style guide's preference for active voice, it's better to rephrase 'which is prepared'.1
| 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. ↩
Outdated
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.
To follow the style guide's preference for active voice, it's better to rephrase 'which is prepared'.1
| 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. ↩
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -30,6 +30,9 @@ Before creating a changefeed, you need to complete the following prerequisites: | |||||
|
|
||||||
| Make sure that your TiDB Cluster can connect to the MySQL service. | ||||||
|
|
||||||
| <SimpleTab> | ||||||
| <div label="VPC Peering"> | ||||||
|
|
||||||
| If your MySQL service is in an AWS VPC that has no public internet access, take the following steps: | ||||||
|
|
||||||
| 1. [Set up a VPC peering connection](/tidb-cloud/set-up-vpc-peering-connections.md) between the VPC of the MySQL service and your TiDB cluster. | ||||||
|
|
@@ -49,6 +52,18 @@ If your MySQL service is in a Google Cloud VPC that has no public internet acces | |||||
| 3. Modify the ingress firewall rules of the VPC where MySQL is located. | ||||||
|
|
||||||
| You must add [the CIDR of the region where your TiDB Cloud cluster is located](/tidb-cloud/set-up-vpc-peering-connections.md#prerequisite-set-a-cidr-for-a-region) to the ingress firewall rules. Doing so allows the traffic to flow from your TiDB Cluster to the MySQL endpoint. | ||||||
qiancai marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| </div> | ||||||
|
|
||||||
| <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: | ||||||
|
||||||
| - 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. ↩
ginkgoch marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
ginkgoch marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Outdated
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.
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.
| 4. Fill in the MySQL endpoints, user name, and password in **MySQL Connection**. | |
| 4. Fill in the user name and password in **MySQL Connection**. |
Uh oh!
There was an error while loading. Please reload this page.