chore: add docs for v2.2.9 (#192)

Author: yinbo3

zh_CN/admin/configuration-fields/license.md

@@ -2,7 +2,11 @@
 
 `license` 部分管理 Datalayers 系统的许可证密钥。
 
-- **`key`**:  
-  包含系统的试用许可证密钥。此密钥用于激活软件。  
-  - **示例**：`key = "eyJ2IjoxLCJ0IjoxLCJjbiI6InRlc3QiLCJjZSI6bnVsbCwic2QiOiIyMDI0MDUxNyIsInZkIjozNjUsIm5sIjoxMDAsImNsIjoyNTYsImVsIjoxMDAwLCJmcyI6W119.dLBEUr9WDhuTBllPiZ3lNXOL2YtjuvFVUYQvmc85Ak0jgqHhtoCVz09GHAqdPs8yrzMxnQRiGeK49/Puzvqi6X5X0rYEOx5eiKuifWEkYnXDjtUfdvY79Z4p1SWi5h56hyyyvgrc6lPCWnccqM+JWNWA1a3QHo6V288KBQPFZvOcUY1Kl6F9lHHs5NVx/Wq+92cqg+VJ+ONivxwt3Y35VRelFczARLrpYdngpUQtvXud4nRGuDTj4YkhEZAgpjZXg7WMS8w54zboDOPKcLL5bhUTYa4WSinhSeWLEniISPu0/TihSlXsp/UqamUnb+NHa2sjMTKzAp0CeOZwZA++fQ=="`。
+## 配置示例  
 
+```toml
+# The configurations of license.
+[license]
+# A trial license key which may be deprecated.
+key = "eyJ2IjoxLCJ0IjoxLCJjbiI6InRlc3QiLCJjZSI6bnVsbCwic2QiOiIyMDI0MDUxNyIsInZkIjozNjUsIm5sIjoxMDAsImNsIjoyNTYsImVsIjoxMDAwLCJmcyI6W119.dLBEUr9WDhuTBllPiZ3lNXOL2YtjuvFVUYQvmc85Ak0jgqHhtoCVz09GHAqdPs8yrzMxnQRiGeK49/Puzvqi6X5X0rYEOx5eiKuifWEkYnXDjtUfdvY79Z4p1SWi5h56hyyyvgrc6lPCWnccqM+JWNWA1a3QHo6V288KBQPFZvOcUY1Kl6F9lHHs5NVx/Wq+92cqg+VJ+ONivxwt3Y35VRelFczARLrpYdngpUQtvXud4nRGuDTj4YkhEZAgpjZXg7WMS8w54zboDOPKcLL5bhUTYa4WSinhSeWLEniISPu0/TihSlXsp/UqamUnb+NHa2sjMTKzAp0CeOZwZA++fQ=="
+```

zh_CN/admin/configuration-fields/log.md

@@ -2,46 +2,31 @@
 
 `log` 部分配置日志的生成、存储和管理方式。
 
-- **`path`**:  
-  指定日志文件存储的目录。确保该目录具有足够的权限，以便 Datalayers 系统可以写入日志。  
-  - **默认值**：`"/var/log/datalayers/"`。
-  - **示例**：`path = "/var/log/datalayers/"`。
-
-- **`level`**:  
-  设置日志输出的详细程度。可用的级别包括：
-  - `"trace"`：详细的调试信息。
-  - `"debug"`：调试信息。
-  - `"info"`：一般操作信息。
-  - `"warn"`：潜在问题的警告。
-  - `"error"`：发生的错误。  
-  - **默认值**：`"info"`。
-  - **示例**：`level = "info"`。
-
-- **`rotation`**:  
-  确定新日志文件的创建频率。旋转选项包括：
-  - `"MINUTELY"` 或 `"M"`：每分钟。
-  - `"HOURLY"` 或 `"H"`：每小时。
-  - `"DAILY"` 或 `"D"`：每天。
-  - `"NEVER"` 或 `"N"`：不旋转。  
-  - **默认值**：`"DAILY"`。
-  - **示例**：`rotation = "DAILY"`。
-
-- **`enable_stdout`**:  
-  如果设置为 `true`，日志发送到标准输出（stdout）。这对于调试和实时监控非常有用。  
-  - **默认值**：`true`。
-  - **示例**：`enable_stdout = true`。
-
-- **`enable_file`**:  
-  如果设置为 `true`，日志将写入指定目录中的文件。通常启用此选项以实现持久的日志存储。  
-  - **默认值**：`false`。
-  - **示例**：`enable_file = true`。
-
-- **`enable_err_file`**:  
-  如果设置为 `true`，错误将记录到专用的错误文件中。这有助于将错误日志与普通日志分开，以便更容易进行故障排除。  
-  - **默认值**：`false`。
-  - **示例**：`enable_err_file = true`。
-
-- **`verbose`**:  
-  设置为 `true` 时，日志会包含额外的详细信息，如行号和文件名。这增强了日志的可读性，但可能会生成更大的日志文件。  
-  - **默认值**：`true`。
-  - **示例**：`verbose = true`。
+## 配置示例
+
+```toml
+# The fixed time period for switching to a new log file.
+# Supported rotation kinds:
+# - "MINUTELY" or "M".
+# - "HOURLY" or "H".
+# - "DAILY" or "D".
+# - "NEVER" or "N".
+# Default: "HOURLY".
+rotation = "DAILY"
+
+# 日志是否输出到标准输出中，在容器中，将默认输出到标准输出 
+# Default: true.
+enable_stdout = true
+
+# Enables logging to files if set to true.
+# Default: false.
+enable_file = false
+
+# 设置错误日志是否启用单独的文件文件存储.
+# Default: false.
+enable_err_file = false
+
+# Makes the logging more verbose by inserting line number and file name.
+# Default: true.
+verbose = true
+```

zh_CN/admin/configuration-fields/node.md

@@ -2,59 +2,39 @@
 
 `node` 部分配置 Datalayers 集群中节点的行为和属性。节点的配置确保正确的标识、角色分配、超时设置、连接管理和数据存储。以下是具体的配置项：
 
-## 节点名称
-
-- **`name`**:  
-  定义集群中节点的唯一标识符。建议使用 `FQDN地址 + 端口号` 作为节点名称。  
-  - **默认值**：`"localhost:8366"`。
-  - **示例**：`name = "localhost:8366"`。
-
-## 角色
-
-- **`role`**:  
-  指定节点在集群中的角色。通过对该角色的指定可实现读、写分离。  
-  - **默认值**：`"stateless"`。
-  - **示例**：`role = "stateless"`。
-
-## 连接超时
-
-- **`connect_timeout`**:  
-  设置与集群间建立连接的超时持续时间。  
-  - **默认值**：`"1s"`。
-  - **示例**：`connect_timeout = "1s"`。
-
-## 请求超时
-
-- **`timeout`**:  
-  设置集群间通信的超时时间，防止请求无限期挂起。  
-  - **默认值**：`"120s"`。
-  - **示例**：`timeout = "120s"`。
-
-## 重试次数
-
-- **`retry_count`**:  
-  设置内部通信建立内部连接的最大重试次数。  
-  - **默认值**：`1`。
-  - **示例**：`retry_count = 1`。
-
-## 临时数据存储路径
-在集群模式下，会在当前节点下临时存储一些数据，该项配置用于设置数据的存储路径。
-
-- **`data_path`**:  
-  指定节点存储数据的目录。  
-  - **默认值**：`"/var/run/datalayers"`。
-  - **示例**：`data_path = "/var/run/datalayers"`。
-
-## 集群间通信管理
-
-- **`rpc_max_conn`**:  
-  设置每个 RPC 端点允许的最大活动连接数。限制连接数有助于管理资源使用。  
-  - **默认值**：`20`。
-  - **示例**：`rpc_max_conn = 20`。
-
-- **`rpc_min_conn`**:  
-  指定每个 RPC 端点的最小活动连接数。保持最低连接数可以确保节点能够高效处理请求。  
-  - **默认值**：`3`。
-  - **示例**：`rpc_min_conn = 3`。
-
-
+## 配置示例
+
+```toml
+[node]
+# The name of the node. It's the unique identifier of the node in the cluster and cannot be repeated.
+# Default: "localhost:8366".
+name = "localhost:8366"
+
+# Role of the node.
+# Default: "stateless"
+role = "stateless"
+
+# The timeout of connecting to the cluster.
+# Default: "1s".
+connect_timeout = "1s"
+
+# The timeout applied each request sent to the cluster.
+# Default: "120s".
+timeout = "120s"
+
+# The maximum number of retries for internal connection.
+# Default: 1.
+retry_count = 1
+
+# The directory to store data of the node.
+# Default: "/var/run/datalayers".
+data_path = "/var/run/datalayers"
+
+# The maximum number of active connections at a time between each RPC endpoints.
+# Default: 20.
+rpc_max_conn = 20
+
+# The minimum number of active connections at a time between each RPC endpoints.
+# Default: 3.
+rpc_min_conn = 3
+```

zh_CN/admin/configuration-fields/runtime.md

@@ -1,38 +1,29 @@
 # Runtime 配置
 
 该配置项用于 `CPU Core` 与 `用户线程`、`后台线程`进行分离与绑定，以保障系统在高负载时前台线程与后台线程不会争抢 CPU 资源。在系统负载较高的场景建议配置该项。
+
 ```tips
 后台线程包括不限于：compact、flush、gc、compact_active、compact_inactive
 
 前台线程：除后台线程之外的其他线程
 ```
 
-## 默认Runtime配置
-
-`runtime.default` 配置控制系统主要操作的 CPU 使用情况。
-
-- **`cpu_cores`**:  
-  定义分配给默认运行时的 CPU 核心数量。此设置允许灵活管理 CPU 资源。该值可以是绝对数量，或者为总 CPU 核心的百分比，或者为 `0` 表示不隔离该运行时的 CPU。  
-  - `>= 1`：指定分配的绝对 CPU 核心数量。  
-  - `0`：不为此运行时隔离 CPU，这意味着没有特定的核心专用于它。
-  - `> 0 and < 1`：指定分配的总 CPU 核心百分比。例如，`0.2` 表示分配 20% 的所有 CPU 核心。
-  - **默认值**: `0.0` （无 CPU 隔离）。
-
-## 后台任务Runtime配置
+## 配置示例
 
-`runtime.background` 配置管理与主要操作同时运行的后台任务的 CPU 资源分配。
-
-- **`cpu_cores`**:  
-  控制分配给后台任务的 CPU 核心数量。该值与 `runtime.default` 设置遵循相同的规则：  
-  - `>= 1`：后台任务的绝对 CPU 核心数量。  
-  - `0`：后台任务不隔离 CPU。  
-  - `> 0 and < 1`：分配给后台任务的总 CPU 核心百分比。  
-  - **默认值**: `0.0` （无 CPU 隔离）。
-
-```tips
-默认配置，前后台线程共享所有 CPU Core.
+```toml
+# The configurations of runtime.
+[runtime]
 
-所有运行配置中的 `cpu_cores` 累加不能超过系统总的 CPU 核心数量。
+# The configurations of default runtime
+#[runtime.default]
+# Isolate number of CPU, float value
+# >=1 means absolute number of CPU
+# 0 means do not use isolate cpu for this runtime
+# >0 and <1 means percentage of all CPU cores, 0.2  means 20% e.g.
+# Default: 0.0
+#cpu_cores = 0.0
 
-如果一项运行配置中设置 `cpu_cores` 不等于 0，表示该项运行配置要绑定部分 CPU，此时另外的运行配置 `cpu_cores` 等于 0 表示会绑定到剩余的 CPU 上。
+# The configurations of background runtime
+#[runtime.background]
+#cpu_cores = 0.0
 ```

zh_CN/admin/configuration-fields/scheduler.md

@@ -4,94 +4,26 @@
 
 这些配置确保了系统作业如刷新、垃圾回收和压缩的良好管理，提供最佳性能，同时防止资源过载。
 
-## Flush Job 配置
-
-`flush` Job 负责将数据从内存写入持久化存储。
-
-- **`concurrence_limit`**:  
-  定义当前节点可以同时运行的最大`flush`作业数。限制这一数值可以确保系统不会因多个刷新操作同时进行而过载。  
-  - **默认值**：`3`。
-  - **示例**：`concurrence_limit = 3`。
-
-- **`queue_limit`**:  
-  指定当前节点等待执行的最大待处理刷新作业数。这可以防止系统排队过多作业，从而导致性能下降。  
-  - **默认值**：`10000`。
-  - **示例**：`queue_limit = 10000`。
-
-- **完整示例**:
-  ```
-  [scheduler.flush]
-  concurrence_limit = 1
-  queue_limit = 10000
-  ```
-
-## 垃圾回收（GC）作业配置
-
-垃圾回收作业用于删除未使用或过时的数据，以确保资源的有效使用。
-
-- **`concurrence_limit`**:  
-  定义当前节点可以同时运行的垃圾回收作业数。这通常保持较低，以避免在关键操作期间影响系统性能。  
-  - **默认值**：`1`。
-  - **示例**：`concurrence_limit = 1`。
-
-- **`queue_limit`**:  
-  确定当前节点可以排队的垃圾回收作业数。  
-  - **默认值**：`10000`。
-  - **示例**：`queue_limit = 10000`。
-
-- **完整示例**:
-  ```
-  [scheduler.gc]
-  concurrence_limit = 1
-  queue_limit = 10000
-  ```
-
-## Compact 作业配置
-
-`compact` Job 负责对数据进行压缩、重组和优化，有助于提高存储和检索的效率。
-- **`concurrence_limit`**:  
-  定义当前节点可以同时运行的 Compact 作业数。这通常保持较低，以避免在关键操作期间影响系统性能。  
-  - **默认值**：`1`。
-  - **示例**：`concurrence_limit = 1`。
-
-- **`queue_limit`**:  
-  确定当前节点可以排队的 Compact 作业数。  
-  - **默认值**：`10000`。
-  - **示例**：`queue_limit = 10000`。
-
-- **完整示例**:
-  ```
-  [scheduler.compact]
-  concurrence_limit = 1
-  queue_limit = 10000
-  ```
-
-## 集群 Compact 活跃窗口作业配置
-
-集群模式下，控制所有节点同时运行的针对活跃窗口数据的 Compact 作业数量。活跃窗口是指当前正在写入数据的时间窗口，和表引擎中定义的 `COMPACT_WINDOW` 有关。
-
-数据压缩是资源密集型操作，全局控制总作业数量有助于防止集群资源使用过载，影响关键操作。
-
-- **`concurrence_limit`**:  
-  指定所有节点可以同时运行的针对活跃窗口数据的 Compact 作业数。
-  - **默认值**：`4`。
-  - **示例**：`concurrence_limit = 4`。
-- **完整示例**:
-  ```
-  [scheduler.cluster_compact_active]
-  concurrence_limit = 2
-  ```
-
-## 集群 Compact 非活跃窗口作业配置
-
-集群模式下，控制所有节点同时运行的针对非活跃窗口数据的 Compact 作业数量。非活跃窗口是指活跃窗口之前的时间窗口，和表引擎中定义的 `COMPACT_WINDOW` 有关。
-
-- **`concurrence_limit`**:  
-  指定所有节点可以同时运行的针对非活跃窗口数据的 Compact 作业数。
-  - **默认值**：`2`。
-  - **示例**：`concurrence_limit = 2`。
-- **完整示例**:
-  ```
-  [scheduler.cluster_compact_inactive]
-  concurrence_limit = 1
-  ```
+## 配置示例
+
+```toml
+# The configurations of the scheduler.
+[scheduler]
+
+# The configurations of the flush job.
+[scheduler.flush]
+# The maximum number of running flush jobs at the same time.
+concurrence_limit = 3
+# The maximum number of pending flush jobs at the same time
+queue_limit = 10000
+
+[scheduler.gc]
+# The maximum number of running gc jobs at the same time.
+concurrence_limit = 1
+# The maximum number of pending gc jobs at the same time
+queue_limit = 10000
+
+[scheduler.cluster_compact_inactive]
+# The maximum number of running `cluster compact inactive` jobs at the same time.
+concurrence_limit = 1
+```