From 84db569873d0e886acfa42e46a956667ce071930 Mon Sep 17 00:00:00 2001 From: Ning Sun Date: Tue, 19 Nov 2024 08:51:01 +0800 Subject: [PATCH] docs: add tls configurations (#1293) Co-authored-by: jeremyhi --- docs/user-guide/deployments/configuration.md | 13 +++++++++++++ .../current/user-guide/deployments/configuration.md | 11 +++++++++++ .../user-guide/deployments/configuration.md | 10 ++++++++++ .../user-guide/deployments/configuration.md | 11 +++++++++++ 4 files changed, 45 insertions(+) diff --git a/docs/user-guide/deployments/configuration.md b/docs/user-guide/deployments/configuration.md index 995b782ea..be95f8f02 100644 --- a/docs/user-guide/deployments/configuration.md +++ b/docs/user-guide/deployments/configuration.md @@ -129,6 +129,7 @@ runtime_size = 2 mode = "disable" cert_path = "" key_path = "" +watch = false [postgres] enable = true @@ -139,6 +140,7 @@ runtime_size = 2 mode = "disable" cert_path = "" key_path = "" +watch = false [opentsdb] enable = true @@ -179,6 +181,17 @@ The following table describes the options in detail: | | addr | String | Server address, "127.0.0.1:4003" by default | | | runtime_size | Integer | The number of server worker threads, 2 by default | +For MySQL and Postgres interface, TLS can be configured to enable transport +layer security. + +| Option | Key | Type | Description | +|-------------------------------|-------------|---------|---------------------------------------------------------------| +| `mysql.tls` or `postgres.tls` | | | TLS configuration for MySQL and Postgres | +| | `mode` | String | TLS mode, options are `disable`, `prefer` and `require` | +| | `cert_path` | String | File path for TLS certificate | +| | `key_path` | String | File path for TLS private key | +| | `watch` | Boolean | Watch file system changes and reload certificate and key file | + ### Storage options The `storage` options are valid in datanode and standalone mode, which specify the database data directory and other storage-related options. diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/configuration.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/configuration.md index d6f90f46e..52d9d8e91 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/configuration.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments/configuration.md @@ -169,6 +169,17 @@ enable = true | | addr | 字符串 | 服务器地址，默认为 "127.0.0.1:4003" | | | runtime_size | 整数 | 服务器工作线程数量，默认为 2 | +对 MySQL 和 Postgres 接口，我们支持 TLS 配置 + +| Option | Key | Type | Description | +|-------------------------------|-------------|---------|--------------------------------------------------| +| `mysql.tls` 或 `postgres.tls` | | | MySQL 或 Postgres 的 TLS 配置 | +| | `mode` | String | TLS 模式，支持 `disable`, `prefer` and `require` | +| | `cert_path` | String | TLS 证书文件路径 | +| | `key_path` | String | TLS 私钥文件路径 | +| | `watch` | Boolean | 监控文件变化，自动重新加载证书或私钥 | + + ### 存储选项 `存储`选项在 `datanode` 和 `standalone` 模式下有效，它指定了数据库数据目录和其他存储相关的选项。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-0.9/user-guide/deployments/configuration.md b/i18n/zh/docusaurus-plugin-content-docs/version-0.9/user-guide/deployments/configuration.md index 63d325f8e..bc6e1aade 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-0.9/user-guide/deployments/configuration.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-0.9/user-guide/deployments/configuration.md @@ -169,6 +169,16 @@ enable = true | | addr | 字符串 | 服务器地址，默认为 "127.0.0.1:4003" | | | runtime_size | 整数 | 服务器工作线程数量，默认为 2 | +对 MySQL 和 Postgres 接口，我们支持 TLS 配置 + +| Option | Key | Type | Description | +|-------------------------------|-------------|---------|--------------------------------------------------| +| `mysql.tls` 或 `postgres.tls` | | | MySQL 或 Postgres 的 TLS 配置 | +| | `mode` | String | TLS 模式，支持 `disable`, `prefer` and `require` | +| | `cert_path` | String | TLS 证书文件路径 | +| | `key_path` | String | TLS 私钥文件路径 | +| | `watch` | Boolean | 监控文件变化，自动重新加载证书或私钥 | + ### 存储选项 `存储`选项在 `datanode` 和 `standalone` 模式下有效，它指定了数据库数据目录和其他存储相关的选项。 diff --git a/versioned_docs/version-0.9/user-guide/deployments/configuration.md b/versioned_docs/version-0.9/user-guide/deployments/configuration.md index 2d8e5d53a..30ad8075e 100644 --- a/versioned_docs/version-0.9/user-guide/deployments/configuration.md +++ b/versioned_docs/version-0.9/user-guide/deployments/configuration.md @@ -179,6 +179,17 @@ The following table describes the options in detail: | | addr | String | Server address, "127.0.0.1:4003" by default | | | runtime_size | Integer | The number of server worker threads, 2 by default | +For MySQL and Postgres interface, TLS can be configured to enable transport +layer security. + +| Option | Key | Type | Description | +|-------------------------------|-------------|---------|---------------------------------------------------------------| +| `mysql.tls` or `postgres.tls` | | | TLS configuration for MySQL and Postgres | +| | `mode` | String | TLS mode, options are `disable`, `prefer` and `require` | +| | `cert_path` | String | File path for TLS certificate | +| | `key_path` | String | File path for TLS private key | +| | `watch` | Boolean | Watch file system changes and reload certificate and key file | + ### Storage options The `storage` options are valid in datanode and standalone mode, which specify the database data directory and other storage-related options.