Skip to content

Commit 70049c6

Browse files
authored
docs: add MySQL backend TLS configuration doc (#2124)
1 parent 0bdae3f commit 70049c6

File tree

2 files changed

+42
-2
lines changed
  • docs/user-guide/deployments-administration/manage-metadata
  • i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/manage-metadata

2 files changed

+42
-2
lines changed

docs/user-guide/deployments-administration/manage-metadata/configuration.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,27 @@ store_addrs = ["mysql://user:password@ip:port/dbname"]
8383
# Default: greptime_metakv
8484
meta_table_name = "greptime_metakv"
8585

86-
# TLS is not supported for MySQL currently.
86+
[backend_tls]
87+
# - "disable" - No TLS
88+
# - "prefer" (default) - Try TLS, fallback to plain
89+
# - "require" - Require TLS
90+
# - "verify_ca" - Require TLS and verify CA
91+
# - "verify_full" - Require TLS and verify hostname
92+
mode = "prefer"
93+
94+
# Path to client certificate file (for client authentication)
95+
# Like "/path/to/client.crt"
96+
cert_path = ""
97+
98+
# Path to client private key file (for client authentication)
99+
# Like "/path/to/client.key"
100+
key_path = ""
101+
102+
# Path to CA certificate file (for server certificate verification)
103+
# Required when using custom CAs or self-signed certificates
104+
# Leave empty to use system root certificates only
105+
# Like "/path/to/ca.crt"
106+
ca_cert_path = ""
87107
```
88108

89109
When sharing a MySQL instance between multiple GreptimeDB clusters, you must set a unique `meta_table_name` for each GreptimeDB cluster to avoid metadata conflicts.

i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/manage-metadata/configuration.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,27 @@ store_addrs = ["mysql://user:password@ip:port/dbname"]
8383
# 默认值: greptime_metakv
8484
meta_table_name = "greptime_metakv"
8585

86-
# MySQL 暂不支持 TLS。
86+
[backend_tls]
87+
# - "disable" - 不使用 TLS
88+
# - "prefer" (默认) - 尝试 TLS,失败时回退到明文连接
89+
# - "require" - 要求 TLS
90+
# - "verify_ca" - 要求 TLS 并验证 CA
91+
# - "verify_full" - 要求 TLS 并验证主机名
92+
mode = "prefer"
93+
94+
# 客户端证书文件路径(用于客户端身份验证)
95+
# 例如 "/path/to/client.crt"
96+
cert_path = ""
97+
98+
# 客户端私钥文件路径(用于客户端身份验证)
99+
# 例如 "/path/to/client.key"
100+
key_path = ""
101+
102+
# CA 证书文件路径(用于服务器证书验证)
103+
# 使用自定义 CA 或自签名证书时必需
104+
# 留空则仅使用系统根证书
105+
# 例如 "/path/to/ca.crt"
106+
ca_cert_path = ""
87107
```
88108

89109
当多个 GreptimeDB 集群共享同一个 MySQL 实例时,必须为每个 GreptimeDB 集群设置一个唯一的 `meta_table_name` 以避免元数据冲突。

0 commit comments

Comments
 (0)