You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@iotdb.apache.org by GitBox <gi...@apache.org> on 2022/11/23 02:36:08 UTC
[GitHub] [iotdb] Beyyes commented on a diff in pull request #8091: [IOTDB-5012] Update Deployment and User doc for cluster V1.0
Beyyes commented on code in PR #8091:
URL: https://github.com/apache/iotdb/pull/8091#discussion_r1029949290
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -168,33 +176,45 @@ datanode\sbin\start-cli.bat
### Remove ConfigNode
-Execute the remove-confignode shell on an active ConfigNode.
+Execute the remove-confignode shell on an active ConfigNode, and make sure that there is at least one active ConfigNode in Cluster after removing.
Remove on Linux:
```
+# Remove the ConfigNode with confignode_id
./confignode/sbin/remove-confignode.sh <confignode_id>
+
+# Remove the ConfigNode with address:port
./confignode/sbin/remove-confignode.sh <internal_address>:<internal_port>
```
Remove on Windows:
```
+# Remove the ConfigNode with confignode_id
confignode\sbin\remove-confignode.bat <confignode_id>
+
+# Remove the ConfigNode with address:port
confignode\sbin\remove-confignode.bat <internal_address>:<internal_port>
```
### Remove DataNode
-Execute the remove-datanode shell on an active DataNode.
+Execute the remove-datanode shell on an active , and make sure that there are no less than the number of data/schema_replication_factor DataNodes in Cluster after removing.
Review Comment:
```suggestion
Execute the remove-datanode shell on an active, and make sure that there are no less than the number of data/schema_replication_factor DataNodes in Cluster after removing.
```
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -168,33 +176,45 @@ datanode\sbin\start-cli.bat
### Remove ConfigNode
-Execute the remove-confignode shell on an active ConfigNode.
+Execute the remove-confignode shell on an active ConfigNode, and make sure that there is at least one active ConfigNode in Cluster after removing.
Remove on Linux:
```
+# Remove the ConfigNode with confignode_id
./confignode/sbin/remove-confignode.sh <confignode_id>
+
+# Remove the ConfigNode with address:port
./confignode/sbin/remove-confignode.sh <internal_address>:<internal_port>
```
Remove on Windows:
```
+# Remove the ConfigNode with confignode_id
confignode\sbin\remove-confignode.bat <confignode_id>
+
+# Remove the ConfigNode with address:port
confignode\sbin\remove-confignode.bat <internal_address>:<internal_port>
```
### Remove DataNode
-Execute the remove-datanode shell on an active DataNode.
+Execute the remove-datanode shell on an active , and make sure that there are no less than the number of data/schema_replication_factor DataNodes in Cluster after removing.
Remove on Linux:
```
+# Remove the DataNode with datanode_id
./datanode/sbin/remove-datanode.sh <datanode_id>
+
+# Remove the DataNode with internal address:port
Review Comment:
```suggestion
# Remove the DataNode with rpc address:port
```
##########
docs/zh/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -82,123 +85,140 @@ mvn clean package -pl distribution -am -DskipTests
### 启动种子 ConfigNode
-对 confignode/conf/iotdb-confignode.properties 中的重要参数进行配置：
+ConfigNode 的 RPC 相关参数在 conf/iotdb-confignode.properties 中进行配置：
-| **配置项** | **说明** |
-|--------------------------------------------|----------------------------------------------------|
-| internal\_address | ConfigNode 在集群内部通讯使用的地址 |
-| internal\_port | ConfigNode 在集群内部通讯使用的端口 |
-| consensus\_port | ConfigNode 副本组共识协议通信使用的端口 |
-| target\_config\_nodes | 种子 ConfigNode 地址，第一个 ConfigNode 配置自己的 address:port |
-| data\_replication\_factor | 数据副本数，DataNode 数量不应少于此数目 |
-| data\_region\_consensus\_protocol\_class | 数据副本组的共识协议 |
-| schema\_replication\_factor | 元数据副本数，DataNode 数量不应少于此数目 |
-| schema\_region\_consensus\_protocol\_class | 元数据副本组的共识协议 |
+| **配置项** | **说明** |
+|-------------------------------------------|----------------------------------------------------|
+| cn\_internal\_address | ConfigNode 在集群内部通讯使用的地址 |
+| cn\_internal\_port | ConfigNode 在集群内部通讯使用的端口 |
+| cn\_consensus\_port | ConfigNode 副本组共识协议通信使用的端口 |
+| cn\_target\_config\_node\_list | 种子 ConfigNode 地址，第一个 ConfigNode 配置自己的 address:port |
+
+ConfigNode 的副本相关参数在 conf/iotdb-common.properties 中进行配置：
+
+| **配置项** | **说明** |
+|--------------------------------------------|---------------------------|
+| data\_replication\_factor | 数据副本数，DataNode 数量不应少于此数目 |
+| data\_region\_consensus\_protocol\_class | 数据副本组的共识协议 |
+| schema\_replication\_factor | 元数据副本数，DataNode 数量不应少于此数目 |
+| schema\_region\_consensus\_protocol\_class | 元数据副本组的共识协议 |
Linux 启动方式：
```
# 前台启动
-./confignode/sbin/start-confignode.sh
+./sbin/start-confignode.sh
# 后台启动
-nohup ./confignode/sbin/start-confignode.sh >/dev/null 2>&1 &
+nohup ./sbin/start-confignode.sh >/dev/null 2>&1 &
```
Windows 启动方式：
```
-confignode\sbin\start-confignode.bat
+sbin\start-confignode.bat
```
具体参考 [ConfigNode配置参数](https://iotdb.apache.org/zh/UserGuide/Master/Reference/ConfigNode-Config-Manual.html)
### 增加 ConfigNode（可选）
-增加 ConfigNode 是一个扩容操作，除 IP 和端口不能冲突外，上述其它重要参数需要与集群已有的 ConfigNode 保持一致，并将 target\_config\_nodes 配置为集群活跃的 ConfigNode。
+增加 ConfigNode 是一个扩容操作，除 IP 和端口不能冲突外，上述其它重要参数需要与集群已有的 ConfigNode 保持一致，并将 cn\_target\_config\_nodes\_list 配置为集群活跃的 ConfigNode。
启动方式同上。
### 增加 DataNode
-可以向集群中添加任意个 DataNode。
+可以向集群中添加 不小于（数据/元数据）副本个数 的 DataNode。
Review Comment:
should be `任意个数`?
##########
docs/UserGuide/Cluster/Cluster-Concept.md:
##########
@@ -35,6 +35,21 @@ DataNode stores the data and schema of cluster, which manages multiple data regi
Client could only connect to the DataNode for operation.
+### Concepts
+
+| Concept | Type | Description |
+|:------------------|:---------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------|
+| ConfigNode | role | Configuration node, which manages cluster node information and partition information, monitors cluster status, controls load balancing |
Review Comment:
```suggestion
| ConfigNode | node role | Configuration node, which manages cluster node information and partition information, monitors cluster status, controls load balancing |
```
##########
docs/UserGuide/Cluster/Cluster-Concept.md:
##########
@@ -35,6 +35,21 @@ DataNode stores the data and schema of cluster, which manages multiple data regi
Client could only connect to the DataNode for operation.
+### Concepts
+
+| Concept | Type | Description |
+|:------------------|:---------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------|
+| ConfigNode | role | Configuration node, which manages cluster node information and partition information, monitors cluster status, controls load balancing |
+| DataNode | role | Data node, which manages data and meta data |
Review Comment:
```suggestion
| DataNode | node role | Data node, which manages data and meta data |
```
##########
docs/zh/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -240,67 +260,67 @@ It costs 0.160s
### 4. 准备扩容环境
-解压 apache-iotdb-0.14.0-preview1-all-bin.zip 至 cluster1 目录和 cluster2 目录
+解压 apache-iotdb-1.0.0-all-bin.zip 至 cluster1 目录和 cluster2 目录
### 5. 修改节点配置文件
对于 cluster1 目录：
-+ 修改 ConfigNode 地址：
++ 修改 ConfigNode 配置：
-| **配置项** | **值** |
-|-----------------------|---------------|
-| internal\_address | 0.0.0.0 |
-| internal\_port | 22279 |
-| consensus\_port | 22280 |
-| target\_config\_nodes | 0.0.0.0:22277 |
+| **配置项** | **值** |
+|--------------------------------|---------------|
+| cn\_internal\_address | 0.0.0.0 |
+| cn\_internal\_port | 22279 |
+| cn\_consensus\_port | 22280 |
+| cn\_target\_config\_node\_list | 0.0.0.0:22277 |
-+ 修改 DataNode 地址：
++ 修改 DataNode 配置：
-| **配置项** | **值** |
-|---------------------------------|-----------------|
-| rpc\_address | 0.0.0.0 |
-| rpc\_port | 6668 |
-| internal\_address | 127.0.0.1 |
-| internal\_port | 9004 |
-| mpp\_data\_exchange\_port | 8778 |
-| data\_region\_consensus\_port | 40011 |
-| schema\_region\_consensus\_port | 50011 |
-| target\_config\_nodes | 127.0.0.1:22277 |
+| **配置项** | **值** |
+|-------------------------------------|-----------------|
+| dn\_rpc\_address | 0.0.0.0 |
+| dn\_rpc\_port | 6668 |
+| dn\_internal\_address | 127.0.0.1 |
+| dn\_internal\_port | 9004 |
+| dn\_mpp\_data\_exchange\_port | 8778 |
+| dn\_data\_region\_consensus\_port | 40011 |
+| dn\_schema\_region\_consensus\_port | 50011 |
+| dn\_target\_config\_node\_list | 127.0.0.1:22277 |
对于 cluster2 目录：
-+ 修改 ConfigNode 地址：
++ 修改 ConfigNode 配置：
-| **配置项** | **值** |
-|-----------------------|---------------|
-| internal\_address | 0.0.0.0 |
-| internal\_port | 22281 |
-| consensus\_port | 22282 |
-| target\_config\_nodes | 0.0.0.0:22277 |
+| **配置项** | **值** |
+|--------------------------------|---------------|
+| cn\_internal\_address | 0.0.0.0 |
+| cn\_internal\_port | 22281 |
+| cn\_consensus\_port | 22282 |
+| cn\_target\_config\_node\_list | 0.0.0.0:22277 |
-+ 修改 DataNode 地址：
++ 修改 DataNode 配置：
-| **配置项** | **值** |
-|---------------------------------|-----------------|
-| rpc\_address | 0.0.0.0 |
-| rpc\_port | 6669 |
-| internal\_address | 127.0.0.1 |
-| internal\_port | 9005 |
-| mpp\_data\_exchange\_port | 8779 |
-| data\_region\_consensus\_port | 40012 |
-| schema\_region\_consensus\_port | 50012 |
-| target\_config\_nodes | 127.0.0.1:22277 |
+| **配置项** | **值** |
+|-------------------------------------|-----------------|
+| dn\_rpc\_address | 0.0.0.0 |
+| dn\_rpc\_port | 6669 |
+| dn\_internal\_address | 127.0.0.1 |
+| dn\_internal\_port | 9005 |
+| dn\_mpp\_data\_exchange\_port | 8779 |
+| dn\_data\_region\_consensus\_port | 40012 |
+| dn\_schema\_region\_consensus\_port | 50012 |
+| dn\_target\_config\_node\_list | 127.0.0.1:22277 |
### 6. 集群扩容
将集群扩容至 3 个 ConfigNode 和 3 个 DataNode（3C3D）集群版，
指令执行顺序可不分先后：
Review Comment:
start confignode firstly
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -82,77 +85,82 @@ The total process are three steps:
### Start the first ConfigNode
-Please set the important parameters in iotdb-confignode.properties:
+Please set parameters about RPC in conf/iotdb-confignode.properties:
| **Configuration** | **Description** |
|--------------------------------------------|----------------------------------------------------------------------------------------------|
-| internal\_address | Internal rpc service address of ConfigNode |
-| internal\_port | Internal rpc service address of ConfigNode |
-| consensus\_port | ConfigNode replication consensus protocol communication port |
-| target\_config\_nodes | Target ConfigNode address, if the current is the first ConfigNode, then set its address:port |
-| 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 |
+| cn\_internal\_address | Internal rpc service address of ConfigNode |
+| cn\_internal\_port | Internal rpc service address of ConfigNode |
Review Comment:
```suggestion
| cn\_internal\_port | Internal rpc service port of ConfigNode |
```
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -82,77 +85,82 @@ The total process are three steps:
### Start the first ConfigNode
-Please set the important parameters in iotdb-confignode.properties:
+Please set parameters about RPC in conf/iotdb-confignode.properties:
| **Configuration** | **Description** |
|--------------------------------------------|----------------------------------------------------------------------------------------------|
-| internal\_address | Internal rpc service address of ConfigNode |
-| internal\_port | Internal rpc service address of ConfigNode |
-| consensus\_port | ConfigNode replication consensus protocol communication port |
-| target\_config\_nodes | Target ConfigNode address, if the current is the first ConfigNode, then set its address:port |
-| 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 |
+| cn\_internal\_address | Internal rpc service address of ConfigNode |
+| cn\_internal\_port | Internal rpc service address of ConfigNode |
+| cn\_consensus\_port | ConfigNode replication consensus protocol communication port |
+| cn\_target\_config\_node\_list | Target ConfigNode address, if the current is the first ConfigNode, then set its address:port |
+
+Please set parameters about replication in conf/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 |
Start on Linux:
```
# Foreground
-./confignode/sbin/start-confignode.sh
+./sbin/start-confignode.sh
# Background
-nohup ./confignode/sbin/start-confignode.sh >/dev/null 2>&1 &
+nohup ./sbin/start-confignode.sh >/dev/null 2>&1 &
```
Start on Windows:
```
-confignode\sbin\start-confignode.bat
+sbin\start-confignode.bat
```
More details [ConfigNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/ConfigNode-Config-Manual.html).
### Add ConfigNode (Optional)
-This will add the replication factor of ConfigNode, except for the port couldn't conflict, make sure other configurations are the same with existing ConfigNode in Cluster.
+This will add the replication factor of ConfigNode, except for the port couldn't conflict, make sure other configurations are the same with existing ConfigNode in Cluster, and set parameter cn\_target\_config\_nodes\_list as an active ConfigNode in Cluster.
Review Comment:
what's the meaning of `except for the port couldn't conflict`
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -82,77 +85,82 @@ The total process are three steps:
### Start the first ConfigNode
-Please set the important parameters in iotdb-confignode.properties:
+Please set parameters about RPC in conf/iotdb-confignode.properties:
Review Comment:
not only `RPC`
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -82,77 +85,82 @@ The total process are three steps:
### Start the first ConfigNode
-Please set the important parameters in iotdb-confignode.properties:
+Please set parameters about RPC in conf/iotdb-confignode.properties:
| **Configuration** | **Description** |
|--------------------------------------------|----------------------------------------------------------------------------------------------|
-| internal\_address | Internal rpc service address of ConfigNode |
-| internal\_port | Internal rpc service address of ConfigNode |
-| consensus\_port | ConfigNode replication consensus protocol communication port |
-| target\_config\_nodes | Target ConfigNode address, if the current is the first ConfigNode, then set its address:port |
-| 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 |
+| cn\_internal\_address | Internal rpc service address of ConfigNode |
+| cn\_internal\_port | Internal rpc service address of ConfigNode |
+| cn\_consensus\_port | ConfigNode replication consensus protocol communication port |
+| cn\_target\_config\_node\_list | Target ConfigNode address, if the current is the first ConfigNode, then set its address:port |
+
+Please set parameters about replication in conf/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 |
Start on Linux:
```
# Foreground
-./confignode/sbin/start-confignode.sh
+./sbin/start-confignode.sh
# Background
-nohup ./confignode/sbin/start-confignode.sh >/dev/null 2>&1 &
+nohup ./sbin/start-confignode.sh >/dev/null 2>&1 &
```
Start on Windows:
```
-confignode\sbin\start-confignode.bat
+sbin\start-confignode.bat
```
More details [ConfigNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/ConfigNode-Config-Manual.html).
### Add ConfigNode (Optional)
-This will add the replication factor of ConfigNode, except for the port couldn't conflict, make sure other configurations are the same with existing ConfigNode in Cluster.
+This will add the replication factor of ConfigNode, except for the port couldn't conflict, make sure other configurations are the same with existing ConfigNode in Cluster, and set parameter cn\_target\_config\_nodes\_list as an active ConfigNode in Cluster.
The adding ConfigNode also use the start-confignode.sh/bat.
### Start DataNode
-You could add any number of DataNode.
+You could add no less than the number of data/schema_replication_factor DataNode.
Review Comment:
any
##########
docs/zh/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -82,123 +85,140 @@ mvn clean package -pl distribution -am -DskipTests
### 启动种子 ConfigNode
-对 confignode/conf/iotdb-confignode.properties 中的重要参数进行配置：
+ConfigNode 的 RPC 相关参数在 conf/iotdb-confignode.properties 中进行配置：
Review Comment:
not only `RPC 相关参数`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@iotdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org