Skip to content
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

Modify the inaccuracies in the TLS description #15312

Merged
merged 9 commits into from
Nov 14, 2023
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.
qiancai marked this conversation as resolved.
Show resolved Hide resolved

> **Note:**
>
> - The TiDB cluster CA is only available for TiDB Dedicated clusters.
> - The CA Cert is only available for TiDB Dedicated clusters.
qiancai marked this conversation as resolved.
Show resolved Hide resolved
> - 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
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
qiancai marked this conversation as resolved.
Show resolved Hide resolved
- 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.
qiancai marked this conversation as resolved.
Show resolved Hide resolved
qiancai marked this conversation as resolved.
Show resolved Hide resolved

> **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.
> - After downloading your CA Cert, you can store it 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.
qiancai marked this conversation as resolved.
Show resolved Hide resolved
> - 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](https://docs.pingcap.com/tidbcloud/system-variables#require_secure_transport-new-in-v610).
qiancai marked this conversation as resolved.
Show resolved Hide resolved

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