cloud: update the network steps according to the latest UI - #23420
cloud: update the network steps according to the latest UI#23420qiancai wants to merge 1 commit into
Conversation
ti-chi-bot
Bot
added
missing-translation-status
|
[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 |
📝 WalkthroughWalkthroughThe documentation updates add IP access-list procedures, replace legacy Dataflow private-link instructions with external-services private endpoint workflows, document endpoint modes and lifecycle actions, and simplify VPC peering terminology. ChangesIP access-list documentation
Private endpoint workflow documentation
VPC peering terminology
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 067fd9ba-c219-4e32-a609-b67469ef8dbf
📒 Files selected for processing (11)
tidb-cloud/configure-ip-access-list.mdtidb-cloud/premium/set-up-sink-private-endpoint-premium.mdtidb-cloud/serverless-private-link-connection-to-alicloud-rds.mdtidb-cloud/serverless-private-link-connection-to-amazon-msk.mdtidb-cloud/serverless-private-link-connection-to-aws-confluent.mdtidb-cloud/serverless-private-link-connection-to-aws-rds.mdtidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-alicloud.mdtidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-aws.mdtidb-cloud/serverless-private-link-connection.mdtidb-cloud/set-up-sink-private-endpoint.mdtidb-cloud/set-up-vpc-peering-connections.md
| 4. In the **Add IP Address** dialog, add IP addresses with an optional description. For each TiDB Cloud Dedicated cluster, you can add up to 100 IP addresses. | ||
|
|
||
| - To add a custom IP address, click the **+** icon, enter the IP address in CIDR notation (for example, `192.168.1.1/32`), and add a description. | ||
| - To add the current IP address of your computer, click **Add Current IP**. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Identify the detected address as public.
The cluster receives the source address after network translation. “IP address of your computer” can imply a private local address. A private address will not permit a public connection.
| - To add the current IP address of your computer, click **Add Current IP**. | |
| - To add your computer's current public IP address, click **Add Current IP**. |
As per path instructions: **/*.md requires a GitHub committable suggestion for an actionable issue when the fix is contiguous.
Source: Path instructions
|
|
||
| - To add a custom IP address, click the **+** icon, enter the IP address in CIDR notation (for example, `192.168.1.1/32`), and add a description. | ||
| - To add the current IP address of your computer, click **Add Current IP**. | ||
| - To allow any IP address to access your cluster, click **Allow access from anywhere**. This adds the `0.0.0.0/0` CIDR entry. This is highly risky and NOT recommended for production environments. |
There was a problem hiding this comment.
🔒 Security & Privacy | 🟡 Minor | ⚡ Quick win
Limit the access description to IPv4.
0.0.0.0/0 matches every IPv4 address. It does not match IPv6 addresses. The current text overstates the access granted by Allow access from anywhere.
| - To allow any IP address to access your cluster, click **Allow access from anywhere**. This adds the `0.0.0.0/0` CIDR entry. This is highly risky and NOT recommended for production environments. | |
| - To allow any IPv4 address to access your cluster, click **Allow access from anywhere**. This adds the `0.0.0.0/0` CIDR entry. This is highly risky and NOT recommended for production environments. |
As per path instructions: **/*.md requires a GitHub committable suggestion for an actionable issue when the fix is contiguous.
🧰 Tools
🪛 LanguageTool
[style] ~30-~30: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...mputer, click Add Current IP. - To allow any IP address to access your clu...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Source: Path instructions
| - Has availability zones that overlap with your {{{ .essential }}} instance. | ||
|
|
||
| You can get the account ID and available zones information at the bottom of the **Create Private Link Connection** dialog, or by running the following command: | ||
| You can get the account ID and available zones information at the bottom of the **Create Private Endpoint for External Services** dialog, or by running the following command: |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use the established term availability zones.
Line 132 introduces available zones, while this file already uses availability zones for the same concept.
| You can get the account ID and available zones information at the bottom of the **Create Private Endpoint for External Services** dialog, or by running the following command: | |
| You can get the account ID and availability zones information at the bottom of the **Create Private Endpoint for External Services** dialog, or by running the following command: |
As per coding guidelines, do not introduce new terminology when an established term exists.
Source: Coding guidelines
| > | ||
| > If your TiDB Cloud Essential instance is created after June 30, 2026 and the **Private Link Connection For Dataflow** area is not available, you can create a private link connection in endpoint exclusive mode by clicking **Create Private Endpoint for External Services** in the **Alibaba Cloud Private Endpoint for External Services** area instead. In the endpoint exclusive model, each {{{ .essential }}} instance uses its own standalone private endpoint. This model eliminates the need to include the [account prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix) when connecting. | ||
| > - If your TiDB Cloud Essential instance is created on July 1, 2026 or later, clicking **Create Private Endpoint for External Services** creates a private link connection in endpoint exclusive mode. In this mode, each {{{ .essential }}} instance uses its own standalone private endpoint, which eliminates the need to include the [account prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix) when connecting. | ||
| > - If your TiDB Cloud Essential instance is created before July 1, 2026, clicking **Create Private Endpoint for External Services** creates a private link connection in endpoint shared mode. In this mode, a single private endpoint can be shared by multiple {{{ .essential }}} instances in the same AWS Region. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Correct the Alibaba Cloud region name.
This Alibaba Cloud workflow says AWS Region. Use Alibaba Cloud Region instead. (docs.pingcap.com)
| > - If your TiDB Cloud Essential instance is created before July 1, 2026, clicking **Create Private Endpoint for External Services** creates a private link connection in endpoint shared mode. In this mode, a single private endpoint can be shared by multiple {{{ .essential }}} instances in the same AWS Region. | |
| > - If your TiDB Cloud Essential instance is created before July 1, 2026, clicking **Create Private Endpoint for External Services** creates a private link connection in endpoint shared mode. In this mode, a single private endpoint can be shared by multiple {{{ .essential }}} instances in the same Alibaba Cloud Region. |
Source: MCP tools
1 participant
First-time contributors' checklist
What is changed, added or deleted? (Required)
Update the private endpoint steps for external services
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)?
AI agent involvement
Do your changes match any of the following descriptions?