You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by ta...@apache.org on 2021/06/23 11:44:09 UTC
[iotdb] branch update_cluster_docs created (now 21837f4)
This is an automated email from the ASF dual-hosted git repository.
tanxinyu pushed a change to branch update_cluster_docs
in repository https://gitbox.apache.org/repos/asf/iotdb.git.
at 21837f4 update doc
This branch includes the following new commits:
new 21837f4 update doc
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[iotdb] 01/01: update doc
Posted by ta...@apache.org.
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 21837f4db7a3c3ad4101163d25c10d3d992c19fb
Author: LebronAl <TX...@gmail.com>
AuthorDate: Wed Jun 23 19:43:23 2021 +0800
update doc
---
docs/UserGuide/Cluster/Cluster-Setup-Example.md | 42 ++++++++++------------
docs/UserGuide/Cluster/Cluster-Setup.md | 6 +---
docs/zh/UserGuide/Cluster/Cluster-Setup-Example.md | 38 ++++++++++----------
docs/zh/UserGuide/Cluster/Cluster-Setup.md | 4 +--
4 files changed, 39 insertions(+), 51 deletions(-)
diff --git a/docs/UserGuide/Cluster/Cluster-Setup-Example.md b/docs/UserGuide/Cluster/Cluster-Setup-Example.md
index 58b0854..80072db 100644
--- a/docs/UserGuide/Cluster/Cluster-Setup-Example.md
+++ b/docs/UserGuide/Cluster/Cluster-Setup-Example.md
@@ -19,13 +19,26 @@
-->
-__NOTICE: CURRENT IoTDB CLUSTER IS FOR TESTING NOW!
-PLEASE BE DELIBERATE IF YOU RUN IT IN PRODUCT ENVIRONMENT.__
-
## 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
+## Example of distributed scaffolding for 3 nodes and 3 replicas
+
+Suppose we need to deploy the distributed IoTDB on three physical nodes, A, B, and C, whose public network IP is a_public_IP, b_public_IP, and c_public_IP, and private network IP is a_private_IP, b_private_IP, and c_private_IP.
+Note: If there is no public network IP or private network IP, both can be set to the same, just need to ensure that the client can access the server.
+
+The operation steps are as follows:
+
+1. Use 'mvn clean package -pl cluster -am -DskipTests' to compile the distributed module or directly go into the [website](https://iotdb.apache.org/Download/) to download the latest version.
+2. Make sure ports 6567, 6667, 9003, 9004, 40010, 40011 and 31999 are open on all three nodes.
+3. Send the package 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 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).
+
+## Example of distributed scaffolding for 1 node and 1 replica
### Compile from source code:
```
mvn clean package -DskipTests
@@ -42,7 +55,7 @@ sed -i -e 's/^default_replica_num=3$/default_replica_num=1/g' conf/iotdb-cluster
nohup ./sbin/start-node.sh >/dev/null 2>&1 &
```
-## Example of pseudo-distributed scaffolding for 3 nodes and 1 replica
+## Example of distributed scaffolding for 3 nodes and 1 replica on a single machine
### Compile from source code:
```
mvn clean package -DskipTests
@@ -52,21 +65,4 @@ nohup ./cluster/target/iotdb-cluster-0.13.0-SNAPSHOT/sbin/start-node.sh ./cluste
nohup ./cluster/target/iotdb-cluster-0.13.0-SNAPSHOT/sbin/start-node.sh ./cluster/target/test-classes/node3conf/ >/dev/null 2>&1 &
```
### Use the official website release version:
-You can refer to the following example, but starting multiple instances on a single machine requires handling port and data directory conflicts.
-
-## Example of distributed scaffolding for 3 nodes and 3 replicas
-
-Suppose we need to deploy the distributed IoTDB on three physical nodes, A, B, and C, whose public network IP is a_public_IP, b_public_IP, and c_public_IP, and private network IP is a_private_IP, b_private_IP, and c_private_IP.
-Note: If there is no public network IP or private network IP, both can be set to the same, just need to ensure that the client can access the server.
-
-The operation steps are as follows:
-
-
-1. Use 'mvn clean package -pl cluster -am -DskipTests' to compile the distributed module or directly go into the [website](https://iotdb.apache.org/Download/) to download the latest version.
-2. Make sure ports 6567, 6667, 9003, 9004, 40010, 40011 and 31999 are open on all three nodes.
-3. Send the package 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 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
+You can refer to the above example, but starting multiple instances on a single machine requires handling port and file directory conflicts.
\ No newline at end of file
diff --git a/docs/UserGuide/Cluster/Cluster-Setup.md b/docs/UserGuide/Cluster/Cluster-Setup.md
index 8a0e49c..ad00072 100644
--- a/docs/UserGuide/Cluster/Cluster-Setup.md
+++ b/docs/UserGuide/Cluster/Cluster-Setup.md
@@ -19,14 +19,10 @@
-->
-__NOTICE: CURRENT IoTDB CLUSTER IS FOR TESTING NOW!
-PLEASE BE DELIBERATE IF YOU RUN IT IN PRODUCT ENVIRONMENT.__
-
# Cluster Setup
For installation prerequisites, please refer to [QuickStart](../QuickStart/QuickStart.md)
## 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.
+You can deploy a distributed cluster on multiple nodes or on a single machine, the main difference being that the latter needs to handle conflicts between ports and file directories.
For detail descriptions, please refer to [Cluster Configuration Items](#Cluster Configuration Items).
To start the service of one of the nodes, you need to execute the following commands:
diff --git a/docs/zh/UserGuide/Cluster/Cluster-Setup-Example.md b/docs/zh/UserGuide/Cluster/Cluster-Setup-Example.md
index 680a6d6..60696b6 100644
--- a/docs/zh/UserGuide/Cluster/Cluster-Setup-Example.md
+++ b/docs/zh/UserGuide/Cluster/Cluster-Setup-Example.md
@@ -19,12 +19,25 @@
-->
-__集群模式目前是测试版！请谨慎在生产环境中使用。__
-
## 前提条件
如果您在使用Windows系统，请安装MinGW，WSL或者git bash。
-## 1节点1副本伪分布式搭建示例
+## 3节点3副本分布式搭建示例
+
+假设我们需要在三个物理节点上部署分布式 IoTDB，这三个节点分别为 A, B 和 C，其公网 ip 分别为 A_public_ip，B_public_ip 和 C_public_ip，私网 ip 分别为 A_private_ip，B_private_ip 和 C_private_ip。
+注：如果没有公网 ip 或者私网 ip 则两者设置成一致即可, 只需要保证客户端能够访问到服务端即可。
+
+以下为操作步骤：
+1. 使用 `mvn clean package -pl cluster -am -DskipTests` 编译分布式模块或直接到 [官网](https://iotdb.apache.org/Download/) 下载最新版本。
+2. 保证三个节点的 6567, 6667, 9003, 9004, 40010, 40011 和 31999 端口是开放的。
+3. 将包上传到所有的服务器上。
+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-cluster.properties 配置文件中的 default_replica_num 为 3。
+7. 配置所有节点 conf/iotdb-engine.properties 配置文件中的 rpc_address 为各自节点的 public_ip。
+8. 在 3 个节点上分别运行 sh sbin/start-node.sh 即可(后台运行也可)。
+
+## 1节点1副本分布式搭建示例
### 源码编译：
```
mvn clean package -DskipTests
@@ -41,7 +54,7 @@ sed -i -e 's/^default_replica_num=3$/default_replica_num=1/g' conf/iotdb-cluster
nohup ./sbin/start-node.sh >/dev/null 2>&1 &
```
-## 3节点1副本伪分布式搭建示例
+## 单机部署3节点1副本示例
### 源码编译：
```
mvn clean package -DskipTests
@@ -51,19 +64,4 @@ nohup ./cluster/target/iotdb-cluster-0.13.0-SNAPSHOT/sbin/start-node.sh ./cluste
nohup ./cluster/target/iotdb-cluster-0.13.0-SNAPSHOT/sbin/start-node.sh ./cluster/target/test-classes/node3conf/ >/dev/null 2>&1 &
```
### 使用官网发布版本：
-可以参考以下示例，不过在一台机器上启动多个实例时需要处理好端口和数据目录的冲突。
-
-## 3节点3副本分布式搭建示例
-
-假设我们需要在三个物理节点上部署分布式 IoTDB，这三个节点分别为 A, B 和 C，其公网 ip 分别为 A_public_ip，B_public_ip 和 C_public_ip，私网 ip 分别为 A_private_ip，B_private_ip 和 C_private_ip。
-注：如果没有公网 ip 或者私网 ip 则两者设置成一致即可, 只需要保证客户端能够访问到服务端即可。
-
-以下为操作步骤：
-1. 使用 `mvn clean package -pl cluster -am -DskipTests` 编译分布式模块或直接到 [官网](https://iotdb.apache.org/Download/) 下载最新版本。
-2. 保证三个节点的 6567, 6667, 9003, 9004, 40010, 40011 和 31999 端口是开放的。
-3. 将包上传到所有的服务器上。
-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-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
+可以参考以上示例，不过在单机启动多个实例时需要处理好端口和文件目录的冲突。
\ 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 2e60a39..8bc396f 100644
--- a/docs/zh/UserGuide/Cluster/Cluster-Setup.md
+++ b/docs/zh/UserGuide/Cluster/Cluster-Setup.md
@@ -19,12 +19,10 @@
-->
-__集群模式目前是测试版！请谨慎在生产环境中使用。__
-
# 集群设置
安装环境请参考[快速上手/安装环境章节](../QuickStart/QuickStart.md)
## 集群环境搭建
-您可以搭建伪分布式模式或是分布式模式的集群，伪分布式模式和分布式模式的主要区别是配置文件中`seed_nodes`的不同，配置项含义请参考[配置项](#配置项)。
+您可以多节点部署或单机部署分布式集群，两者的主要区别是后者需要处理端口和文件目录的冲突，配置项含义请参考[配置项](#配置项)。
启动其中一个节点的服务，需要执行如下命令：
```bash