You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by qi...@apache.org on 2022/12/02 11:02:48 UTC

[iotdb] branch rel/1.0 updated: [To rel/1.0] Update doc on DataRegion using RatisConsensus (#8308)

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

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


The following commit(s) were added to refs/heads/rel/1.0 by this push:
     new 1d06983a94  [To rel/1.0] Update doc on DataRegion using RatisConsensus (#8308)
1d06983a94 is described below

commit 1d06983a94067017cf602462a2de4c88328b8f3c
Author: William Song <48...@users.noreply.github.com>
AuthorDate: Fri Dec 2 19:02:42 2022 +0800

     [To rel/1.0] Update doc on DataRegion using RatisConsensus (#8308)
---
 docs/UserGuide/Cluster/Cluster-Concept.md    |  3 ++-
 docs/UserGuide/Cluster/Cluster-Setup.md      | 12 ++++++------
 docs/zh/UserGuide/Cluster/Cluster-Concept.md |  2 +-
 docs/zh/UserGuide/Cluster/Cluster-Setup.md   | 12 ++++++------
 4 files changed, 15 insertions(+), 14 deletions(-)

diff --git a/docs/UserGuide/Cluster/Cluster-Concept.md b/docs/UserGuide/Cluster/Cluster-Concept.md
index 8c4a19fa0a..f69aee3bcd 100644
--- a/docs/UserGuide/Cluster/Cluster-Concept.md
+++ b/docs/UserGuide/Cluster/Cluster-Concept.md
@@ -109,4 +109,5 @@ Among multiple Regions of each RegionGroup, consistency is guaranteed through a
 * Current supported consensus protocol
   * SimpleConsensus:Provide strong consistency, could only be used when replica is 1, which is the empty implementation of the consensus protocol.
   * IoTConsensus:Provide eventual consistency, could be used in any number of replicas, 2 replicas could avoid single point failure, only for DataRegion, writings can be applied on each replica and replicated asynchronously to other replicas.
-  * RatisConsensus:Provide Strong consistency, using raft consensus protocol, Could be used in any number of replicas, and could be used for any region groups。
+  * RatisConsensus:Provide Strong consistency, using raft consensus protocol, Could be used in any number of replicas, and could be used for any region groups. 
+  Currently, DataRegion uses RatisConsensus does not support multiple data directories. This feature is planned to be supported in future releases.
diff --git a/docs/UserGuide/Cluster/Cluster-Setup.md b/docs/UserGuide/Cluster/Cluster-Setup.md
index 8fa585935a..eee14a281f 100644
--- a/docs/UserGuide/Cluster/Cluster-Setup.md
+++ b/docs/UserGuide/Cluster/Cluster-Setup.md
@@ -98,12 +98,12 @@ iotdb-confignode.properties:
 
 iotdb-common.properties:
 
-| **Configuration**                          | **Description**                                                                                      |
-|--------------------------------------------|------------------------------------------------------------------------------------------------------|
-| data\_replication\_factor                  | Data replication factor, no more than DataNode number                                                |
-| data\_region\_consensus\_protocol\_class   | Consensus protocol of data replicas                                                                  |
-| schema\_replication\_factor                | Schema replication factor, no more than DataNode number                                              |
-| schema\_region\_consensus\_protocol\_class | Consensus protocol of schema replicas                                                                |
+| **Configuration**                          | **Description**                                                                                                    |
+|--------------------------------------------|--------------------------------------------------------------------------------------------------------------------|
+| data\_replication\_factor                  | Data replication factor, no more than DataNode number                                                              |
+| data\_region\_consensus\_protocol\_class   | Consensus protocol of data replicas. Note that RatisConsensus currently does not support multiple data directories |
+| schema\_replication\_factor                | Schema replication factor, no more than DataNode number                                                            |
+| schema\_region\_consensus\_protocol\_class | Consensus protocol of schema replicas                                                                              |
 
 Start on Linux:
 ```
diff --git a/docs/zh/UserGuide/Cluster/Cluster-Concept.md b/docs/zh/UserGuide/Cluster/Cluster-Concept.md
index 238e471915..d0f63aa2c8 100644
--- a/docs/zh/UserGuide/Cluster/Cluster-Concept.md
+++ b/docs/zh/UserGuide/Cluster/Cluster-Concept.md
@@ -111,4 +111,4 @@ Region 是数据复制的基本单位,一个 Region 的多个副本构成了
 * 现有的共识协议
     * SimpleConsensus:提供强一致性,仅单副本时可用,一致性协议的极简实现,效率最高。
     * IoTConsensus:提供最终一致性,任意副本数可用,2 副本时可容忍 1 节点失效,当前仅可用于 DataRegion 的副本上,写入可以在任一副本进行,并异步复制到其他副本。
-    * RatisConsensus:提供强一致性,Raft 协议的一种实现,任意副本数可用,当前可用于任意副本组上。
+    * RatisConsensus:提供强一致性,Raft 协议的一种实现,任意副本数可用,当前可用于任意副本组上。目前DataRegion使用RatisConsensus时暂不支持多数据目录,预计会在后续版本中支持这一功能。
diff --git a/docs/zh/UserGuide/Cluster/Cluster-Setup.md b/docs/zh/UserGuide/Cluster/Cluster-Setup.md
index cb78a58d0b..b70c9af982 100644
--- a/docs/zh/UserGuide/Cluster/Cluster-Setup.md
+++ b/docs/zh/UserGuide/Cluster/Cluster-Setup.md
@@ -97,12 +97,12 @@ iotdb-confignode.properties:
 
 iotdb-common.properties:
 
-| **配置项**                                    | **说明**                    |
-|--------------------------------------------|---------------------------|
-| data\_replication\_factor                  | 数据副本数,DataNode 数量不应少于此数目  |
-| data\_region\_consensus\_protocol\_class   | 数据副本组的共识协议                |
-| schema\_replication\_factor                | 元数据副本数,DataNode 数量不应少于此数目 |
-| schema\_region\_consensus\_protocol\_class | 元数据副本组的共识协议               |
+| **配置项**                                    | **说明**                                |
+|--------------------------------------------|---------------------------------------|
+| data\_replication\_factor                  | 数据副本数,DataNode 数量不应少于此数目              |
+| data\_region\_consensus\_protocol\_class   | 数据副本组的共识协议。注:RatisConsensus目前不支持多数据目录 |
+| schema\_replication\_factor                | 元数据副本数,DataNode 数量不应少于此数目             |
+| schema\_region\_consensus\_protocol\_class | 元数据副本组的共识协议                           |
 
 Linux 启动方式:
 ```