From 36ccde7e7334923985914b4d884b0e1bb48cd5d6 Mon Sep 17 00:00:00 2001 From: zhangyangyu Date: Mon, 15 Jan 2024 15:49:45 +0800 Subject: [PATCH 1/7] add disable public endpoint --- ...nect-via-standard-connection-serverless.md | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/tidb-cloud/connect-via-standard-connection-serverless.md b/tidb-cloud/connect-via-standard-connection-serverless.md index 9840381bfe9fe..d60c94ad93913 100644 --- a/tidb-cloud/connect-via-standard-connection-serverless.md +++ b/tidb-cloud/connect-via-standard-connection-serverless.md @@ -34,6 +34,28 @@ To connect to a TiDB Serverless cluster via public endpoint, take the following > > When you connect to a TiDB Serverless cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix). +## Disable Public Endpoint + +Users can disable the public endpoint of a TiDB Serverless cluster to prevent connection from the Internet: + +1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. + +2. Click **Network** in the left navigation bar and click **Disable** in right pane. A confirmation dialog is displayed. + +3. Click **Disable** in the confirmation dialog. + +After disabling, the **Public** entry in the **Endpoint Type** drop-down list in the connect pane is disabled. If users are still trying to access the cluster from Public Endpoint, an error will be returned. + +> **Note:** +> +> Disable the public endpoint won't affect existing connections. It only prevents new connections from the Internet. + +Users can also enable the public endpoint after disabling: + +1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. + +2. Click **Network** in the left navigation bar and click **Enable** in right pane. + ## What's next After you have successfully connected to your TiDB cluster, you can [explore SQL statements with TiDB](/basic-sql-operations.md). From 7feac2a01ffa7d54c88c72b6c08933cc5d812cc1 Mon Sep 17 00:00:00 2001 From: Ran Date: Mon, 15 Jan 2024 15:59:38 +0800 Subject: [PATCH 2/7] restructure the doc --- tidb-cloud/connect-via-standard-connection-serverless.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tidb-cloud/connect-via-standard-connection-serverless.md b/tidb-cloud/connect-via-standard-connection-serverless.md index d60c94ad93913..2e139a4af00f4 100644 --- a/tidb-cloud/connect-via-standard-connection-serverless.md +++ b/tidb-cloud/connect-via-standard-connection-serverless.md @@ -5,7 +5,9 @@ summary: Learn how to connect to your TiDB Serverless cluster via public endpoin # Connect to TiDB Serverless via Public Endpoint -This document describes how to connect to your TiDB Serverless cluster via a public endpoint, using a SQL client from your computer. +This document describes how to connect to your TiDB Serverless cluster via a public endpoint, using a SQL client from your computer, as well as how to disable a public endpoint. + +## Connect via a public endpoint > **Tip:** > From 7ac5fe28ea09f95571c42b0336c9eca298cbf3c0 Mon Sep 17 00:00:00 2001 From: zhangyangyu Date: Mon, 15 Jan 2024 17:09:24 +0800 Subject: [PATCH 3/7] fix --- tidb-cloud/connect-via-standard-connection-serverless.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tidb-cloud/connect-via-standard-connection-serverless.md b/tidb-cloud/connect-via-standard-connection-serverless.md index d60c94ad93913..11e3b2e5734e3 100644 --- a/tidb-cloud/connect-via-standard-connection-serverless.md +++ b/tidb-cloud/connect-via-standard-connection-serverless.md @@ -40,7 +40,7 @@ Users can disable the public endpoint of a TiDB Serverless cluster to prevent co 1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. -2. Click **Network** in the left navigation bar and click **Disable** in right pane. A confirmation dialog is displayed. +2. Click **Networking** in the left navigation bar and click **Disable** in right pane. A confirmation dialog is displayed. 3. Click **Disable** in the confirmation dialog. @@ -54,7 +54,7 @@ Users can also enable the public endpoint after disabling: 1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. -2. Click **Network** in the left navigation bar and click **Enable** in right pane. +2. Click **Networking** in the left navigation bar and click **Enable** in right pane. ## What's next From 335535d4a70d65a67077237602e23cd35e7ee795 Mon Sep 17 00:00:00 2001 From: zhangyangyu Date: Mon, 15 Jan 2024 17:12:46 +0800 Subject: [PATCH 4/7] fix --- tidb-cloud/connect-via-standard-connection-serverless.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-cloud/connect-via-standard-connection-serverless.md b/tidb-cloud/connect-via-standard-connection-serverless.md index 946ce6811454c..d5dedbde5777c 100644 --- a/tidb-cloud/connect-via-standard-connection-serverless.md +++ b/tidb-cloud/connect-via-standard-connection-serverless.md @@ -46,7 +46,7 @@ Users can disable the public endpoint of a TiDB Serverless cluster to prevent co 3. Click **Disable** in the confirmation dialog. -After disabling, the **Public** entry in the **Endpoint Type** drop-down list in the connect pane is disabled. If users are still trying to access the cluster from Public Endpoint, an error will be returned. +After disabling, the `Public` entry in the **Endpoint Type** drop-down list in the connect pane is disabled. If users are still trying to access the cluster from public endpoint, an error will be returned. > **Note:** > From d7a0181d442984a6467fe9e56b5cd3b68346e666 Mon Sep 17 00:00:00 2001 From: Xiang Zhang Date: Mon, 15 Jan 2024 22:08:30 +0800 Subject: [PATCH 5/7] Apply suggestions from code review Co-authored-by: Ran --- tidb-cloud/connect-via-standard-connection-serverless.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tidb-cloud/connect-via-standard-connection-serverless.md b/tidb-cloud/connect-via-standard-connection-serverless.md index d5dedbde5777c..16bc654d88d67 100644 --- a/tidb-cloud/connect-via-standard-connection-serverless.md +++ b/tidb-cloud/connect-via-standard-connection-serverless.md @@ -36,9 +36,9 @@ To connect to a TiDB Serverless cluster via public endpoint, take the following > > When you connect to a TiDB Serverless cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix). -## Disable Public Endpoint +## Disable a public endpoint -Users can disable the public endpoint of a TiDB Serverless cluster to prevent connection from the Internet: +If you do not need to use a public endpoint of a TiDB Serverless cluster, you can disable it to prevent connection from the Internet: 1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. @@ -50,9 +50,9 @@ After disabling, the `Public` entry in the **Endpoint Type** drop-down list in t > **Note:** > -> Disable the public endpoint won't affect existing connections. It only prevents new connections from the Internet. +> Disabling the public endpoint does not affect existing connections. It only prevents new connections from the Internet. -Users can also enable the public endpoint after disabling: +You can re-enable the public endpoint after disabling it: 1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. From 15b402943d6bff62cc71e1c29f35c490a3e1c076 Mon Sep 17 00:00:00 2001 From: Ran Date: Tue, 16 Jan 2024 09:28:49 +0800 Subject: [PATCH 6/7] Apply suggestions from code review --- tidb-cloud/connect-via-standard-connection-serverless.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tidb-cloud/connect-via-standard-connection-serverless.md b/tidb-cloud/connect-via-standard-connection-serverless.md index 16bc654d88d67..072a4e56801ef 100644 --- a/tidb-cloud/connect-via-standard-connection-serverless.md +++ b/tidb-cloud/connect-via-standard-connection-serverless.md @@ -42,7 +42,7 @@ If you do not need to use a public endpoint of a TiDB Serverless cluster, you ca 1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. -2. Click **Networking** in the left navigation bar and click **Disable** in right pane. A confirmation dialog is displayed. +2. Click **Networking** in the left navigation bar and click **Disable** in the right pane. A confirmation dialog is displayed. 3. Click **Disable** in the confirmation dialog. @@ -56,7 +56,7 @@ You can re-enable the public endpoint after disabling it: 1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. -2. Click **Networking** in the left navigation bar and click **Enable** in right pane. +2. Click **Networking** in the left navigation bar and click **Enable** in the right pane. ## What's next From d3d8c75dd355490818c1a5c1bc29702a7787c81d Mon Sep 17 00:00:00 2001 From: Xiang Zhang Date: Tue, 16 Jan 2024 11:40:31 +0800 Subject: [PATCH 7/7] Apply suggestions from code review Co-authored-by: Grace Cai --- .../connect-via-standard-connection-serverless.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/tidb-cloud/connect-via-standard-connection-serverless.md b/tidb-cloud/connect-via-standard-connection-serverless.md index 072a4e56801ef..d8cf180f10989 100644 --- a/tidb-cloud/connect-via-standard-connection-serverless.md +++ b/tidb-cloud/connect-via-standard-connection-serverless.md @@ -38,25 +38,25 @@ To connect to a TiDB Serverless cluster via public endpoint, take the following ## Disable a public endpoint -If you do not need to use a public endpoint of a TiDB Serverless cluster, you can disable it to prevent connection from the Internet: +If you do not need to use a public endpoint of a TiDB Serverless cluster, you can disable it to prevent connections from the internet: 1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. -2. Click **Networking** in the left navigation bar and click **Disable** in the right pane. A confirmation dialog is displayed. +2. Click **Networking** in the left navigation pane and click **Disable** in the right pane. A confirmation dialog is displayed. 3. Click **Disable** in the confirmation dialog. -After disabling, the `Public` entry in the **Endpoint Type** drop-down list in the connect pane is disabled. If users are still trying to access the cluster from public endpoint, an error will be returned. +After disabling the public endpoint, the `Public` entry in the **Endpoint Type** drop-down list of the connect dialog is disabled. If users are still trying to access the cluster from the public endpoint, they will get an error. > **Note:** > -> Disabling the public endpoint does not affect existing connections. It only prevents new connections from the Internet. +> Disabling the public endpoint does not affect existing connections. It only prevents new connections from the internet. You can re-enable the public endpoint after disabling it: 1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. -2. Click **Networking** in the left navigation bar and click **Enable** in the right pane. +2. Click **Networking** in the left navigation pane and click **Enable** in the right pane. ## What's next