Skip to content

Commit fce5583

Browse files
committed
Clarify TiProxy TLS docs and wording
Update English and Chinese TLS docs for TiProxy: clarify TiProxyCertLayout options (recommend v1), consolidate and rephrase the certificate-layout explanation, and adjust the wording around TLS settings and default TLS secret usage (including comma/punctuation fixes). Also normalize Chinese punctuation/spacing for the mTLS note and tidy related bullets.
1 parent aa47fe2 commit fce5583

File tree

2 files changed

+8
-12
lines changed

2 files changed

+8
-12
lines changed

en/enable-tls-for-mysql-client.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -731,14 +731,12 @@ SHOW GLOBAL STATUS LIKE 'Ssl\_server\_not\_%';
731731

732732
## TiProxy
733733

734-
When using TiProxy in front of a set of TiDB servers you also need to configure TLS for it.
734+
When using TiProxy in front of a set of TiDB servers you also need to configure TLS for it. Depending on the `TiProxyCertLayout` a different certificate layout is chosen:
735735

736-
Depending on the `TiProxyCertLayout` a different certificate layout is chosen:
736+
- not set: the legacy layout.
737+
- `v1`: the version one of the layout (recommended).
737738

738-
- not set: This is the legacy layout.
739-
- `v1`: This is version one of the layout. This is recommended.
740-
741-
There are TLS settings for these components of TiProxy:
739+
The following are TLS settings for these components of TiProxy:
742740

743741
- `security.cluster-tls`: used to interface with other hosts in the cluster both as server and client (mTLS).
744742
- `security.server-tls`: used for serving MySQL protocol access on port 6000.
@@ -747,9 +745,9 @@ There are TLS settings for these components of TiProxy:
747745

748746
See also [the security section of the configuration](https://docs.pingcap.com/tidb/stable/tiproxy-configuration/#security).
749747

750-
TiProxy will try to use the TLS secret from TiDB for client/server connections by default. If you do this make sure these certificates also contain the hostname of the TiProxy hosts.
748+
TiProxy will try to use the TLS secret from TiDB for client/server connections by default. If you do this, make sure these certificates also contain the hostname of the TiProxy hosts.
751749

752-
Other settings that influence this:
750+
Other settings that influence this include:
753751

754752
- `tlsCluster.enabled`
755753
- `tlsClient.enabled`

zh/enable-tls-for-mysql-client.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -738,16 +738,14 @@ SHOW GLOBAL STATUS LIKE 'Ssl\_server\_not\_%';
738738

739739
## TiProxy
740740

741-
当在一组 TiDB 服务器前使用 TiProxy 时,也需要为 TiProxy 配置 TLS。
742-
743-
根据 `TiProxyCertLayout` 的不同,会选择不同的证书布局:
741+
当在一组 TiDB 服务器前使用 TiProxy 时,也需要为 TiProxy 配置 TLS。根据 `TiProxyCertLayout` 的不同,会选择不同的证书布局:
744742

745743
- 未设置:使用旧版布局。
746744
- `v1`:使用第一版布局。推荐使用该版本。
747745

748746
TiProxy 的以下组件提供了 TLS 配置项:
749747

750-
- `security.cluster-tls`:用于与集群中的其他主机通信,同时作为服务端和客户端使用mTLS
748+
- `security.cluster-tls`:用于与集群中的其他主机通信,同时作为服务端和客户端使用 (mTLS)
751749
- `security.server-tls`:用于在 6000 端口提供 MySQL 协议访问服务。
752750
- `security.sql-tls`:用于作为客户端访问 TiDB。
753751
- `security.server-http-tls`:用于在 3080 端口提供 HTTP 服务。

0 commit comments

Comments
 (0)