This is an automated email from the ASF dual-hosted git repository. tanxinyu pushed a commit to branch update_cluster_docs in repository https://gitbox.apache.org/repos/asf/iotdb.git
commit 36f4ece4832cebdf2be78748e43c869d05a89691 Author: LebronAl <[email protected]> AuthorDate: Thu May 20 11:07:01 2021 +0800 update cluster docs --- docs/UserGuide/Cluster/Cluster-Setup-Example.md | 19 +++++++++++++++---- docs/UserGuide/Cluster/Cluster-Setup.md | 2 -- docs/zh/UserGuide/Cluster/Cluster-Setup-Example.md | 21 ++++++++++++++++----- docs/zh/UserGuide/Cluster/Cluster-Setup.md | 2 -- 4 files changed, 31 insertions(+), 13 deletions(-) diff --git a/docs/UserGuide/Cluster/Cluster-Setup-Example.md b/docs/UserGuide/Cluster/Cluster-Setup-Example.md index d3c2613..db2d76a 100644 --- a/docs/UserGuide/Cluster/Cluster-Setup-Example.md +++ b/docs/UserGuide/Cluster/Cluster-Setup-Example.md @@ -22,7 +22,17 @@ __NOTICE: CURRENT IoTDB CLUSTER IS FOR TESTING NOW! PLEASE BE DELIBERATE IF YOU RUN IT IN PRODUCT ENVIRONMENT.__ -## Example of pseudo-distributed scaffolding for 3 nodes and 3 replicas +## Prerequisite +Note: Please install MinGW or WSL or git bash if you are using Windows. + +## Example of pseudo-distributed scaffolding for 1 node and 1 replica +``` +mvn clean package -DskipTests +chmod -R 777 ./cluster/target/ +nohup ./cluster/target/iotdb-cluster-0.13.0-SNAPSHOT/sbin/start-node.sh >/dev/null 2>&1 & +``` + +## Example of pseudo-distributed scaffolding for 3 nodes and 1 replica ``` mvn clean package -DskipTests chmod -R 777 ./cluster/target/ @@ -38,10 +48,11 @@ Note: If there is no public network IP or private network IP, both can be set to The operation steps are as follows: -1. Make sure ports 6667, 9003, 9004, 40010, 40011 and 31999 are open on all three nodes. +1. Make sure ports 6567, 6667, 9003, 9004, 40010, 40011 and 31999 are open on all three nodes. 2. Use 'mvn clean package -pl cluster -am -DskipTests' to compile the distributed module. 3. Send the generated package (iotdb-cluster-0.13.0-SNAPSHOT) to all servers. 4. Configure all nodes' seed_nodes in conf/iotdb-cluster.properties as "A_private_ip:9003,B_private_ip:9003,C_private_ip:9003" 5. Configure the internal_ip in conf/iotdb-cluster.properties to be the private_ip of each node. -6. Configure rpc_address in conf/iotdb-engine.properties to be the public_ip of each node. -7. Run sh sbin/start-node.sh on each of the three nodes (or run in the background). \ No newline at end of file +6. Configure the default_replica_num in conf/iotdb-cluster.properties to be 3. +7. Configure rpc_address in conf/iotdb-engine.properties to be the public_ip of each node. +8. Run sh sbin/start-node.sh on each of the three nodes (or run in the background). \ No newline at end of file diff --git a/docs/UserGuide/Cluster/Cluster-Setup.md b/docs/UserGuide/Cluster/Cluster-Setup.md index 85dfccc..8a0e49c 100644 --- a/docs/UserGuide/Cluster/Cluster-Setup.md +++ b/docs/UserGuide/Cluster/Cluster-Setup.md @@ -24,8 +24,6 @@ PLEASE BE DELIBERATE IF YOU RUN IT IN PRODUCT ENVIRONMENT.__ # Cluster Setup For installation prerequisites, please refer to [QuickStart](../QuickStart/QuickStart.md) -## Prerequisite -Note: Please install MinGW or WSL or git bash if you are using Windows. ## Start Service Users can build clusters in pseudo-distributed mode or distributed mode. The main difference between pseudo-distributed mode and distributed mode is the difference in `seed_nodes` in the configuration file. diff --git a/docs/zh/UserGuide/Cluster/Cluster-Setup-Example.md b/docs/zh/UserGuide/Cluster/Cluster-Setup-Example.md index 5f6a6c1..f163d27 100644 --- a/docs/zh/UserGuide/Cluster/Cluster-Setup-Example.md +++ b/docs/zh/UserGuide/Cluster/Cluster-Setup-Example.md @@ -21,7 +21,17 @@ __集群模式目前是测试版！请谨慎在生产环境中使用。__ -## 3节点3副本伪分布式搭建示例 +## 前提条件 +如果您在使用Windows系统，请安装MinGW，WSL或者git bash。 + +## 1节点1副本伪分布式搭建示例 +``` +mvn clean package -DskipTests +chmod -R 777 ./cluster/target/ +nohup ./cluster/target/iotdb-cluster-0.13.0-SNAPSHOT/sbin/start-node.sh >/dev/null 2>&1 & +``` + +## 3节点1副本伪分布式搭建示例 ``` mvn clean package -DskipTests chmod -R 777 ./cluster/target/ @@ -37,10 +47,11 @@ nohup ./cluster/target/iotdb-cluster-0.13.0-SNAPSHOT/sbin/start-node.sh ./cluste 以下为操作步骤： -1. 保证三个节点的 6667, 9003, 9004, 40010, 40011 和 31999 端口是开放的。 +1. 保证三个节点的 6567, 6667, 9003, 9004, 40010, 40011 和 31999 端口是开放的。 2. 使用 `mvn clean package -pl cluster -am -DskipTests` 编译分布式模块。 -3. 将打出来的包(iotdb-cluster-0.13.0-SNAPSHOT)传到所有的服务器上。 +3. 将打出来的包(iotdb-cluster-0.13.0-SNAPSHOT)上传到所有的服务器上。 4. 配置所有节点 conf/iotdb-cluster.properties 配置文件中的 seed_nodes 为 "A_private_ip:9003,B_private_ip:9003,C_private_ip:9003" 5. 配置所有节点 conf/iotdb-cluster.properties 配置文件中的 internal_ip 为各自节点的 private_ip。 -6. 配置所有节点 conf/iotdb-engine.properties 配置文件中的 rpc_address 为各自节点的 public_ip。 -7. 在 3 个节点上分别运行 sh sbin/start-node.sh 即可(后台运行也可)。 \ No newline at end of file +6. 配置所有节点 conf/iotdb-cluster.properties 配置文件中的 default_replica_num 为 3。 +7. 配置所有节点 conf/iotdb-engine.properties 配置文件中的 rpc_address 为各自节点的 public_ip。 +8. 在 3 个节点上分别运行 sh sbin/start-node.sh 即可(后台运行也可)。 \ No newline at end of file diff --git a/docs/zh/UserGuide/Cluster/Cluster-Setup.md b/docs/zh/UserGuide/Cluster/Cluster-Setup.md index 420ee89..2e60a39 100644 --- a/docs/zh/UserGuide/Cluster/Cluster-Setup.md +++ b/docs/zh/UserGuide/Cluster/Cluster-Setup.md @@ -23,8 +23,6 @@ __集群模式目前是测试版！请谨慎在生产环境中使用。__ # 集群设置 安装环境请参考[快速上手/安装环境章节](../QuickStart/QuickStart.md) -## 前提条件 -如果您在使用Windows系统，请安装MinGW，WSL或者git bash。 ## 集群环境搭建 您可以搭建伪分布式模式或是分布式模式的集群，伪分布式模式和分布式模式的主要区别是配置文件中`seed_nodes`的不同，配置项含义请参考[配置项](#配置项)。 启动其中一个节点的服务，需要执行如下命令：
