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/12/10 14:18:41 UTC
[GitHub] [iotdb] jixuan1989 commented on a diff in pull request #8402: [IOTDB-5159] Refactor the structure of Cluster Deploy DOC
jixuan1989 commented on code in PR #8402:
URL: https://github.com/apache/iotdb/pull/8402#discussion_r1045088008
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -19,47 +19,51 @@
-->
-## Cluster Setup
-
+# 1. Purpose
This article is the setup process of IoTDB Cluster (1.0.0).
-## Environments
+# 2. Prerequisites
1. JDK>=1.8.
-
2. Max open file 65535.
-
3. Disable the swap memory.
+4. Ensure there are no data dir or the data dir is empty before the Node is started for the first time.
+5. Turn off the firewall of the server if the entire cluster is in a trusted environment.
Review Comment:
6. By default, IoTDB Cluster will use ports XXX, XXX for the configNode and XXX, XXX for the data node, please make sure those ports are not occupied or you will modify the ports in configuration files.
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -71,66 +75,53 @@ Then you will get the binary distribution under **distribution/target**, in whic
| sbin | Shell files folder, contains start/stop/remove shell of ConfigNode and DataNode, cli shell |
| tools | System tools |
-## Start the Cluster
-
-Users could start a cluster which contains multiple ConfigNode and DataNode.
-A cluster need at least one ConfigNode and no less than the number of data/schema_replication_factor DataNodes.
-
-The total process are three steps:
+# 5. Cluster Installation and Configuration
-* Start the first ConfigNode
-* Add ConfigNode (Optional)
-* Add DataNode
+## 5.1 Cluster Installation
-### Start the first ConfigNode
+Deploy apache-iotdb-1.0.0-SNAPSHOT-all-bin to the specified directory on the server or VM
+to complete cluster installation on a server or VM.
+Each apache-iotdb-1.0.0-SNAPSHOT-all-bin can start one ConfigNode and one DataNode.
-Please set the important parameters in conf/iotdb-confignode.properties and conf/iotdb-common.properties:
+## 5.2 Cluster Configuration
-iotdb-confignode.properties:
+Switch the working path to apache-iotdb-1.0.0-SNAPSHOT-all-bin.
+The cluster configuration files is stored in the ./conf directory.
-| **Configuration** | **Description** |
-|--------------------------------|----------------------------------------------------------------------------------------------|
-| cn\_internal\_address | Internal rpc service address of ConfigNode |
-| cn\_internal\_port | Internal rpc service port of ConfigNode |
-| cn\_consensus\_port | ConfigNode replication consensus protocol communication port |
-| cn\_target\_config\_node\_list | Target ConfigNode address, if the current ConfigNode is the first one, then set its own address:port |
+### 5.2.1 Common configuration
-iotdb-common.properties:
+Open the common configuration file ./conf/iotdb-common.properties,
+and set the following parameters base on the
+[Deployment Recommendation](https://iotdb.apache.org/UserGuide/Master/Cluster/Deployment-Recommendation.html):
| **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 |
+| config_node_consensus_protocol_class | Consensus protocol of ConfigNode |
| schema\_replication\_factor | Schema replication factor, no more than DataNode number |
| schema\_region\_consensus\_protocol\_class | Consensus protocol of schema replicas |
+| 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 |
-Start on Linux:
-```
-# Foreground
-bash ./sbin/start-confignode.sh
-
-# Background
-nohup bash ./sbin/start-confignode.sh >/dev/null 2>&1 &
-```
-
-Start on Windows:
-```
-sbin\start-confignode.bat
-```
-
-More details [ConfigNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/ConfigNode-Config-Manual.html).
+**Notice: The preceding configuration parameters cannot be changed after the cluster is started. Ensure that the common configurations of all Nodes are the same. Otherwise, the Nodes cannot be started.**
-### Add ConfigNode (Optional)
+### 5.2.2 ConfigNode configuration
-This will add the replication factor of ConfigNode, except for the ports that couldn't conflict with, 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.
+Open the ConfigNode configuration file ./conf/iotdb-confignode.properties,
+and set the following parameters based on the IP address and available port of the server or VM:
-The adding ConfigNode also use the start-confignode.sh/bat.
+| **Configuration** | **Description** |
Review Comment:
add the default value column
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -71,66 +75,53 @@ Then you will get the binary distribution under **distribution/target**, in whic
| sbin | Shell files folder, contains start/stop/remove shell of ConfigNode and DataNode, cli shell |
| tools | System tools |
-## Start the Cluster
-
-Users could start a cluster which contains multiple ConfigNode and DataNode.
-A cluster need at least one ConfigNode and no less than the number of data/schema_replication_factor DataNodes.
-
-The total process are three steps:
+# 5. Cluster Installation and Configuration
-* Start the first ConfigNode
-* Add ConfigNode (Optional)
-* Add DataNode
+## 5.1 Cluster Installation
-### Start the first ConfigNode
+Deploy apache-iotdb-1.0.0-SNAPSHOT-all-bin to the specified directory on the server or VM
+to complete cluster installation on a server or VM.
+Each apache-iotdb-1.0.0-SNAPSHOT-all-bin can start one ConfigNode and one DataNode.
-Please set the important parameters in conf/iotdb-confignode.properties and conf/iotdb-common.properties:
+## 5.2 Cluster Configuration
-iotdb-confignode.properties:
+Switch the working path to apache-iotdb-1.0.0-SNAPSHOT-all-bin.
+The cluster configuration files is stored in the ./conf directory.
-| **Configuration** | **Description** |
-|--------------------------------|----------------------------------------------------------------------------------------------|
-| cn\_internal\_address | Internal rpc service address of ConfigNode |
-| cn\_internal\_port | Internal rpc service port of ConfigNode |
-| cn\_consensus\_port | ConfigNode replication consensus protocol communication port |
-| cn\_target\_config\_node\_list | Target ConfigNode address, if the current ConfigNode is the first one, then set its own address:port |
+### 5.2.1 Common configuration
-iotdb-common.properties:
+Open the common configuration file ./conf/iotdb-common.properties,
+and set the following parameters base on the
+[Deployment Recommendation](https://iotdb.apache.org/UserGuide/Master/Cluster/Deployment-Recommendation.html):
| **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 |
+| config_node_consensus_protocol_class | Consensus protocol of ConfigNode |
| schema\_replication\_factor | Schema replication factor, no more than DataNode number |
| schema\_region\_consensus\_protocol\_class | Consensus protocol of schema replicas |
+| 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 |
-Start on Linux:
-```
-# Foreground
-bash ./sbin/start-confignode.sh
-
-# Background
-nohup bash ./sbin/start-confignode.sh >/dev/null 2>&1 &
-```
-
-Start on Windows:
-```
-sbin\start-confignode.bat
-```
-
-More details [ConfigNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/ConfigNode-Config-Manual.html).
+**Notice: The preceding configuration parameters cannot be changed after the cluster is started. Ensure that the common configurations of all Nodes are the same. Otherwise, the Nodes cannot be started.**
-### Add ConfigNode (Optional)
+### 5.2.2 ConfigNode configuration
-This will add the replication factor of ConfigNode, except for the ports that couldn't conflict with, 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.
+Open the ConfigNode configuration file ./conf/iotdb-confignode.properties,
+and set the following parameters based on the IP address and available port of the server or VM:
-The adding ConfigNode also use the start-confignode.sh/bat.
+| **Configuration** | **Description** |
+|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
+| cn\_internal\_address | Internal rpc service address of ConfigNode |
Review Comment:
add a column to descript how to set the value
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -71,66 +75,53 @@ Then you will get the binary distribution under **distribution/target**, in whic
| sbin | Shell files folder, contains start/stop/remove shell of ConfigNode and DataNode, cli shell |
| tools | System tools |
-## Start the Cluster
-
-Users could start a cluster which contains multiple ConfigNode and DataNode.
-A cluster need at least one ConfigNode and no less than the number of data/schema_replication_factor DataNodes.
-
-The total process are three steps:
+# 5. Cluster Installation and Configuration
-* Start the first ConfigNode
-* Add ConfigNode (Optional)
-* Add DataNode
+## 5.1 Cluster Installation
-### Start the first ConfigNode
+Deploy apache-iotdb-1.0.0-SNAPSHOT-all-bin to the specified directory on the server or VM
+to complete cluster installation on a server or VM.
+Each apache-iotdb-1.0.0-SNAPSHOT-all-bin can start one ConfigNode and one DataNode.
-Please set the important parameters in conf/iotdb-confignode.properties and conf/iotdb-common.properties:
+## 5.2 Cluster Configuration
-iotdb-confignode.properties:
+Switch the working path to apache-iotdb-1.0.0-SNAPSHOT-all-bin.
+The cluster configuration files is stored in the ./conf directory.
-| **Configuration** | **Description** |
-|--------------------------------|----------------------------------------------------------------------------------------------|
-| cn\_internal\_address | Internal rpc service address of ConfigNode |
-| cn\_internal\_port | Internal rpc service port of ConfigNode |
-| cn\_consensus\_port | ConfigNode replication consensus protocol communication port |
-| cn\_target\_config\_node\_list | Target ConfigNode address, if the current ConfigNode is the first one, then set its own address:port |
+### 5.2.1 Common configuration
-iotdb-common.properties:
+Open the common configuration file ./conf/iotdb-common.properties,
+and set the following parameters base on the
+[Deployment Recommendation](https://iotdb.apache.org/UserGuide/Master/Cluster/Deployment-Recommendation.html):
| **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 |
+| config_node_consensus_protocol_class | Consensus protocol of ConfigNode |
| schema\_replication\_factor | Schema replication factor, no more than DataNode number |
| schema\_region\_consensus\_protocol\_class | Consensus protocol of schema replicas |
+| 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 |
-Start on Linux:
-```
-# Foreground
-bash ./sbin/start-confignode.sh
-
-# Background
-nohup bash ./sbin/start-confignode.sh >/dev/null 2>&1 &
-```
-
-Start on Windows:
-```
-sbin\start-confignode.bat
-```
-
-More details [ConfigNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/ConfigNode-Config-Manual.html).
+**Notice: The preceding configuration parameters cannot be changed after the cluster is started. Ensure that the common configurations of all Nodes are the same. Otherwise, the Nodes cannot be started.**
-### Add ConfigNode (Optional)
+### 5.2.2 ConfigNode configuration
-This will add the replication factor of ConfigNode, except for the ports that couldn't conflict with, 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.
+Open the ConfigNode configuration file ./conf/iotdb-confignode.properties,
+and set the following parameters based on the IP address and available port of the server or VM:
-The adding ConfigNode also use the start-confignode.sh/bat.
+| **Configuration** | **Description** |
+|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
+| cn\_internal\_address | Internal rpc service address of ConfigNode |
+| cn\_internal\_port | Internal rpc service port of ConfigNode |
+| cn\_consensus\_port | ConfigNode replication consensus protocol communication port |
+| cn\_target\_config\_node\_list | ConfigNode address to which the node is connected when it is registered to the cluster. Note that Only one ConfigNode can be configured. |
-### Start DataNode
+**Notice: The preceding configuration parameters cannot be changed after the node is started. Ensure that all ports are not occupied. Otherwise, the Node cannot be started.**
-You could add any number of DataNode.
+### 5.2.3 DataNode configuration
-Please set the important parameters in iotdb-datanode.properties:
+Open the DataNode configuration file ./conf/iotdb-datanode.properties,
+and set the following parameters based on the IP address and available port of the server or VM:
| **Configuration** | **Description** |
|-------------------------------------|--------------------------------------------------|
Review Comment:
add the default value column
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -143,284 +134,212 @@ Please set the important parameters in iotdb-datanode.properties:
| dn\_schema\_region\_consensus\_port | Schema replicas communication port for consensus |
| dn\_target\_config\_node\_list | Running ConfigNode of the Cluster |
-Start on Linux:
-```
-# Foreground
-bash ./sbin/start-datanode.sh
+**Notice: The preceding configuration parameters cannot be changed after the node is started. Ensure that all ports are not occupied. Otherwise, the Node cannot be started.**
-# Background
-nohup bash ./sbin/start-datanode.sh >/dev/null 2>&1 &
-```
+# 6. Cluster Operation
-Start on Windows:
-```
-sbin\start-datanode.bat
-```
+## 6.1 Starting the cluster
-More details are in [DataNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/DataNode-Config-Manual.html).
+This section describes how to start a cluster that includes several ConfigNodes and DataNodes.
+The cluster can provide services only by starting at least one ConfigNode
+and no less than the number of data/schema_replication_factor DataNodes.
-### Stop IoTDB
-When you meet problem, and want to stop IoTDB ConfigNode and DataNode directly, our shells can help you do this.
+The total process are three steps:
-In Windows:
+* Start the Seed-ConfigNode
+* Add ConfigNode (Optional)
+* Add DataNode
-```
-sbin\stop-datanode.bat
-```
-```
-sbin\stop-confignode.bat
-```
-In Linux:
-```
-bash sbin/stop-datanode.sh
-```
-```
-bash sbin/stop-confignode.sh
-```
-Be careful not to miss the "sudo" label, because some port info's acquisition may require root authority. If you can't sudo, just
-use "jps" or "ps aux | grep iotdb" to get the process's id, then use "kill -9 <process-id>" to stop the process.
+### 6.1.1 Start the Seed-ConfigNode
-## Start StandAlone
-If you just want to setup your IoTDB locally,
-You can quickly init 1C1D (i.e. 1 Confignode and 1 Datanode) environment by our shells.
+The first ConfigNode to start is the Seed-ConfigNode, which marks the creation of the new cluster.
+Open the Seed-ConfigNode configuration file ./conf/iotdb-confignode.properties and set the following parameters:
-This will work well if you don't change our default settings.
+| **Configuration** | **Description** |
+|--------------------------------|----------------------------------------------------------------------------------------------------|
+| cn\_internal\_address | Internal rpc service address of ConfigNode |
+| cn\_internal\_port | Internal rpc service port of ConfigNode |
+| cn\_consensus\_port | ConfigNode replication consensus protocol communication port |
+| cn\_target\_config\_node\_list | Set it to its own internal communication address, that is cn\_internal\_address:cn\_internal\_port |
-Start on Windows:
-```
-sbin\start-standalone.bat
-```
-Start on Linux:
-```
-bash sbin/start-standalone.sh
+After the configuration is complete, run the startup script:
```
+# Linux foreground
+bash ./sbin/start-confignode.sh
-Besides, with our shell, you can also directly kill these processes.
+# Linux background
+nohup bash ./sbin/start-confignode.sh >/dev/null 2>&1 &
-Stop on Windows:
-```
-sbin\stop-standalone.bat
-```
-Stop on Linux:
-```
-bash sbin/stop-standalone.sh
+# Windows
+.\sbin\start-confignode.bat
```
-Note: On Linux, the 1C1D processes both launches in the background, and you can see the logs for details.
+For more details about other configuration parameters of ConfigNode, see the
+[ConfigNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/ConfigNode-Config-Manual.html).
-The stop-standalone.sh may not work well without sudo, since IoTDB's port numbers may be invisible without permission.
-If stop-standalone.sh meets some error, you can use "jps" or "ps aux | grep iotdb" to obtain the process ids,
-and use "sudo kill -9 <process-id>" to manually stop the processes.
+### 6.1.2 Add ConfigNode (Optional)
-## Start Cli
+You can add more ConfigNodes to the cluster to ensure high availability of ConfigNodes.
+Ensure that all configuration parameters in the ./conf/iotdb-common.properites are the same as those in the Seed-ConfigNode;
+otherwise, it may fail to start or generate runtime errors.
+Open the configuration file ./conf/iotdb-confignode.properties for the new ConfigNode and set the following parameters:
-Cli shell is in sbin folder.
+| **Configuration** | **Description** |
+|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| cn\_internal\_address | Internal rpc service address of ConfigNode |
+| cn\_internal\_port | Internal rpc service port of ConfigNode |
+| cn\_consensus\_port | ConfigNode replication consensus protocol communication port |
+| cn\_target\_config\_node\_list | Configure the internal communication address of an arbitrary running ConfigNode. The internal communication address of the seed ConfigNode is recommended. |
-Start on Linux:
-```
-./datanode/sbin/start-cli.sh
+After the configuration is complete, run the startup script:
```
+# Linux foreground
+bash ./sbin/start-confignode.sh
-Start on Windows:
-```
-datanode\sbin\start-cli.bat
+# Linux background
+nohup bash ./sbin/start-confignode.sh >/dev/null 2>&1 &
+
+# Windows
+.\sbin\start-confignode.bat
```
-## Shrink the Cluster
+For more details about other configuration parameters of ConfigNode, see the
+[ConfigNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/ConfigNode-Config-Manual.html).
-### Remove ConfigNode
+### 6.1.3 Start DataNode
-Execute the remove-confignode shell on an active ConfigNode, and make sure that there is at least one active ConfigNode in Cluster after removing.
+You can add any number of DataNodes to the cluster.
+Before adding a new DataNode,
+open the DataNode configuration file ./conf/iotdb-datanode.properties and configure the following parameters:
-Remove on Linux:
-```
-# Remove the ConfigNode with confignode_id
-./confignode/sbin/remove-confignode.sh <confignode_id>
+| **Configuration** | **Description** |
+|-------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| dn\_rpc\_address | Client RPC Service address |
+| dn\_rpc\_port | Client RPC Service port |
+| dn\_internal\_address | Control flow address of DataNode inside cluster |
+| dn\_internal\_port | Control flow port of DataNode inside cluster |
+| dn\_mpp\_data\_exchange\_port | Data flow port of DataNode inside cluster |
+| dn\_data\_region\_consensus\_port | Data replicas communication port for consensus |
+| dn\_schema\_region\_consensus\_port | Schema replicas communication port for consensus |
+| dn\_target\_config\_node\_list | Configure the internal communication address of an arbitrary running ConfigNode. The internal communication address of the seed ConfigNode is recommended. |
-# Remove the ConfigNode with address:port
-./confignode/sbin/remove-confignode.sh <internal_address>:<internal_port>
+After the configuration is complete, run the startup script:
```
+# Linux foreground
+bash ./sbin/start-datanode.sh
-Remove on Windows:
-```
-# Remove the ConfigNode with confignode_id
-confignode\sbin\remove-confignode.bat <confignode_id>
+# Linux background
+nohup bash ./sbin/start-datanode.sh >/dev/null 2>&1 &
-# Remove the ConfigNode with address:port
-confignode\sbin\remove-confignode.bat <internal_address>:<internal_port>
+# Windows
+.\sbin\start-datanode.bat
```
-### Remove DataNode
+For more details about other configuration parameters of DataNode, see the
+[DataNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/DataNode-Config-Manual.html).
Review Comment:
Add a chapter to check whether the cluster is deployed successfully.
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -71,66 +75,53 @@ Then you will get the binary distribution under **distribution/target**, in whic
| sbin | Shell files folder, contains start/stop/remove shell of ConfigNode and DataNode, cli shell |
| tools | System tools |
-## Start the Cluster
-
-Users could start a cluster which contains multiple ConfigNode and DataNode.
-A cluster need at least one ConfigNode and no less than the number of data/schema_replication_factor DataNodes.
-
-The total process are three steps:
+# 5. Cluster Installation and Configuration
-* Start the first ConfigNode
-* Add ConfigNode (Optional)
-* Add DataNode
+## 5.1 Cluster Installation
Review Comment:
Change this paragraph to:
`apache-iotdb-1.0.0-SNAPSHOT-all-bin` contains both the ConfigNode and the DataNode. Please deploy the files to all servers of your target cluster. A best practice is deploy the files into the same directory in all servers.
If you want to try the cluster mode on one server, please read XXXX.
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -71,66 +75,53 @@ Then you will get the binary distribution under **distribution/target**, in whic
| sbin | Shell files folder, contains start/stop/remove shell of ConfigNode and DataNode, cli shell |
| tools | System tools |
-## Start the Cluster
-
-Users could start a cluster which contains multiple ConfigNode and DataNode.
-A cluster need at least one ConfigNode and no less than the number of data/schema_replication_factor DataNodes.
-
-The total process are three steps:
+# 5. Cluster Installation and Configuration
-* Start the first ConfigNode
-* Add ConfigNode (Optional)
-* Add DataNode
+## 5.1 Cluster Installation
-### Start the first ConfigNode
+Deploy apache-iotdb-1.0.0-SNAPSHOT-all-bin to the specified directory on the server or VM
+to complete cluster installation on a server or VM.
+Each apache-iotdb-1.0.0-SNAPSHOT-all-bin can start one ConfigNode and one DataNode.
-Please set the important parameters in conf/iotdb-confignode.properties and conf/iotdb-common.properties:
+## 5.2 Cluster Configuration
Review Comment:
We need to modify the configurations on each server.
Therefore, login each server and switch the working directory to apache-iotdb-1.0.0-SNAPSHOT-all-bin.
The configruation files are stored in the `./conf` directory.
For all ConfigNode servers, we need to modify the common configuration (see Chap 5.2.1) and ConfigNode configuration (see Chap 5.2.2).
For all DataNode servers, we need to modify the common configuration (see Chap 5.2.1) and DataNode configuration (see Chap 5.2.3).
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -19,47 +19,51 @@
-->
-## Cluster Setup
-
+# 1. Purpose
This article is the setup process of IoTDB Cluster (1.0.0).
-## Environments
+# 2. Prerequisites
1. JDK>=1.8.
-
2. Max open file 65535.
-
3. Disable the swap memory.
+4. Ensure there are no data dir or the data dir is empty before the Node is started for the first time.
+5. Turn off the firewall of the server if the entire cluster is in a trusted environment.
-## Get the binary distribution
+# 3. Get the Installation Package
Review Comment:
You can either download the binary release files (see Chap 3.1) or compile with sour code (see Chap 3.2)
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -71,66 +75,53 @@ Then you will get the binary distribution under **distribution/target**, in whic
| sbin | Shell files folder, contains start/stop/remove shell of ConfigNode and DataNode, cli shell |
| tools | System tools |
-## Start the Cluster
-
-Users could start a cluster which contains multiple ConfigNode and DataNode.
-A cluster need at least one ConfigNode and no less than the number of data/schema_replication_factor DataNodes.
-
-The total process are three steps:
+# 5. Cluster Installation and Configuration
-* Start the first ConfigNode
-* Add ConfigNode (Optional)
-* Add DataNode
+## 5.1 Cluster Installation
-### Start the first ConfigNode
+Deploy apache-iotdb-1.0.0-SNAPSHOT-all-bin to the specified directory on the server or VM
+to complete cluster installation on a server or VM.
+Each apache-iotdb-1.0.0-SNAPSHOT-all-bin can start one ConfigNode and one DataNode.
-Please set the important parameters in conf/iotdb-confignode.properties and conf/iotdb-common.properties:
+## 5.2 Cluster Configuration
-iotdb-confignode.properties:
+Switch the working path to apache-iotdb-1.0.0-SNAPSHOT-all-bin.
+The cluster configuration files is stored in the ./conf directory.
-| **Configuration** | **Description** |
-|--------------------------------|----------------------------------------------------------------------------------------------|
-| cn\_internal\_address | Internal rpc service address of ConfigNode |
-| cn\_internal\_port | Internal rpc service port of ConfigNode |
-| cn\_consensus\_port | ConfigNode replication consensus protocol communication port |
-| cn\_target\_config\_node\_list | Target ConfigNode address, if the current ConfigNode is the first one, then set its own address:port |
+### 5.2.1 Common configuration
-iotdb-common.properties:
+Open the common configuration file ./conf/iotdb-common.properties,
+and set the following parameters base on the
+[Deployment Recommendation](https://iotdb.apache.org/UserGuide/Master/Cluster/Deployment-Recommendation.html):
| **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 |
+| config_node_consensus_protocol_class | Consensus protocol of ConfigNode |
| schema\_replication\_factor | Schema replication factor, no more than DataNode number |
| schema\_region\_consensus\_protocol\_class | Consensus protocol of schema replicas |
+| 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 |
-Start on Linux:
-```
-# Foreground
-bash ./sbin/start-confignode.sh
-
-# Background
-nohup bash ./sbin/start-confignode.sh >/dev/null 2>&1 &
-```
-
-Start on Windows:
-```
-sbin\start-confignode.bat
-```
-
-More details [ConfigNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/ConfigNode-Config-Manual.html).
+**Notice: The preceding configuration parameters cannot be changed after the cluster is started. Ensure that the common configurations of all Nodes are the same. Otherwise, the Nodes cannot be started.**
-### Add ConfigNode (Optional)
+### 5.2.2 ConfigNode configuration
-This will add the replication factor of ConfigNode, except for the ports that couldn't conflict with, 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.
+Open the ConfigNode configuration file ./conf/iotdb-confignode.properties,
+and set the following parameters based on the IP address and available port of the server or VM:
-The adding ConfigNode also use the start-confignode.sh/bat.
+| **Configuration** | **Description** |
+|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
+| cn\_internal\_address | Internal rpc service address of ConfigNode |
+| cn\_internal\_port | Internal rpc service port of ConfigNode |
+| cn\_consensus\_port | ConfigNode replication consensus protocol communication port |
+| cn\_target\_config\_node\_list | ConfigNode address to which the node is connected when it is registered to the cluster. Note that Only one ConfigNode can be configured. |
Review Comment:
point out that how to set this value, rather than claim it in chap 6.1.1
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -143,284 +134,212 @@ Please set the important parameters in iotdb-datanode.properties:
| dn\_schema\_region\_consensus\_port | Schema replicas communication port for consensus |
| dn\_target\_config\_node\_list | Running ConfigNode of the Cluster |
-Start on Linux:
-```
-# Foreground
-bash ./sbin/start-datanode.sh
+**Notice: The preceding configuration parameters cannot be changed after the node is started. Ensure that all ports are not occupied. Otherwise, the Node cannot be started.**
-# Background
-nohup bash ./sbin/start-datanode.sh >/dev/null 2>&1 &
-```
+# 6. Cluster Operation
-Start on Windows:
-```
-sbin\start-datanode.bat
-```
+## 6.1 Starting the cluster
-More details are in [DataNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/DataNode-Config-Manual.html).
+This section describes how to start a cluster that includes several ConfigNodes and DataNodes.
+The cluster can provide services only by starting at least one ConfigNode
+and no less than the number of data/schema_replication_factor DataNodes.
-### Stop IoTDB
-When you meet problem, and want to stop IoTDB ConfigNode and DataNode directly, our shells can help you do this.
+The total process are three steps:
-In Windows:
+* Start the Seed-ConfigNode
+* Add ConfigNode (Optional)
+* Add DataNode
-```
-sbin\stop-datanode.bat
-```
-```
-sbin\stop-confignode.bat
-```
-In Linux:
-```
-bash sbin/stop-datanode.sh
-```
-```
-bash sbin/stop-confignode.sh
-```
-Be careful not to miss the "sudo" label, because some port info's acquisition may require root authority. If you can't sudo, just
-use "jps" or "ps aux | grep iotdb" to get the process's id, then use "kill -9 <process-id>" to stop the process.
+### 6.1.1 Start the Seed-ConfigNode
-## Start StandAlone
-If you just want to setup your IoTDB locally,
-You can quickly init 1C1D (i.e. 1 Confignode and 1 Datanode) environment by our shells.
+The first ConfigNode to start is the Seed-ConfigNode, which marks the creation of the new cluster.
Review Comment:
before users reading this chapter, all the settings are done!
so remove current content and add:
Please make sure XXXXX is set correct in XXXXX. Suppose server A is set to the seed-configNode, then login server A and execute the following commands:
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -143,284 +134,212 @@ Please set the important parameters in iotdb-datanode.properties:
| dn\_schema\_region\_consensus\_port | Schema replicas communication port for consensus |
| dn\_target\_config\_node\_list | Running ConfigNode of the Cluster |
-Start on Linux:
-```
-# Foreground
-bash ./sbin/start-datanode.sh
+**Notice: The preceding configuration parameters cannot be changed after the node is started. Ensure that all ports are not occupied. Otherwise, the Node cannot be started.**
-# Background
-nohup bash ./sbin/start-datanode.sh >/dev/null 2>&1 &
-```
+# 6. Cluster Operation
-Start on Windows:
-```
-sbin\start-datanode.bat
-```
+## 6.1 Starting the cluster
-More details are in [DataNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/DataNode-Config-Manual.html).
+This section describes how to start a cluster that includes several ConfigNodes and DataNodes.
+The cluster can provide services only by starting at least one ConfigNode
+and no less than the number of data/schema_replication_factor DataNodes.
-### Stop IoTDB
-When you meet problem, and want to stop IoTDB ConfigNode and DataNode directly, our shells can help you do this.
+The total process are three steps:
-In Windows:
+* Start the Seed-ConfigNode
+* Add ConfigNode (Optional)
+* Add DataNode
-```
-sbin\stop-datanode.bat
-```
-```
-sbin\stop-confignode.bat
-```
-In Linux:
-```
-bash sbin/stop-datanode.sh
-```
-```
-bash sbin/stop-confignode.sh
-```
-Be careful not to miss the "sudo" label, because some port info's acquisition may require root authority. If you can't sudo, just
-use "jps" or "ps aux | grep iotdb" to get the process's id, then use "kill -9 <process-id>" to stop the process.
+### 6.1.1 Start the Seed-ConfigNode
-## Start StandAlone
-If you just want to setup your IoTDB locally,
-You can quickly init 1C1D (i.e. 1 Confignode and 1 Datanode) environment by our shells.
+The first ConfigNode to start is the Seed-ConfigNode, which marks the creation of the new cluster.
+Open the Seed-ConfigNode configuration file ./conf/iotdb-confignode.properties and set the following parameters:
-This will work well if you don't change our default settings.
+| **Configuration** | **Description** |
+|--------------------------------|----------------------------------------------------------------------------------------------------|
+| cn\_internal\_address | Internal rpc service address of ConfigNode |
+| cn\_internal\_port | Internal rpc service port of ConfigNode |
+| cn\_consensus\_port | ConfigNode replication consensus protocol communication port |
+| cn\_target\_config\_node\_list | Set it to its own internal communication address, that is cn\_internal\_address:cn\_internal\_port |
-Start on Windows:
-```
-sbin\start-standalone.bat
-```
-Start on Linux:
-```
-bash sbin/start-standalone.sh
+After the configuration is complete, run the startup script:
```
+# Linux foreground
+bash ./sbin/start-confignode.sh
-Besides, with our shell, you can also directly kill these processes.
+# Linux background
+nohup bash ./sbin/start-confignode.sh >/dev/null 2>&1 &
-Stop on Windows:
-```
-sbin\stop-standalone.bat
-```
-Stop on Linux:
-```
-bash sbin/stop-standalone.sh
+# Windows
+.\sbin\start-confignode.bat
```
-Note: On Linux, the 1C1D processes both launches in the background, and you can see the logs for details.
+For more details about other configuration parameters of ConfigNode, see the
+[ConfigNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/ConfigNode-Config-Manual.html).
-The stop-standalone.sh may not work well without sudo, since IoTDB's port numbers may be invisible without permission.
-If stop-standalone.sh meets some error, you can use "jps" or "ps aux | grep iotdb" to obtain the process ids,
-and use "sudo kill -9 <process-id>" to manually stop the processes.
+### 6.1.2 Add ConfigNode (Optional)
-## Start Cli
+You can add more ConfigNodes to the cluster to ensure high availability of ConfigNodes.
+Ensure that all configuration parameters in the ./conf/iotdb-common.properites are the same as those in the Seed-ConfigNode;
+otherwise, it may fail to start or generate runtime errors.
+Open the configuration file ./conf/iotdb-confignode.properties for the new ConfigNode and set the following parameters:
-Cli shell is in sbin folder.
+| **Configuration** | **Description** |
+|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| cn\_internal\_address | Internal rpc service address of ConfigNode |
+| cn\_internal\_port | Internal rpc service port of ConfigNode |
+| cn\_consensus\_port | ConfigNode replication consensus protocol communication port |
+| cn\_target\_config\_node\_list | Configure the internal communication address of an arbitrary running ConfigNode. The internal communication address of the seed ConfigNode is recommended. |
-Start on Linux:
-```
-./datanode/sbin/start-cli.sh
+After the configuration is complete, run the startup script:
```
+# Linux foreground
+bash ./sbin/start-confignode.sh
-Start on Windows:
-```
-datanode\sbin\start-cli.bat
+# Linux background
+nohup bash ./sbin/start-confignode.sh >/dev/null 2>&1 &
+
+# Windows
+.\sbin\start-confignode.bat
```
-## Shrink the Cluster
+For more details about other configuration parameters of ConfigNode, see the
+[ConfigNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/ConfigNode-Config-Manual.html).
-### Remove ConfigNode
+### 6.1.3 Start DataNode
-Execute the remove-confignode shell on an active ConfigNode, and make sure that there is at least one active ConfigNode in Cluster after removing.
+You can add any number of DataNodes to the cluster.
Review Comment:
any number? not less than the number of replica?
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -143,284 +134,212 @@ Please set the important parameters in iotdb-datanode.properties:
| dn\_schema\_region\_consensus\_port | Schema replicas communication port for consensus |
| dn\_target\_config\_node\_list | Running ConfigNode of the Cluster |
-Start on Linux:
-```
-# Foreground
-bash ./sbin/start-datanode.sh
+**Notice: The preceding configuration parameters cannot be changed after the node is started. Ensure that all ports are not occupied. Otherwise, the Node cannot be started.**
-# Background
-nohup bash ./sbin/start-datanode.sh >/dev/null 2>&1 &
-```
+# 6. Cluster Operation
-Start on Windows:
-```
-sbin\start-datanode.bat
-```
+## 6.1 Starting the cluster
-More details are in [DataNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/DataNode-Config-Manual.html).
+This section describes how to start a cluster that includes several ConfigNodes and DataNodes.
+The cluster can provide services only by starting at least one ConfigNode
+and no less than the number of data/schema_replication_factor DataNodes.
-### Stop IoTDB
-When you meet problem, and want to stop IoTDB ConfigNode and DataNode directly, our shells can help you do this.
+The total process are three steps:
-In Windows:
+* Start the Seed-ConfigNode
+* Add ConfigNode (Optional)
+* Add DataNode
-```
-sbin\stop-datanode.bat
-```
-```
-sbin\stop-confignode.bat
-```
-In Linux:
-```
-bash sbin/stop-datanode.sh
-```
-```
-bash sbin/stop-confignode.sh
-```
-Be careful not to miss the "sudo" label, because some port info's acquisition may require root authority. If you can't sudo, just
-use "jps" or "ps aux | grep iotdb" to get the process's id, then use "kill -9 <process-id>" to stop the process.
+### 6.1.1 Start the Seed-ConfigNode
-## Start StandAlone
-If you just want to setup your IoTDB locally,
-You can quickly init 1C1D (i.e. 1 Confignode and 1 Datanode) environment by our shells.
+The first ConfigNode to start is the Seed-ConfigNode, which marks the creation of the new cluster.
+Open the Seed-ConfigNode configuration file ./conf/iotdb-confignode.properties and set the following parameters:
-This will work well if you don't change our default settings.
+| **Configuration** | **Description** |
+|--------------------------------|----------------------------------------------------------------------------------------------------|
+| cn\_internal\_address | Internal rpc service address of ConfigNode |
+| cn\_internal\_port | Internal rpc service port of ConfigNode |
+| cn\_consensus\_port | ConfigNode replication consensus protocol communication port |
+| cn\_target\_config\_node\_list | Set it to its own internal communication address, that is cn\_internal\_address:cn\_internal\_port |
-Start on Windows:
-```
-sbin\start-standalone.bat
-```
-Start on Linux:
-```
-bash sbin/start-standalone.sh
+After the configuration is complete, run the startup script:
```
+# Linux foreground
+bash ./sbin/start-confignode.sh
-Besides, with our shell, you can also directly kill these processes.
+# Linux background
+nohup bash ./sbin/start-confignode.sh >/dev/null 2>&1 &
-Stop on Windows:
-```
-sbin\stop-standalone.bat
-```
-Stop on Linux:
-```
-bash sbin/stop-standalone.sh
+# Windows
+.\sbin\start-confignode.bat
```
-Note: On Linux, the 1C1D processes both launches in the background, and you can see the logs for details.
+For more details about other configuration parameters of ConfigNode, see the
+[ConfigNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/ConfigNode-Config-Manual.html).
-The stop-standalone.sh may not work well without sudo, since IoTDB's port numbers may be invisible without permission.
-If stop-standalone.sh meets some error, you can use "jps" or "ps aux | grep iotdb" to obtain the process ids,
-and use "sudo kill -9 <process-id>" to manually stop the processes.
+### 6.1.2 Add ConfigNode (Optional)
-## Start Cli
+You can add more ConfigNodes to the cluster to ensure high availability of ConfigNodes.
+Ensure that all configuration parameters in the ./conf/iotdb-common.properites are the same as those in the Seed-ConfigNode;
+otherwise, it may fail to start or generate runtime errors.
+Open the configuration file ./conf/iotdb-confignode.properties for the new ConfigNode and set the following parameters:
-Cli shell is in sbin folder.
+| **Configuration** | **Description** |
+|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| cn\_internal\_address | Internal rpc service address of ConfigNode |
+| cn\_internal\_port | Internal rpc service port of ConfigNode |
+| cn\_consensus\_port | ConfigNode replication consensus protocol communication port |
+| cn\_target\_config\_node\_list | Configure the internal communication address of an arbitrary running ConfigNode. The internal communication address of the seed ConfigNode is recommended. |
-Start on Linux:
-```
-./datanode/sbin/start-cli.sh
+After the configuration is complete, run the startup script:
```
+# Linux foreground
+bash ./sbin/start-confignode.sh
-Start on Windows:
-```
-datanode\sbin\start-cli.bat
+# Linux background
+nohup bash ./sbin/start-confignode.sh >/dev/null 2>&1 &
+
+# Windows
+.\sbin\start-confignode.bat
```
-## Shrink the Cluster
+For more details about other configuration parameters of ConfigNode, see the
+[ConfigNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/ConfigNode-Config-Manual.html).
-### Remove ConfigNode
+### 6.1.3 Start DataNode
-Execute the remove-confignode shell on an active ConfigNode, and make sure that there is at least one active ConfigNode in Cluster after removing.
+You can add any number of DataNodes to the cluster.
+Before adding a new DataNode,
Review Comment:
The same issue. All settings are done!
You just need to remind users please read Chap 5.2.3 if he/she has not modify the configuration.
##########
docs/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -143,284 +134,212 @@ Please set the important parameters in iotdb-datanode.properties:
| dn\_schema\_region\_consensus\_port | Schema replicas communication port for consensus |
| dn\_target\_config\_node\_list | Running ConfigNode of the Cluster |
-Start on Linux:
-```
-# Foreground
-bash ./sbin/start-datanode.sh
+**Notice: The preceding configuration parameters cannot be changed after the node is started. Ensure that all ports are not occupied. Otherwise, the Node cannot be started.**
-# Background
-nohup bash ./sbin/start-datanode.sh >/dev/null 2>&1 &
-```
+# 6. Cluster Operation
-Start on Windows:
-```
-sbin\start-datanode.bat
-```
+## 6.1 Starting the cluster
-More details are in [DataNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/DataNode-Config-Manual.html).
+This section describes how to start a cluster that includes several ConfigNodes and DataNodes.
+The cluster can provide services only by starting at least one ConfigNode
+and no less than the number of data/schema_replication_factor DataNodes.
-### Stop IoTDB
-When you meet problem, and want to stop IoTDB ConfigNode and DataNode directly, our shells can help you do this.
+The total process are three steps:
-In Windows:
+* Start the Seed-ConfigNode
+* Add ConfigNode (Optional)
+* Add DataNode
-```
-sbin\stop-datanode.bat
-```
-```
-sbin\stop-confignode.bat
-```
-In Linux:
-```
-bash sbin/stop-datanode.sh
-```
-```
-bash sbin/stop-confignode.sh
-```
-Be careful not to miss the "sudo" label, because some port info's acquisition may require root authority. If you can't sudo, just
-use "jps" or "ps aux | grep iotdb" to get the process's id, then use "kill -9 <process-id>" to stop the process.
+### 6.1.1 Start the Seed-ConfigNode
-## Start StandAlone
-If you just want to setup your IoTDB locally,
-You can quickly init 1C1D (i.e. 1 Confignode and 1 Datanode) environment by our shells.
+The first ConfigNode to start is the Seed-ConfigNode, which marks the creation of the new cluster.
+Open the Seed-ConfigNode configuration file ./conf/iotdb-confignode.properties and set the following parameters:
-This will work well if you don't change our default settings.
+| **Configuration** | **Description** |
+|--------------------------------|----------------------------------------------------------------------------------------------------|
+| cn\_internal\_address | Internal rpc service address of ConfigNode |
+| cn\_internal\_port | Internal rpc service port of ConfigNode |
+| cn\_consensus\_port | ConfigNode replication consensus protocol communication port |
+| cn\_target\_config\_node\_list | Set it to its own internal communication address, that is cn\_internal\_address:cn\_internal\_port |
-Start on Windows:
-```
-sbin\start-standalone.bat
-```
-Start on Linux:
-```
-bash sbin/start-standalone.sh
+After the configuration is complete, run the startup script:
```
+# Linux foreground
+bash ./sbin/start-confignode.sh
-Besides, with our shell, you can also directly kill these processes.
+# Linux background
+nohup bash ./sbin/start-confignode.sh >/dev/null 2>&1 &
-Stop on Windows:
-```
-sbin\stop-standalone.bat
-```
-Stop on Linux:
-```
-bash sbin/stop-standalone.sh
+# Windows
+.\sbin\start-confignode.bat
```
-Note: On Linux, the 1C1D processes both launches in the background, and you can see the logs for details.
+For more details about other configuration parameters of ConfigNode, see the
+[ConfigNode Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/ConfigNode-Config-Manual.html).
-The stop-standalone.sh may not work well without sudo, since IoTDB's port numbers may be invisible without permission.
-If stop-standalone.sh meets some error, you can use "jps" or "ps aux | grep iotdb" to obtain the process ids,
-and use "sudo kill -9 <process-id>" to manually stop the processes.
+### 6.1.2 Add ConfigNode (Optional)
-## Start Cli
+You can add more ConfigNodes to the cluster to ensure high availability of ConfigNodes.
Review Comment:
Question: If a user initially wants to deploy 3 confignodes, can all the 3 nodes are seed-confignodes? or the other 2 nodes must be deployed by "Add ConfigNode"??
--
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