-
Notifications
You must be signed in to change notification settings - Fork 716
cloud: update the network steps according to the latest UI #23420
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
base: release-8.5
Are you sure you want to change the base?
Changes from all commits
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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -11,7 +11,9 @@ For each TiDB Cloud Dedicated cluster in TiDB Cloud, you can configure an IP acc | |||||
| > | ||||||
| > This document applies to [**TiDB Cloud Dedicated**](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). For instructions on configuring an IP access list for **{{{ .starter }}}** or **{{{ .essential }}}**, see [Configure {{{ .starter }}} or Essential Firewall Rules for Public Endpoints](/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md). | ||||||
|
|
||||||
| To configure an IP access list for your TiDB Cloud Dedicated cluster, take the following steps: | ||||||
| ## Add an IP address | ||||||
|
|
||||||
| To add an IP address to the IP access list for your TiDB Cloud Dedicated cluster, take the following steps: | ||||||
|
|
||||||
| 1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. | ||||||
|
|
||||||
|
|
@@ -21,10 +23,27 @@ To configure an IP access list for your TiDB Cloud Dedicated cluster, take the f | |||||
|
|
||||||
| 2. In the left navigation pane, click **Settings** > **Networking**. | ||||||
| 3. On the **Networking** page, click **Add IP Address**. | ||||||
| 4. In the displayed dialog, choose one of the following options: | ||||||
| 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**. | ||||||
| - 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔒 Security & Privacy | 🟡 Minor | ⚡ Quick win Limit the access description to IPv4.
Suggested change
As per path instructions: 🧰 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. (ENGLISH_WORD_REPEAT_BEGINNING_RULE) Source: Path instructions |
||||||
|
|
||||||
| 5. Click **Save**. | ||||||
|
|
||||||
| ## Edit an IP address | ||||||
|
|
||||||
| To edit an existing IP address in the IP access list, take the following steps: | ||||||
|
|
||||||
| 1. On the **Networking** page, locate the IP address you want to edit in the **IP Access List**. | ||||||
| 2. Click **...** in the row of the IP address, and then click **Edit**. | ||||||
| 3. In the **Edit IP Address** dialog, modify the IP address or description as needed. | ||||||
| 4. Click **Submit**. | ||||||
|
|
||||||
| ## Delete an IP address | ||||||
|
|
||||||
| - **Allow access from anywhere**: allows all IP addresses to access TiDB Cloud. This option exposes your TiDB Cloud Dedicated cluster to the internet completely and is highly risky. | ||||||
| - **Use IP addresses** (recommended): you can add a list of IPs and CIDR addresses that are allowed to access TiDB Cloud via a SQL client. | ||||||
| To delete an existing IP address from the IP access list, take the following steps: | ||||||
|
|
||||||
| 5. If you choose **Use IP addresses**, add IP addresses or CIDR range with an optional description. For each TiDB Cloud Dedicated cluster, you can add up to 100 IP addresses. | ||||||
| 6. Click **Confirm** to save your changes. | ||||||
| 1. On the **Networking** page, locate the IP address you want to delete in the **IP Access List**. | ||||||
| 2. Click **...** in the row of the IP address, and then click **Delete**. | ||||||
| 3. In the confirmation dialog, click **Delete**. | ||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -39,7 +39,7 @@ Ensure that the AWS endpoint service: | |||||
| - Add the TiDB Cloud account ID to the **Allow principals** list. | ||||||
| - Has availability zones that overlap with your {{{ .essential }}} instance. | ||||||
|
|
||||||
| You can get the account ID and availability 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 availability zones information at the bottom of the **Create Private Endpoint for External Services** dialog, or by running the following command: | ||||||
|
|
||||||
| ```shell | ||||||
| ticloud serverless private-link-connection zones --cluster-id <cluster-id> | ||||||
|
|
@@ -56,13 +56,14 @@ ticloud serverless private-link-connection zones --cluster-id <cluster-id> | |||||
|
|
||||||
| 2. Click the name of your target {{{ .essential }}} instance to go to its overview page, and then click **Settings** > **Networking** in the left navigation pane. | ||||||
|
|
||||||
| 3. In the **Private Link Connection For Dataflow** area, click **Create Private Link Connection** to create a private endpoint in endpoint shared mode. In this model, a single private endpoint can be shared by multiple {{{ .essential }}} instances in the same AWS Region. | ||||||
| 3. In the **AWS Private Endpoints for External Services** area, click **Create Private Endpoint for External Services**. | ||||||
|
|
||||||
| > **Note:** | ||||||
| > | ||||||
| > 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 **AWS 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. | ||||||
|
|
||||||
| 4. In the **Create Private Link Connection** dialog, enter the required information: | ||||||
| 4. In the **Create Private Endpoint for External Services** dialog, enter the required information: | ||||||
|
|
||||||
| - **Private Link Connection Name**: enter a name for the private link connection. | ||||||
| - **Connection Type**: select **AWS Endpoint Service**. If this option is not displayed, ensure that your {{{ .essential }}} instance is created on AWS. | ||||||
|
|
@@ -103,13 +104,14 @@ Before creating the Amazon MSK Provisioned private link connection, ensure that | |||||
|
|
||||||
| 2. Click the name of your target {{{ .essential }}} instance to go to its overview page, and then click **Settings** > **Networking** in the left navigation pane. | ||||||
|
|
||||||
| 3. In the **Private Link Connection For Dataflow** area, click **Create Private Link Connection** to create a private endpoint in endpoint shared mode. In this model, a single private endpoint can be shared by multiple {{{ .essential }}} instances in the same AWS Region. | ||||||
| 3. In the **AWS Private Endpoints for External Services** area, click **Create Private Endpoint for External Services**. | ||||||
|
|
||||||
| > **Note:** | ||||||
| > | ||||||
| > 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 **Amazon MSK Provisioned 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. | ||||||
|
|
||||||
| 4. In the **Create Private Link Connection** dialog, enter the required information: | ||||||
| 4. In the **Create Private Endpoint for External Services** dialog, enter the required information: | ||||||
|
|
||||||
| - **Private Link Connection Name**: enter a name for the private link connection. | ||||||
| - **Connection Type**: select **Amazon MSK Provisioned**. If this option is not displayed, ensure that your {{{ .essential }}} instance is created on AWS. | ||||||
|
|
@@ -127,7 +129,7 @@ Ensure that the Alibaba Cloud endpoint service: | |||||
| - Add the TiDB Cloud account ID to the **Service Whitelist**. | ||||||
| - 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win Use the established term Line 132 introduces
Suggested change
As per coding guidelines, do not introduce new terminology when an established term exists. Source: Coding guidelines |
||||||
|
|
||||||
| ```shell | ||||||
| ticloud serverless private-link-connection zones --cluster-id <cluster-id> | ||||||
|
|
@@ -144,13 +146,14 @@ ticloud serverless private-link-connection zones --cluster-id <cluster-id> | |||||
|
|
||||||
| 2. Click the name of your target {{{ .essential }}} instance to go to its overview page, and then click **Settings** > **Networking** in the left navigation pane. | ||||||
|
|
||||||
| 3. In the **Private Link Connection For Dataflow** area, click **Create Private Link Connection** to create a private endpoint in endpoint shared mode. In this model, a single private endpoint can be shared by multiple {{{ .essential }}} instances in the same Alibaba Cloud Region. | ||||||
| 3. In the **Alibaba Cloud Private Endpoints for External Services** area, click **Create Private Endpoint for External Services**. | ||||||
|
|
||||||
| > **Note:** | ||||||
| > | ||||||
| > 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win Correct the Alibaba Cloud region name. This Alibaba Cloud workflow says
Suggested change
Source: MCP tools |
||||||
|
|
||||||
| 4. In the **Create Private Link Connection** dialog, enter the required information: | ||||||
| 4. In the **Create Private Endpoint for External Services** dialog, enter the required information: | ||||||
|
|
||||||
| - **Private Link Connection Name**: enter a name for the private link connection. | ||||||
| - **Connection Type**: select **Alibaba Cloud Endpoint Service**. If this option is not displayed, ensure that your {{{ .essential }}} instance is created on Alibaba Cloud. | ||||||
|
|
@@ -206,7 +209,7 @@ To attach domains to a private link connection using the TiDB Cloud console, do | |||||
|
|
||||||
| 2. Click the name of your target {{{ .essential }}} instance to go to its overview page, and then click **Settings** > **Networking** in the left navigation pane. | ||||||
|
|
||||||
| 3. In the **Private Link Connection For Dataflow** area, choose the target private link connection, and then click **...**. | ||||||
| 3. In the **Private Endpoints for External Services** area for your cloud provider, choose the target private link connection, and then click **...**. | ||||||
|
|
||||||
| 4. Click **Attach Domains**. | ||||||
|
|
||||||
|
|
@@ -259,7 +262,7 @@ To detach domains from a private link connection using the TiDB Cloud console, d | |||||
|
|
||||||
| 2. Click the name of your target {{{ .essential }}} instance to go to its overview page, and then click **Settings** > **Networking** in the left navigation pane. | ||||||
|
|
||||||
| 3. In the **Private Link Connection For Dataflow** area, choose the target private link connection, and then click **...**. | ||||||
| 3. In the **Private Endpoints for External Services** area for your cloud provider, choose the target private link connection, and then click **...**. | ||||||
|
|
||||||
| 4. Click **Detach Domains**, and then confirm the detachment. | ||||||
|
|
||||||
|
|
@@ -301,7 +304,7 @@ To delete a private link connection using the TiDB Cloud console, do the followi | |||||
|
|
||||||
| 2. Click the name of your target {{{ .essential }}} instance to go to its overview page, and then click **Settings** > **Networking** in the left navigation pane. | ||||||
|
|
||||||
| 3. In the **Private Link Connection For Dataflow** area, choose the target private link connection, and then click **...**. | ||||||
| 3. In the **Private Endpoints for External Services** area for your cloud provider, choose the target private link connection, and then click **...**. | ||||||
|
|
||||||
| 4. Click **Delete**, and then confirm the deletion. | ||||||
|
|
||||||
|
|
||||||
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.
🎯 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.
As per path instructions:
**/*.mdrequires a GitHub committable suggestion for an actionable issue when the fix is contiguous.Source: Path instructions