[iotdb] branch master updated: add ratis log doc (#8312)

[qi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

qiaojialin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git


The following commit(s) were added to refs/heads/master by this push:
     new 22457f5527 add ratis log doc (#8312)
22457f5527 is described below

commit 22457f55279ca334d8d845c0625b01f1c7a9f1ed
Author: William Song <48...@users.noreply.github.com>
AuthorDate: Sat Dec 3 11:28:07 2022 +0800

    add ratis log doc (#8312)
---
 docs/UserGuide/Cluster/Deployment-Recommendation.md    | 3 +++
 docs/zh/UserGuide/Cluster/Deployment-Recommendation.md | 3 +++
 2 files changed, 6 insertions(+)

diff --git a/docs/UserGuide/Cluster/Deployment-Recommendation.md b/docs/UserGuide/Cluster/Deployment-Recommendation.md
index 9c9b53d95c..063dfab024 100644
--- a/docs/UserGuide/Cluster/Deployment-Recommendation.md
+++ b/docs/UserGuide/Cluster/Deployment-Recommendation.md
@@ -157,6 +157,9 @@ The total Raft Log storage space is proportional to the data replica number
 > Example: DataRegion, 20kB data for one request, data_region_trigger_snapshot_threshold = 400,000, then max Raft Log disk size = 20K * 400,000 = 8G.
 Raft Log increases from 0 to 8GB, and then turns to 0 after snapshot. Average size will be 4GB.
 When replica number is 3, max Raft log size will be 3 * 8G = 24G.
+ 
+What's more, we can configure data_region_ratis_log_max_size to limit max log size of a single DataRegion.
+By default, data_region_ratis_log_max_size=20G, which guarantees that Raft Log size would not exceed 20G.
 
 3. Compaction
 
diff --git a/docs/zh/UserGuide/Cluster/Deployment-Recommendation.md b/docs/zh/UserGuide/Cluster/Deployment-Recommendation.md
index 0838928f9f..a64f348a86 100644
--- a/docs/zh/UserGuide/Cluster/Deployment-Recommendation.md
+++ b/docs/zh/UserGuide/Cluster/Deployment-Recommendation.md
@@ -154,6 +154,9 @@ Ratis共识协议
 > 示例：DataRegion, 平均每一次插入20k数据，data_region_trigger_snapshot_threshold = 400,000，那么Raft Log最大占用 = 20K * 400,000 = 8G。
 Raft Log会从0增长到8G，接着在snapshot之后重新变成0。平均占用为4G。
 当副本数为3时，集群中这个DataRegion总Raft Log最大占用 3 * 8G = 24G。
+ 
+此外，可以通过data_region_ratis_log_max_size规定每一个DataRegion的Raft Log磁盘占用最大值，
+默认为20G，能够保障运行全程中单DataRegion Raft Log总大小不超过20G。
 
 3. 合并临时空间