Skip to content

Commit

Permalink
Modify the inaccuracies in the TLS description (#15312)
Browse files Browse the repository at this point in the history
* Modify the inaccuracies in the TLS description

* Apply suggestions from code review

* CA cert description modification

* Update tidb-cloud/tidb-cloud-tls-connect-to-dedicated.md

* Update migrate-from-mysql-using-aws-dms.md

* Update tidb-cloud/tidb-cloud-tls-connect-to-dedicated.md

Co-authored-by: xixirangrang <[email protected]>

* Apply suggestions from code review

* Update tidb-cloud/tidb-cloud-tls-connect-to-dedicated.md

---------

Co-authored-by: lianan-352889950 <[email protected]>
Co-authored-by: Grace Cai <[email protected]>
Co-authored-by: xixirangrang <[email protected]>
  • Loading branch information
4 people authored Nov 14, 2023
1 parent 8e17c84 commit 77ea37d
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
4 changes: 2 additions & 2 deletions tidb-cloud/connect-via-standard-connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ To connect to a TiDB Dedicated cluster via standard connection, take the followi

3. Click **Create Filter** to confirm the changes.

4. Under **Step 2: Download TiDB cluster CA** in the dialog, click **Download TiDB cluster CA** for TLS connection to TiDB clusters. The TiDB cluster CA supports TLS 1.2 version by default.
4. Under **Step 2: Download CA cert** in the dialog, click **Download CA cert** for TLS connection to TiDB clusters. The CA cert supports TLS 1.2 version by default.

> **Note:**
>
> - The TiDB cluster CA is only available for TiDB Dedicated clusters.
> - The CA cert is only available for TiDB Dedicated clusters.
> - Currently, TiDB Cloud only provides the connection strings and sample code for these connection methods: MySQL, MyCLI, JDBC, Python, Go, and Node.js.
5. Under **Step 3: Connect with a SQL client** in the dialog, click the tab of your preferred connection method, and then refer to the connection string and sample code on the tab to connect to your cluster.
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/migrate-from-mysql-using-aws-dms.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ AWS DMS does not support replicating `DROP TABLE`.

3. Under **Step 1: Create traffic filter** in the dialog, click **Edit**, enter the public and private network IP addresses that you copied from the AWS DMS console, and then click **Update Filter**. It is recommended to add the public IP address and private IP address of the AWS DMS replication instance to the TiDB cluster traffic filter at the same time. Otherwise, AWS DMS might not be able to connect to the TiDB cluster in some scenarios.

4. Click **Download TiDB cluster CA** to download the CA certificate. Under **Step 3: Connect with a SQL client** in the dialog, take a note of the `-u`, `-h`, and `-P` information in the connection string for later use.
4. Click **Download CA cert** to download the CA certificate. Under **Step 3: Connect with a SQL client** in the dialog, take a note of the `-u`, `-h`, and `-P` information in the connection string for later use.

5. Click the **VPC Peering** tab in the dialog, and then click **Add** under **Step 1: Set up VPC** to create a VPC Peering connection for the TiDB cluster and AWS DMS.

Expand Down
7 changes: 4 additions & 3 deletions tidb-cloud/tidb-cloud-tls-connect-to-dedicated.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,17 @@ In the [TiDB Cloud console](https://tidbcloud.com/), you can get examples of dif

3. On the **Standard Connection** tab of this dialog, follow the three steps to set up the TLS connection.
- Step 1:Create traffic filter
- Step 2:Download TiDB cluster CA
- Step 2:Download CA cert
- Step 3:Connect with an SQL client

4. Under **Step 1: Create traffic filter** in the dialog, configure the IP addresses that are allowed to access your cluster. For more information, see [Configure an IP access list in standard connection](/tidb-cloud/configure-ip-access-list.md#configure-an-ip-access-list-in-standard-connection).

5. Under **Step 2: Download TiDB cluster CA**, click **Download TiDB cluster CA** to download it locally for client TLS configuration. The TiDB cluster CA ensures that the TLS connection is secure and reliable.
5. Under **Step 2: Download CA cert**, click **Download CA cert** to download it locally for client TLS configuration. The CA cert ensures that the TLS connection is secure and reliable.

> **Note:**
>
> After downloading your TiDB Dedicated cluster CA, you can store it in the default storage path of your operating system, or specify another storage path. You need to replace the CA path in the code example with your own cluster CA path in the subsequent steps.
> - You can store the downloaded CA cert in the default storage path of your operating system, or specify another storage path. You need to replace the CA cert path in the code example with your own CA cert path in the subsequent steps.
> - TiDB Dedicated does not force clients to use TLS connections, and user-defined configuration of the [`require_secure_transport`](/system-variables.md#require_secure_transport-new-in-v610) variable is currently not supported on TiDB Dedicated.
6. Under **Step 3: Connect with an SQL client** in the dialog, click the tab of your preferred connection method, and then refer to the connection string and sample code on the tab to connect to your cluster.

Expand Down

0 comments on commit 77ea37d

Please sign in to comment.