update-doc-for -premium -changefeed #21964
Conversation
|
[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.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
ti-chi-bot
bot
added
missing-translation-status
Summary of ChangesHello @qqqdan, 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 significantly expands the documentation for TiDB Cloud's changefeed feature, specifically targeting Premium instances. It introduces new guides covering the core functionality of changefeeds, their integration with external systems like Apache Kafka and MySQL, and the secure setup of private endpoints. Additionally, the billing information has been updated to reflect the new Changefeed Capacity Units (CCUs) model for Premium, ensuring users have clear and distinct pricing and performance details. 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 introduces comprehensive documentation for the TiDB Cloud Premium changefeed feature, including a new overview, guides for sinking data to Apache Kafka and MySQL, and instructions for setting up private endpoints. The billing documentation is also updated to reflect costs for this new feature. My review focuses on improving clarity, fixing typos, and ensuring adherence to the repository's style guide, such as using sentence case for headings.
| - [Sink to TiDB Cloud](/tidb-cloud/changefeed-sink-to-tidb-cloud.md) | ||
| - [Sink to cloud storage](/tidb-cloud/changefeed-sink-to-cloud-storage.md) | ||
|
|
||
| ## Query Changefeed Capacity Units |
There was a problem hiding this comment.
|
|
||
| ## Scale a changefeed | ||
|
|
||
| You can change the TiCDC Changefeed Capacity Units (CCUs) of a changefeed by scaling up or down the changfeed. |
There was a problem hiding this comment.
There is a typo in changfeed. It should be changefeed.
| You can change the TiCDC Changefeed Capacity Units (CCUs) of a changefeed by scaling up or down the changfeed. | |
| You can change the TiCDC Changefeed Capacity Units (CCUs) of a changefeed by scaling up or down the changefeed. | |
| 3. Select a new specification. | ||
| 4. Click **Submit**. | ||
|
|
||
| It takes about 10 minutes to complete the scaling process (during which the changfeed works normally) and a few seconds to switch to the new specification (during which the changefeed will be paused and resumed automatically). |
There was a problem hiding this comment.
There are two typos in changfeed. They should be changefeed.
| It takes about 10 minutes to complete the scaling process (during which the changfeed works normally) and a few seconds to switch to the new specification (during which the changefeed will be paused and resumed automatically). | |
| It takes about 10 minutes to complete the scaling process (during which the changefeed works normally) and a few seconds to switch to the new specification (during which the changefeed will be paused and resumed automatically). | |
|
|
||
| ## Changefeed states | ||
|
|
||
| The state of a replication task represents the running state of the replication task. During the running process, replication tasks might fail with errors, or be manually paused or resumed. These behaviors can lead to changes of the replication task state. |
There was a problem hiding this comment.
This sentence is a bit repetitive. Consider rephrasing for better clarity and conciseness.
| The state of a replication task represents the running state of the replication task. During the running process, replication tasks might fail with errors, or be manually paused or resumed. These behaviors can lead to changes of the replication task state. | |
| The state of a replication task represents its running state. During operation, replication tasks might fail with errors, or be manually paused or resumed. These behaviors can lead to changes in the replication task state. | |
|
|
||
| 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. | ||
|
|
||
| TiDB Cloud currently supports Private Connect only for self-hosted Kafka. It does not support direct integration with MSK, Confluent Kafka, or other Kafka SaaS services. To connect to these Kafka SaaS services via Private Connect, you can deploy a [kafka-proxy](https://github.com/grepplabs/kafka-proxy) as an intermediary, effectively exposing the Kafka service as self-hosted Kafka. |
There was a problem hiding this comment.
There is a trailing space at the end of this line that should be removed.
| TiDB Cloud currently supports Private Connect only for self-hosted Kafka. It does not support direct integration with MSK, Confluent Kafka, or other Kafka SaaS services. To connect to these Kafka SaaS services via Private Connect, you can deploy a [kafka-proxy](https://github.com/grepplabs/kafka-proxy) as an intermediary, effectively exposing the Kafka service as self-hosted Kafka. | |
| TiDB Cloud currently supports Private Connect only for self-hosted Kafka. It does not support direct integration with MSK, Confluent Kafka, or other Kafka SaaS services. To connect to these Kafka SaaS services via Private Connect, you can deploy a [kafka-proxy](https://github.com/grepplabs/kafka-proxy) as an intermediary, effectively exposing the Kafka service as self-hosted Kafka. | |
| #### 2. Test EXTERNAL listener settings in your internal network | ||
| You can download the Kafka and OpenJDK in you Kafka client node. |
There was a problem hiding this comment.
There is a typo in "you". It should be "your".
| You can download the Kafka and OpenJDK in you Kafka client node. | |
| You can download the Kafka and OpenJDK in your Kafka client node. | |
| - Protocol: `TCP`; Port: `9094`; Forward to: `broker-target-group-2` | ||
| - Protocol: `TCP`; Port: `9095`; Forward to: `broker-target-group-3` | ||
| 3. Test the load balancer in the bastion node. This example only tests the Kafka bootstrap. Because the load balancer is listening on the Kafka EXTERNAL listener, the addresses of EXTERNAL advertised listeners can not be resolved in the bastion node. Note down the `kafka-lb` DNS name from the load balancer detail page, for example `kafka-lb-77405fa57191adcb.elb.us-west-2.amazonaws.com`. Execute the script in the bastion node. |
There was a problem hiding this comment.
The phrase "can not be resolved" should be "cannot be resolved".
| 3. Test the load balancer in the bastion node. This example only tests the Kafka bootstrap. Because the load balancer is listening on the Kafka EXTERNAL listener, the addresses of EXTERNAL advertised listeners can not be resolved in the bastion node. Note down the `kafka-lb` DNS name from the load balancer detail page, for example `kafka-lb-77405fa57191adcb.elb.us-west-2.amazonaws.com`. Execute the script in the bastion node. | |
| 3. Test the load balancer in the bastion node. This example only tests the Kafka bootstrap. Because the load balancer is listening on the Kafka EXTERNAL listener, the addresses of EXTERNAL advertised listeners cannot be resolved in the bastion node. Note down the `kafka-lb` DNS name from the load balancer detail page, for example `kafka-lb-77405fa57191adcb.elb.us-west-2.amazonaws.com`. Execute the script in the bastion node. | |
| <CustomContent plan="dedicated"> | ||
|
|
||
| TiDB Cloud measures the capacity of [changefeeds](/tidb-cloud/changefeed-overview.md) in TiCDC Replication Capacity Units (RCUs). When you [create a changefeed](/tidb-cloud/changefeed-overview.md#create-a-changefeed) for a cluster, you can select an appropriate specification. The higher the RCU, the better the replication performance. You will be charged for these TiCDC changefeed RCUs. | ||
| ## RCU cost for TiDB Cloud Dedicate |
There was a problem hiding this comment.
There is a typo in Dedicate. It should be Dedicated.
| ## RCU cost for TiDB Cloud Dedicate | |
| ## RCU cost for TiDB Cloud Dedicated | |
| TiDB Cloud measures the capacity of [changefeeds](/tidb-cloud/changefeed-overview.md) in TiCDC Replication Capacity Units (RCUs). When you [create a changefeed](/tidb-cloud/changefeed-overview.md#create-a-changefeed) for a cluster, you can select an appropriate specification. The higher the RCU, the better the replication performance. You will be charged for these TiCDC changefeed RCUs. | ||
| ## RCU cost for TiDB Cloud Dedicate | ||
|
|
||
| TiDB Cloud Dedicate measures the capacity of [changefeeds](/tidb-cloud/changefeed-overview.md) in TiCDC Replication Capacity Units (RCUs). When you [create a changefeed](/tidb-cloud/changefeed-overview.md#create-a-changefeed) for a cluster, you can select an appropriate specification. The higher the RCU, the better the replication performance. You will be charged for these TiCDC changefeed RCUs. |
There was a problem hiding this comment.
There is a typo in Dedicate. It should be Dedicated.
| TiDB Cloud Dedicate measures the capacity of [changefeeds](/tidb-cloud/changefeed-overview.md) in TiCDC Replication Capacity Units (RCUs). When you [create a changefeed](/tidb-cloud/changefeed-overview.md#create-a-changefeed) for a cluster, you can select an appropriate specification. The higher the RCU, the better the replication performance. You will be charged for these TiCDC changefeed RCUs. | |
| TiDB Cloud Dedicated measures the capacity of [changefeeds](/tidb-cloud/changefeed-overview.md) in TiCDC Replication Capacity Units (RCUs). When you [create a changefeed](/tidb-cloud/changefeed-overview.md#create-a-changefeed) for a cluster, you can select an appropriate specification. The higher the RCU, the better the replication performance. You will be charged for these TiCDC changefeed RCUs. | |
| <CustomContent plan="premium"> | ||
| ## CCU cost for TiDB Cloud Premium | ||
|
|
||
| TiDB Cloud Premium measures the capacity of [changefeeds](/tidb-cloud/changefeed-overview-premium.md) in TiCDC Changefeed Capacity Units (CCUs). When you [create a changefeed](/tidb-cloud/changefeed-overview-premium.md#create-a-changefeed) for a instance, you can select an appropriate specification. The higher the CCU, the better the replication performance. You will be charged for these TiCDC CCUs. |
There was a problem hiding this comment.
The article "a" is incorrect before "instance". It should be "an".
| TiDB Cloud Premium measures the capacity of [changefeeds](/tidb-cloud/changefeed-overview-premium.md) in TiCDC Changefeed Capacity Units (CCUs). When you [create a changefeed](/tidb-cloud/changefeed-overview-premium.md#create-a-changefeed) for a instance, you can select an appropriate specification. The higher the CCU, the better the replication performance. You will be charged for these TiCDC CCUs. | |
| TiDB Cloud Premium measures the capacity of [changefeeds](/tidb-cloud/changefeed-overview-premium.md) in TiCDC Changefeed Capacity Units (CCUs). When you [create a changefeed](/tidb-cloud/changefeed-overview-premium.md#create-a-changefeed) for an instance, you can select an appropriate specification. The higher the CCU, the better the replication performance. You will be charged for these TiCDC CCUs. | |
|
|
||
| # Set Up Private Endpoint for Changefeeds | ||
|
|
||
| This document describes how to create a private endpoint for changefeeds in your TiDB Cloud Premium instance, enabling you to securely stream data to self-hosted Kafka or MySQL through private connectivity. |
There was a problem hiding this comment.
| This document describes how to create a private endpoint for changefeeds in your TiDB Cloud Premium instance, enabling you to securely stream data to self-hosted Kafka or MySQL through private connectivity. | |
| This document describes how to create a private endpoint for changefeeds in your TiDB Cloud Premium instances, enabling you to securely stream data to self-hosted Kafka or MySQL through private connectivity. |
|
|
||
| ### Network | ||
|
|
||
| Private endpoints leverage **Private Link** technology from cloud providers, enabling resources in your VPC to connect to services in other VPCs through private IP addresses, as if those services were hosted directly within your VPC. |
There was a problem hiding this comment.
| Private endpoints leverage **Private Link** technology from cloud providers, enabling resources in your VPC to connect to services in other VPCs through private IP addresses, as if those services were hosted directly within your VPC. | |
| Private endpoints leverage the **Private Link** technology from cloud providers, enabling resources in your VPC to connect to services in other VPCs through private IP addresses, as if those services were hosted directly within your VPC. |
| If the Private Endpoint Service is not available for your downstream service, follow [Step 2. Expose the Kafka instance as Private Link Service](/tidb-cloud/setup-aws-self-hosted-kafka-private-link-service-premium.md#step-2-expose-the-kafka-instance-as-private-link-service) to set up the load balancer and the Private Link Service. | ||
|
|
||
| </div> | ||
| <div label="Alibaba Cloud"> |
There was a problem hiding this comment.
| <div label="Alibaba Cloud"> | |
| <CustomContent language="en,zh"> | |
| <div label="Alibaba Cloud"> |
| - The name of the Private Endpoint Service for your downstream service | ||
| - The availability zones (AZs) where your downstream service is deployed | ||
|
|
||
| </div> |
There was a problem hiding this comment.
| </div> | |
| </div> | |
| </CustomContent> |
|
|
||
| 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/). | ||
|
|
||
| 2. On the **instances** page, click the name of your target instance to go to its overview page. |
There was a problem hiding this comment.
| 2. On the **instances** page, click the name of your target instance to go to its overview page. | |
| 2. On the [**TiDB Instances**](https://tidbcloud.com/tidbs) page, click the name of your target instance to go to its overview page. |
| <div label="AWS"> | ||
|
|
||
| 1. On the **Networking** page, click **Create Private Endpoint** in the **AWS Private Endpoint for Changefeed** section. | ||
| 2. In the **Create Private Endpoint for Changefeed** dialog, enter a name for the private endpoint. |
There was a problem hiding this comment.
The steps 3~8 in this doc do not match the UI preview.
| 8. Click **Create** to validate the configurations and create the private endpoint. | ||
|
|
||
| </div> | ||
| <div label="Alibaba Cloud"> |
There was a problem hiding this comment.
| <div label="Alibaba Cloud"> | |
| <CustomContent language="en,zh"> | |
| <div label="Alibaba Cloud"> |
|
|
||
| 8. Click **Create** to validate the configurations and create the private endpoint. | ||
|
|
||
| </div> |
There was a problem hiding this comment.
| </div> | |
| </div> | |
| </CustomContent> |
qiancai
added
translation/no-need
|
@qqqdan: The following test failed, say
Full PR test history. Your PR dashboard. 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. |
2 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?