Skip to content

Commit

Permalink
docs: add tls configurations (#1293)
Browse files Browse the repository at this point in the history 
Co-authored-by: jeremyhi <[email protected]>
  • Loading branch information
@sunng87 @fengjiachun
sunng87 and fengjiachun authored Nov 19, 2024
1 parent ddcc0c2 commit 84db569
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/user-guide/deployments/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ runtime_size = 2
mode = "disable"
cert_path = ""
key_path = ""
watch = false

[postgres]
enable = true
Expand All @@ -139,6 +140,7 @@ runtime_size = 2
mode = "disable"
cert_path = ""
key_path = ""
watch = false

[opentsdb]
enable = true
Expand Down Expand Up @@ -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.
Expand Down
11 changes: 11 additions & 0 deletions .../docusaurus-plugin-content-docs/current/user-guide/deployments/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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` 模式下有效，它指定了数据库数据目录和其他存储相关的选项。
Expand Down
10 changes: 10 additions & 0 deletions ...usaurus-plugin-content-docs/version-0.9/user-guide/deployments/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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` 模式下有效，它指定了数据库数据目录和其他存储相关的选项。
Expand Down
11 changes: 11 additions & 0 deletions versioned_docs/version-0.9/user-guide/deployments/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 84db569

Please sign in to comment.