This is an automated email from the ASF dual-hosted git repository.
xiaoyekanren pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iotdb-docs.git
The following commit(s) were added to refs/heads/main by this push:
new c68df2af add example and description to start-all (#1146)
c68df2af is described below
commit c68df2afd3c261fecb1742315538bb1b402671e9
Author: leto-b <[email protected]>
AuthorDate: Thu Jun 4 11:39:08 2026 +0800
add example and description to start-all (#1146)
---
.../Cluster-Deployment_apache.md | 64 ++++++++++++++----
.../Cluster-Deployment_timecho.md | 66 ++++++++++++++----
.../Cluster-Deployment_apache.md | 66 ++++++++++++++----
.../Cluster-Deployment_timecho.md | 78 ++++++++++++++++------
.../Cluster-Deployment_apache.md | 64 ++++++++++++++----
.../Cluster-Deployment_timecho.md | 66 ++++++++++++++----
.../Cluster-Deployment_apache.md | 66 ++++++++++++++----
.../Cluster-Deployment_timecho.md | 78 ++++++++++++++++------
.../Cluster-Deployment_apache.md | 45 +++++++++++--
.../Cluster-Deployment_timecho.md | 45 +++++++++++--
.../Cluster-Deployment_apache.md | 63 +++++++++++++----
.../Cluster-Deployment_timecho.md | 45 +++++++++++--
.../Cluster-Deployment_apache.md | 45 +++++++++++--
.../Cluster-Deployment_timecho.md | 45 +++++++++++--
.../Cluster-Deployment_apache.md | 63 +++++++++++++----
.../Cluster-Deployment_timecho.md | 45 +++++++++++--
16 files changed, 768 insertions(+), 176 deletions(-)
diff --git
a/src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md
b/src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md
index 90c591dc..5f2a502d 100644
---
a/src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md
+++
b/src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md
@@ -226,21 +226,21 @@ This following section will introduce the specific
configuration items in the `i
* confignode\_address\_list
-| **Name** | **confignode\_address\_list**
|
-| :----------------: |
:---------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | A list of IP addresses of the hosts where the ConfigNodes
to be started/stopped are located. If there are multiple, they should be
separated by commas. |
-| Type | String
|
-| Default | None
|
-| Effective | After restarting the system
|
+| **Name** | **confignode\_address\_list**
|
+| :----------------:
|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Description | A list of IP addresses or hostname of the hosts where the
ConfigNodes to be started/stopped are located. If there are multiple, they
should be separated by commas. |
+| Type | String
|
+| Default | None
|
+| Effective | After restarting the system
|
* datanode\_address\_list
-| **Name** | **datanode\_address\_list**
|
-| :----------------: |
:-------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | A list of IP addresses of the hosts where the DataNodes to
be started/stopped are located. If there are multiple, they should be separated
by commas. |
-| Type | String
|
-| Default | None
|
-| Effective | After restarting the system
|
+| **Name** | **datanode\_address\_list**
|
+| :----------------:
|:------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Description | A list of IP addresses or hostname of the hosts where the
DataNodes to be started/stopped are located. If there are multiple, they should
be separated by commas. |
+| Type | String
|
+| Default | None
|
+| Effective | After restarting the system
|
* ssh\_account
@@ -264,7 +264,7 @@ This following section will introduce the specific
configuration items in the `i
| **Name** | **confignode\_deploy\_path**
|
| :----------------: |
:----------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | The path on the target hosts where all ConfigNodes to be
started/stopped are located. All ConfigNodes must be in the same directory on
their respective hosts. |
+| Description | The path on the target hosts where all ConfigNodes to be
started/stopped are located. All ConfigNodes must be in the same directory on
their respective hosts. eg: `/data/demo/apache-iotdb-1.3.1-all-bin`|
| Type | String
|
| Default | None
|
| Effective | After restarting the system
|
@@ -273,11 +273,47 @@ This following section will introduce the specific
configuration items in the `i
| **Name** | **datanode\_deploy\_path**
|
| :----------------: |
:------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | The path on the target hosts where all DataNodes to be
started/stopped are located. All DataNodes must be in the same directory on
their respective hosts. |
+| Description | The path on the target hosts where all DataNodes to be
started/stopped are located. All DataNodes must be in the same directory on
their respective hosts. eg: `/data/demo/apache-iotdb-1.3.1-all-bin`|
| Type | String
|
| Default | None
|
| Effective | After restarting the system
|
+#### 3.7.3 Quick Example
+
+1. Configuration File: `iotdb-cluster.properties`
+```properties
+# Configure ConfigNode node addresses, separated by commas
+confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# Configure DataNode node addresses, separated by commas
+datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# SSH login username for target deployment servers
+ssh_account=root
+
+# SSH service port number
+ssh_port=22
+
+# IoTDB installation directory (the program will be deployed into this path on
remote nodes)
+confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+```
+
+2. Run `./start-all.sh` to launch cluster and verify status
+ Connect to IoTDB CLI and execute `show cluster`. A successful output is
shown below:
+```SQL
+IoTDB> show cluster
++------+----------+-------+---------------+------------+--------------+-----------+
+|NodeID| NodeType| Status|InternalAddress|InternalPort| Version|
BuildInfo|
++------+----------+-------+---------------+------------+--------------+-----------+
+| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1|
0xxxxxx|
+| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1|
0xxxxxx|
+| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1|
0xxxxxx|
+| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1|
0xxxxxx|
+| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1|
0xxxxxx|
+| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1|
0xxxxxx|
++------+----------+-------+---------------+------------+--------------+-----------+
+```
## 4. Maintenance
diff --git
a/src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
b/src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
index e195d2c6..753975e1 100644
---
a/src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
+++
b/src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
@@ -303,21 +303,21 @@ This following section will introduce the specific
configuration items in the `i
* confignode\_address\_list
-| **Name** | **confignode\_address\_list**
|
-| :----------------: |
:---------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | A list of IP addresses of the hosts where the ConfigNodes
to be started/stopped are located. If there are multiple, they should be
separated by commas. |
-| Type | String
|
-| Default | None
|
-| Effective | After restarting the system
|
+| **Name** | **confignode\_address\_list**
|
+| :----------------:
|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Description | A list of IP addresses or hostname of the hosts where the
ConfigNodes to be started/stopped are located. If there are multiple, they
should be separated by commas. |
+| Type | String
|
+| Default | None
|
+| Effective | After restarting the system
|
* datanode\_address\_list
-| **Name** | **datanode\_address\_list**
|
-| :----------------: |
:-------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | A list of IP addresses of the hosts where the DataNodes to
be started/stopped are located. If there are multiple, they should be separated
by commas. |
-| Type | String
|
-| Default | None
|
-| Effective | After restarting the system
|
+| **Name** | **datanode\_address\_list**
|
+| :----------------:
|:------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Description | A list of IP addresses or hostname of the hosts where the
DataNodes to be started/stopped are located. If there are multiple, they should
be separated by commas. |
+| Type | String
|
+| Default | None
|
+| Effective | After restarting the system
|
* ssh\_account
@@ -341,7 +341,7 @@ This following section will introduce the specific
configuration items in the `i
| **Name** | **confignode\_deploy\_path**
|
| :----------------: |
:----------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | The path on the target hosts where all ConfigNodes to be
started/stopped are located. All ConfigNodes must be in the same directory on
their respective hosts. |
+| Description | The path on the target hosts where all ConfigNodes to be
started/stopped are located. All ConfigNodes must be in the same directory on
their respective hosts. eg: `/data/demo/apache-iotdb-1.3.1-all-bin`|
| Type | String
|
| Default | None
|
| Effective | After restarting the system
|
@@ -350,12 +350,50 @@ This following section will introduce the specific
configuration items in the `i
| **Name** | **datanode\_deploy\_path**
|
| :----------------: |
:------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | The path on the target hosts where all DataNodes to be
started/stopped are located. All DataNodes must be in the same directory on
their respective hosts. |
+| Description | The path on the target hosts where all DataNodes to be
started/stopped are located. All DataNodes must be in the same directory on
their respective hosts.eg: `/data/demo/apache-iotdb-1.3.1-all-bin` |
| Type | String
|
| Default | None
|
| Effective | After restarting the system
|
+#### 3.8.3 Quick Example
+
+1. Configuration File: `iotdb-cluster.properties`
+```properties
+# Configure ConfigNode node addresses, separated by commas
+confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# Configure DataNode node addresses, separated by commas
+datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# SSH login username for target deployment servers
+ssh_account=root
+
+# SSH service port number
+ssh_port=22
+
+# IoTDB installation directory (the program will be deployed into this path on
remote nodes)
+confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+```
+
+2. Run `./start-all.sh` to launch cluster and verify status
+ Connect to IoTDB CLI and execute `show cluster`. A successful output is
shown below:
+```SQL
+IoTDB> show cluster
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+|NodeID| NodeType| Status|InternalAddress|InternalPort| Version|
BuildInfo| ActivateStatus|
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
+| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
+| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+```
+
+
## 4. Maintenance
### 4.1 ConfigNode Maintenance
diff --git
a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_apache.md
b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_apache.md
index c0aec00f..be763199 100644
---
a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_apache.md
+++
b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_apache.md
@@ -225,21 +225,21 @@ This following section will introduce the specific
configuration items in the `i
* confignode\_address\_list
-| **Name** | **confignode\_address\_list**
|
-| :----------------: |
:---------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | A list of IP addresses of the hosts where the ConfigNodes
to be started/stopped are located. If there are multiple, they should be
separated by commas. |
-| Type | String
|
-| Default | None
|
-| Effective | After restarting the system
|
+| **Name** | **confignode\_address\_list**
|
+| :----------------:
|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Description | A list of IP addresses or hostname of the hosts where the
ConfigNodes to be started/stopped are located. If there are multiple, they
should be separated by commas. |
+| Type | String
|
+| Default | None
|
+| Effective | After restarting the system
|
* datanode\_address\_list
-| **Name** | **datanode\_address\_list**
|
-| :----------------: |
:-------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | A list of IP addresses of the hosts where the DataNodes to
be started/stopped are located. If there are multiple, they should be separated
by commas. |
-| Type | String
|
-| Default | None
|
-| Effective | After restarting the system
|
+| **Name** | **datanode\_address\_list**
|
+| :----------------:
|:------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Description | A list of IP addresses or hostname of the hosts where the
DataNodes to be started/stopped are located. If there are multiple, they should
be separated by commas. |
+| Type | String
|
+| Default | None
|
+| Effective | After restarting the system
|
* ssh\_account
@@ -263,7 +263,7 @@ This following section will introduce the specific
configuration items in the `i
| **Name** | **confignode\_deploy\_path**
|
| :----------------: |
:----------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | The path on the target hosts where all ConfigNodes to be
started/stopped are located. All ConfigNodes must be in the same directory on
their respective hosts. |
+| Description | The path on the target hosts where all ConfigNodes to be
started/stopped are located. All ConfigNodes must be in the same directory on
their respective hosts. eg: `/data/demo/apache-iotdb-1.3.1-all-bin`|
| Type | String
|
| Default | None
|
| Effective | After restarting the system
|
@@ -272,12 +272,50 @@ This following section will introduce the specific
configuration items in the `i
| **Name** | **datanode\_deploy\_path**
|
| :----------------: |
:------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | The path on the target hosts where all DataNodes to be
started/stopped are located. All DataNodes must be in the same directory on
their respective hosts. |
+| Description | The path on the target hosts where all DataNodes to be
started/stopped are located. All DataNodes must be in the same directory on
their respective hosts. eg: `/data/demo/apache-iotdb-1.3.1-all-bin`|
| Type | String
|
| Default | None
|
| Effective | After restarting the system
|
+#### 3.6.3 Quick Example
+
+1. Configuration File: `iotdb-cluster.properties`
+```properties
+# Configure ConfigNode node addresses, separated by commas
+confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# Configure DataNode node addresses, separated by commas
+datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# SSH login username for target deployment servers
+ssh_account=root
+
+# SSH service port number
+ssh_port=22
+
+# IoTDB installation directory (the program will be deployed into this path on
remote nodes)
+confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+```
+
+2. Run `./start-all.sh` to launch cluster and verify status
+Connect to IoTDB CLI and execute `show cluster`. A successful output is shown
below:
+```SQL
+IoTDB> show cluster
++------+----------+-------+---------------+------------+--------------+-----------+
+|NodeID| NodeType| Status|InternalAddress|InternalPort| Version|
BuildInfo|
++------+----------+-------+---------------+------------+--------------+-----------+
+| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1|
0xxxxxx|
+| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1|
0xxxxxx|
+| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1|
0xxxxxx|
+| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1|
0xxxxxx|
+| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1|
0xxxxxx|
+| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1|
0xxxxxx|
++------+----------+-------+---------------+------------+--------------+-----------+
+```
+
+
## 4. Node Maintenance Steps
### 4.1 ConfigNode Node Maintenance
diff --git
a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
index 614fecaf..c25aea61 100644
---
a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
+++
b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
@@ -308,21 +308,21 @@ This following section will introduce the specific
configuration items in the `i
* confignode\_address\_list
-| **Name** | **confignode\_address\_list**
|
-| :----------------: |
:---------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | A list of IP addresses of the hosts where the ConfigNodes
to be started/stopped are located. If there are multiple, they should be
separated by commas. |
-| Type | String
|
-| Default | None
|
-| Effective | After restarting the system
|
+| **Name** | **confignode\_address\_list**
|
+| :----------------:
|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Description | A list of IP addresses or hostname of the hosts where the
ConfigNodes to be started/stopped are located. If there are multiple, they
should be separated by commas. |
+| Type | String
|
+| Default | None
|
+| Effective | After restarting the system
|
* datanode\_address\_list
-| **Name** | **datanode\_address\_list**
|
-| :----------------: |
:-------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | A list of IP addresses of the hosts where the DataNodes to
be started/stopped are located. If there are multiple, they should be separated
by commas. |
-| Type | String
|
-| Default | None
|
-| Effective | After restarting the system
|
+| **Name** | **datanode\_address\_list**
|
+| :----------------:
|:------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Description | A list of IP addresses or hostname of the hosts where the
DataNodes to be started/stopped are located. If there are multiple, they should
be separated by commas. |
+| Type | String
|
+| Default | None
|
+| Effective | After restarting the system
|
* ssh\_account
@@ -335,18 +335,18 @@ This following section will introduce the specific
configuration items in the `i
* ssh\_port
-| **Name** | **ssh\_port**
|
-| :----------------: |
:----------------------------------------------------------------------------------
|
-| Description | The SSH port exposed by the target hosts. All hosts must
have the same SSH port. |
-| Type | int
|
-| Default | 22
|
-| Effective | After restarting the system
|
+| **Name** | **ssh\_port**
|
+| :----------------:
|:--------------------------------------------------------------------------------------|
+| Description | The SSH port exposed by the target hosts. All hosts must
have the same SSH port. |
+| Type | int
|
+| Default | 22
|
+| Effective | After restarting the system
|
* confignode\_deploy\_path
| **Name** | **confignode\_deploy\_path**
|
| :----------------: |
:----------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | The path on the target hosts where all ConfigNodes to be
started/stopped are located. All ConfigNodes must be in the same directory on
their respective hosts. |
+| Description | The path on the target hosts where all ConfigNodes to be
started/stopped are located. All ConfigNodes must be in the same directory on
their respective hosts. eg: `/data/demo/apache-iotdb-1.3.1-all-bin`|
| Type | String
|
| Default | None
|
| Effective | After restarting the system
|
@@ -355,12 +355,50 @@ This following section will introduce the specific
configuration items in the `i
| **Name** | **datanode\_deploy\_path**
|
| :----------------: |
:------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | The path on the target hosts where all DataNodes to be
started/stopped are located. All DataNodes must be in the same directory on
their respective hosts. |
+| Description | The path on the target hosts where all DataNodes to be
started/stopped are located. All DataNodes must be in the same directory on
their respective hosts. eg: `/data/demo/apache-iotdb-1.3.1-all-bin`|
| Type | String
|
| Default | None
|
| Effective | After restarting the system
|
+#### 3.8.3 Quick Example
+
+1. Configuration File: `iotdb-cluster.properties`
+```properties
+# Configure ConfigNode node addresses, separated by commas
+confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# Configure DataNode node addresses, separated by commas
+datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# SSH login username for target deployment servers
+ssh_account=root
+
+# SSH service port number
+ssh_port=22
+
+# IoTDB installation directory (the program will be deployed into this path on
remote nodes)
+confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+```
+
+2. Run `./start-all.sh` to launch cluster and verify status
+ Connect to IoTDB CLI and execute `show cluster`. A successful output is
shown below:
+```SQL
+IoTDB> show cluster
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+|NodeID| NodeType| Status|InternalAddress|InternalPort| Version|
BuildInfo| ActivateStatus|
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
+| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
+| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+```
+
+
## 4. Maintenance
### 4.1 ConfigNode Maintenance
diff --git
a/src/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md
b/src/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md
index 90c591dc..5f2a502d 100644
---
a/src/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md
+++
b/src/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md
@@ -226,21 +226,21 @@ This following section will introduce the specific
configuration items in the `i
* confignode\_address\_list
-| **Name** | **confignode\_address\_list**
|
-| :----------------: |
:---------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | A list of IP addresses of the hosts where the ConfigNodes
to be started/stopped are located. If there are multiple, they should be
separated by commas. |
-| Type | String
|
-| Default | None
|
-| Effective | After restarting the system
|
+| **Name** | **confignode\_address\_list**
|
+| :----------------:
|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Description | A list of IP addresses or hostname of the hosts where the
ConfigNodes to be started/stopped are located. If there are multiple, they
should be separated by commas. |
+| Type | String
|
+| Default | None
|
+| Effective | After restarting the system
|
* datanode\_address\_list
-| **Name** | **datanode\_address\_list**
|
-| :----------------: |
:-------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | A list of IP addresses of the hosts where the DataNodes to
be started/stopped are located. If there are multiple, they should be separated
by commas. |
-| Type | String
|
-| Default | None
|
-| Effective | After restarting the system
|
+| **Name** | **datanode\_address\_list**
|
+| :----------------:
|:------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Description | A list of IP addresses or hostname of the hosts where the
DataNodes to be started/stopped are located. If there are multiple, they should
be separated by commas. |
+| Type | String
|
+| Default | None
|
+| Effective | After restarting the system
|
* ssh\_account
@@ -264,7 +264,7 @@ This following section will introduce the specific
configuration items in the `i
| **Name** | **confignode\_deploy\_path**
|
| :----------------: |
:----------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | The path on the target hosts where all ConfigNodes to be
started/stopped are located. All ConfigNodes must be in the same directory on
their respective hosts. |
+| Description | The path on the target hosts where all ConfigNodes to be
started/stopped are located. All ConfigNodes must be in the same directory on
their respective hosts. eg: `/data/demo/apache-iotdb-1.3.1-all-bin`|
| Type | String
|
| Default | None
|
| Effective | After restarting the system
|
@@ -273,11 +273,47 @@ This following section will introduce the specific
configuration items in the `i
| **Name** | **datanode\_deploy\_path**
|
| :----------------: |
:------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | The path on the target hosts where all DataNodes to be
started/stopped are located. All DataNodes must be in the same directory on
their respective hosts. |
+| Description | The path on the target hosts where all DataNodes to be
started/stopped are located. All DataNodes must be in the same directory on
their respective hosts. eg: `/data/demo/apache-iotdb-1.3.1-all-bin`|
| Type | String
|
| Default | None
|
| Effective | After restarting the system
|
+#### 3.7.3 Quick Example
+
+1. Configuration File: `iotdb-cluster.properties`
+```properties
+# Configure ConfigNode node addresses, separated by commas
+confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# Configure DataNode node addresses, separated by commas
+datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# SSH login username for target deployment servers
+ssh_account=root
+
+# SSH service port number
+ssh_port=22
+
+# IoTDB installation directory (the program will be deployed into this path on
remote nodes)
+confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+```
+
+2. Run `./start-all.sh` to launch cluster and verify status
+ Connect to IoTDB CLI and execute `show cluster`. A successful output is
shown below:
+```SQL
+IoTDB> show cluster
++------+----------+-------+---------------+------------+--------------+-----------+
+|NodeID| NodeType| Status|InternalAddress|InternalPort| Version|
BuildInfo|
++------+----------+-------+---------------+------------+--------------+-----------+
+| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1|
0xxxxxx|
+| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1|
0xxxxxx|
+| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1|
0xxxxxx|
+| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1|
0xxxxxx|
+| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1|
0xxxxxx|
+| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1|
0xxxxxx|
++------+----------+-------+---------------+------------+--------------+-----------+
+```
## 4. Maintenance
diff --git
a/src/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
b/src/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
index e195d2c6..753975e1 100644
---
a/src/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
+++
b/src/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
@@ -303,21 +303,21 @@ This following section will introduce the specific
configuration items in the `i
* confignode\_address\_list
-| **Name** | **confignode\_address\_list**
|
-| :----------------: |
:---------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | A list of IP addresses of the hosts where the ConfigNodes
to be started/stopped are located. If there are multiple, they should be
separated by commas. |
-| Type | String
|
-| Default | None
|
-| Effective | After restarting the system
|
+| **Name** | **confignode\_address\_list**
|
+| :----------------:
|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Description | A list of IP addresses or hostname of the hosts where the
ConfigNodes to be started/stopped are located. If there are multiple, they
should be separated by commas. |
+| Type | String
|
+| Default | None
|
+| Effective | After restarting the system
|
* datanode\_address\_list
-| **Name** | **datanode\_address\_list**
|
-| :----------------: |
:-------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | A list of IP addresses of the hosts where the DataNodes to
be started/stopped are located. If there are multiple, they should be separated
by commas. |
-| Type | String
|
-| Default | None
|
-| Effective | After restarting the system
|
+| **Name** | **datanode\_address\_list**
|
+| :----------------:
|:------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Description | A list of IP addresses or hostname of the hosts where the
DataNodes to be started/stopped are located. If there are multiple, they should
be separated by commas. |
+| Type | String
|
+| Default | None
|
+| Effective | After restarting the system
|
* ssh\_account
@@ -341,7 +341,7 @@ This following section will introduce the specific
configuration items in the `i
| **Name** | **confignode\_deploy\_path**
|
| :----------------: |
:----------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | The path on the target hosts where all ConfigNodes to be
started/stopped are located. All ConfigNodes must be in the same directory on
their respective hosts. |
+| Description | The path on the target hosts where all ConfigNodes to be
started/stopped are located. All ConfigNodes must be in the same directory on
their respective hosts. eg: `/data/demo/apache-iotdb-1.3.1-all-bin`|
| Type | String
|
| Default | None
|
| Effective | After restarting the system
|
@@ -350,12 +350,50 @@ This following section will introduce the specific
configuration items in the `i
| **Name** | **datanode\_deploy\_path**
|
| :----------------: |
:------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | The path on the target hosts where all DataNodes to be
started/stopped are located. All DataNodes must be in the same directory on
their respective hosts. |
+| Description | The path on the target hosts where all DataNodes to be
started/stopped are located. All DataNodes must be in the same directory on
their respective hosts.eg: `/data/demo/apache-iotdb-1.3.1-all-bin` |
| Type | String
|
| Default | None
|
| Effective | After restarting the system
|
+#### 3.8.3 Quick Example
+
+1. Configuration File: `iotdb-cluster.properties`
+```properties
+# Configure ConfigNode node addresses, separated by commas
+confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# Configure DataNode node addresses, separated by commas
+datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# SSH login username for target deployment servers
+ssh_account=root
+
+# SSH service port number
+ssh_port=22
+
+# IoTDB installation directory (the program will be deployed into this path on
remote nodes)
+confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+```
+
+2. Run `./start-all.sh` to launch cluster and verify status
+ Connect to IoTDB CLI and execute `show cluster`. A successful output is
shown below:
+```SQL
+IoTDB> show cluster
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+|NodeID| NodeType| Status|InternalAddress|InternalPort| Version|
BuildInfo| ActivateStatus|
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
+| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
+| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+```
+
+
## 4. Maintenance
### 4.1 ConfigNode Maintenance
diff --git
a/src/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_apache.md
b/src/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_apache.md
index c0aec00f..be763199 100644
---
a/src/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_apache.md
+++
b/src/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_apache.md
@@ -225,21 +225,21 @@ This following section will introduce the specific
configuration items in the `i
* confignode\_address\_list
-| **Name** | **confignode\_address\_list**
|
-| :----------------: |
:---------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | A list of IP addresses of the hosts where the ConfigNodes
to be started/stopped are located. If there are multiple, they should be
separated by commas. |
-| Type | String
|
-| Default | None
|
-| Effective | After restarting the system
|
+| **Name** | **confignode\_address\_list**
|
+| :----------------:
|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Description | A list of IP addresses or hostname of the hosts where the
ConfigNodes to be started/stopped are located. If there are multiple, they
should be separated by commas. |
+| Type | String
|
+| Default | None
|
+| Effective | After restarting the system
|
* datanode\_address\_list
-| **Name** | **datanode\_address\_list**
|
-| :----------------: |
:-------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | A list of IP addresses of the hosts where the DataNodes to
be started/stopped are located. If there are multiple, they should be separated
by commas. |
-| Type | String
|
-| Default | None
|
-| Effective | After restarting the system
|
+| **Name** | **datanode\_address\_list**
|
+| :----------------:
|:------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Description | A list of IP addresses or hostname of the hosts where the
DataNodes to be started/stopped are located. If there are multiple, they should
be separated by commas. |
+| Type | String
|
+| Default | None
|
+| Effective | After restarting the system
|
* ssh\_account
@@ -263,7 +263,7 @@ This following section will introduce the specific
configuration items in the `i
| **Name** | **confignode\_deploy\_path**
|
| :----------------: |
:----------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | The path on the target hosts where all ConfigNodes to be
started/stopped are located. All ConfigNodes must be in the same directory on
their respective hosts. |
+| Description | The path on the target hosts where all ConfigNodes to be
started/stopped are located. All ConfigNodes must be in the same directory on
their respective hosts. eg: `/data/demo/apache-iotdb-1.3.1-all-bin`|
| Type | String
|
| Default | None
|
| Effective | After restarting the system
|
@@ -272,12 +272,50 @@ This following section will introduce the specific
configuration items in the `i
| **Name** | **datanode\_deploy\_path**
|
| :----------------: |
:------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | The path on the target hosts where all DataNodes to be
started/stopped are located. All DataNodes must be in the same directory on
their respective hosts. |
+| Description | The path on the target hosts where all DataNodes to be
started/stopped are located. All DataNodes must be in the same directory on
their respective hosts. eg: `/data/demo/apache-iotdb-1.3.1-all-bin`|
| Type | String
|
| Default | None
|
| Effective | After restarting the system
|
+#### 3.6.3 Quick Example
+
+1. Configuration File: `iotdb-cluster.properties`
+```properties
+# Configure ConfigNode node addresses, separated by commas
+confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# Configure DataNode node addresses, separated by commas
+datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# SSH login username for target deployment servers
+ssh_account=root
+
+# SSH service port number
+ssh_port=22
+
+# IoTDB installation directory (the program will be deployed into this path on
remote nodes)
+confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+```
+
+2. Run `./start-all.sh` to launch cluster and verify status
+Connect to IoTDB CLI and execute `show cluster`. A successful output is shown
below:
+```SQL
+IoTDB> show cluster
++------+----------+-------+---------------+------------+--------------+-----------+
+|NodeID| NodeType| Status|InternalAddress|InternalPort| Version|
BuildInfo|
++------+----------+-------+---------------+------------+--------------+-----------+
+| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1|
0xxxxxx|
+| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1|
0xxxxxx|
+| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1|
0xxxxxx|
+| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1|
0xxxxxx|
+| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1|
0xxxxxx|
+| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1|
0xxxxxx|
++------+----------+-------+---------------+------------+--------------+-----------+
+```
+
+
## 4. Node Maintenance Steps
### 4.1 ConfigNode Node Maintenance
diff --git
a/src/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
b/src/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
index 614fecaf..c25aea61 100644
---
a/src/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
+++
b/src/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
@@ -308,21 +308,21 @@ This following section will introduce the specific
configuration items in the `i
* confignode\_address\_list
-| **Name** | **confignode\_address\_list**
|
-| :----------------: |
:---------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | A list of IP addresses of the hosts where the ConfigNodes
to be started/stopped are located. If there are multiple, they should be
separated by commas. |
-| Type | String
|
-| Default | None
|
-| Effective | After restarting the system
|
+| **Name** | **confignode\_address\_list**
|
+| :----------------:
|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Description | A list of IP addresses or hostname of the hosts where the
ConfigNodes to be started/stopped are located. If there are multiple, they
should be separated by commas. |
+| Type | String
|
+| Default | None
|
+| Effective | After restarting the system
|
* datanode\_address\_list
-| **Name** | **datanode\_address\_list**
|
-| :----------------: |
:-------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | A list of IP addresses of the hosts where the DataNodes to
be started/stopped are located. If there are multiple, they should be separated
by commas. |
-| Type | String
|
-| Default | None
|
-| Effective | After restarting the system
|
+| **Name** | **datanode\_address\_list**
|
+| :----------------:
|:------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Description | A list of IP addresses or hostname of the hosts where the
DataNodes to be started/stopped are located. If there are multiple, they should
be separated by commas. |
+| Type | String
|
+| Default | None
|
+| Effective | After restarting the system
|
* ssh\_account
@@ -335,18 +335,18 @@ This following section will introduce the specific
configuration items in the `i
* ssh\_port
-| **Name** | **ssh\_port**
|
-| :----------------: |
:----------------------------------------------------------------------------------
|
-| Description | The SSH port exposed by the target hosts. All hosts must
have the same SSH port. |
-| Type | int
|
-| Default | 22
|
-| Effective | After restarting the system
|
+| **Name** | **ssh\_port**
|
+| :----------------:
|:--------------------------------------------------------------------------------------|
+| Description | The SSH port exposed by the target hosts. All hosts must
have the same SSH port. |
+| Type | int
|
+| Default | 22
|
+| Effective | After restarting the system
|
* confignode\_deploy\_path
| **Name** | **confignode\_deploy\_path**
|
| :----------------: |
:----------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | The path on the target hosts where all ConfigNodes to be
started/stopped are located. All ConfigNodes must be in the same directory on
their respective hosts. |
+| Description | The path on the target hosts where all ConfigNodes to be
started/stopped are located. All ConfigNodes must be in the same directory on
their respective hosts. eg: `/data/demo/apache-iotdb-1.3.1-all-bin`|
| Type | String
|
| Default | None
|
| Effective | After restarting the system
|
@@ -355,12 +355,50 @@ This following section will introduce the specific
configuration items in the `i
| **Name** | **datanode\_deploy\_path**
|
| :----------------: |
:------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| Description | The path on the target hosts where all DataNodes to be
started/stopped are located. All DataNodes must be in the same directory on
their respective hosts. |
+| Description | The path on the target hosts where all DataNodes to be
started/stopped are located. All DataNodes must be in the same directory on
their respective hosts. eg: `/data/demo/apache-iotdb-1.3.1-all-bin`|
| Type | String
|
| Default | None
|
| Effective | After restarting the system
|
+#### 3.8.3 Quick Example
+
+1. Configuration File: `iotdb-cluster.properties`
+```properties
+# Configure ConfigNode node addresses, separated by commas
+confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# Configure DataNode node addresses, separated by commas
+datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# SSH login username for target deployment servers
+ssh_account=root
+
+# SSH service port number
+ssh_port=22
+
+# IoTDB installation directory (the program will be deployed into this path on
remote nodes)
+confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+```
+
+2. Run `./start-all.sh` to launch cluster and verify status
+ Connect to IoTDB CLI and execute `show cluster`. A successful output is
shown below:
+```SQL
+IoTDB> show cluster
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+|NodeID| NodeType| Status|InternalAddress|InternalPort| Version|
BuildInfo| ActivateStatus|
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
+| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
+| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+```
+
+
## 4. Maintenance
### 4.1 ConfigNode Maintenance
diff --git
a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md
b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md
index f13164d6..ff0b4d6b 100644
---
a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md
+++
b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md
@@ -217,7 +217,7 @@ cd sbin
| 名字 | confignode\_address\_list
|
| :--------------: |
:------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的 ConfigNode 节点所在主机的 IP 列表，如果有多个需要用“,”分隔。 |
+| 描述 | 待启动/停止的 ConfigNode 节点所在主机的 IP 或主机名列表，如果有多个需要用“,”分隔。 |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -226,7 +226,7 @@ cd sbin
| 名字 | datanode\_address\_list |
| :----------------: |
:---------------------------------------------------------------------------- |
-| 描述 | 待启动/停止的 DataNode 节点所在主机的 IP 列表，如果有多个需要用“,”分隔。 |
+| 描述 | 待启动/停止的 DataNode 节点所在主机的 IP 或主机名列表，如果有多个需要用“,”分隔。 |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -253,7 +253,7 @@ cd sbin
| 名字 | confignode\_deploy\_path
|
| :----------------: |
:----------------------------------------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的所有 ConfigNode 所在目标主机的路径，需要所有待启动/停止的 ConfigNode
节点在目标主机的相同目录下。 |
+| 描述 | 待启动/停止的所有 ConfigNode 所在目标主机的路径，需要所有待启动/停止的 ConfigNode
节点在目标主机的相同目录下。例如：`/data/demo/apache-iotdb-1.3.1-all-bin` |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -262,12 +262,49 @@ cd sbin
| 名字 | datanode\_deploy\_path
|
| :----------------: |
:------------------------------------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的所有 DataNode 所在目标主机的路径，需要所有待启动/停止的 DataNode
节点在目标主机的相同目录下。 |
+| 描述 | 待启动/停止的所有 DataNode 所在目标主机的路径，需要所有待启动/停止的 DataNode
节点在目标主机的相同目录下。例如：`/data/demo/apache-iotdb-1.3.1-all-bin` |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
+#### 3.6.3 简单示例
+
+1. 配置文件 `iotdb-cluster.properties`
+
+```properties
+# Configure ConfigNodes machine addresses separated by ,
+confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# Configure DataNodes machine addresses separated by ,
+datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# User name for logging in to the deployment machine using ssh
+ssh_account=root
+
+# ssh login port
+ssh_port=22
+
+# iotdb deployment directory (iotdb will be deployed to the target node in
this folder)
+confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+```
+
+2. 执行 ./start-all.sh 命令验证启动结果，在 cli 中执行 show cluster，可看到类似如下结果
+```SQL
+IoTDB> show cluster
++------+----------+-------+---------------+------------+--------------+-----------+
+|NodeID| NodeType| Status|InternalAddress|InternalPort| Version|
BuildInfo|
++------+----------+-------+---------------+------------+--------------+-----------+
+| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1|
0xxxxxx|
+| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1|
0xxxxxx|
+| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1|
0xxxxxx|
+| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1|
0xxxxxx|
+| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1|
0xxxxxx|
+| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1|
0xxxxxx|
++------+----------+-------+---------------+------------+--------------+-----------+
+```
+
## 4. 节点维护步骤
diff --git
a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
index 6c9c2410..1f38b3ac 100644
---
a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
+++
b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
@@ -294,7 +294,7 @@ IoTDB> show activation
| 名字 | confignode\_address\_list
|
| :--------------: |
:------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的 ConfigNode 节点所在主机的 IP 列表，如果有多个需要用“,”分隔。 |
+| 描述 | 待启动/停止的 ConfigNode 节点所在主机的 IP 或主机名列表，如果有多个需要用“,”分隔。 |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -303,7 +303,7 @@ IoTDB> show activation
| 名字 | datanode\_address\_list |
| :----------------: |
:---------------------------------------------------------------------------- |
-| 描述 | 待启动/停止的 DataNode 节点所在主机的 IP 列表，如果有多个需要用“,”分隔。 |
+| 描述 | 待启动/停止的 DataNode 节点所在主机的 IP 或主机名列表，如果有多个需要用“,”分隔。 |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -330,7 +330,7 @@ IoTDB> show activation
| 名字 | confignode\_deploy\_path
|
| :----------------: |
:----------------------------------------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的所有 ConfigNode 所在目标主机的路径，需要所有待启动/停止的 ConfigNode
节点在目标主机的相同目录下。 |
+| 描述 | 待启动/停止的所有 ConfigNode 所在目标主机的路径，需要所有待启动/停止的 ConfigNode
节点在目标主机的相同目录下。例如：`/data/demo/apache-iotdb-1.3.1-all-bin` |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -339,12 +339,49 @@ IoTDB> show activation
| 名字 | datanode\_deploy\_path
|
| :----------------: |
:------------------------------------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的所有 DataNode 所在目标主机的路径，需要所有待启动/停止的 DataNode
节点在目标主机的相同目录下。 |
+| 描述 | 待启动/停止的所有 DataNode 所在目标主机的路径，需要所有待启动/停止的 DataNode
节点在目标主机的相同目录下。例如：`/data/demo/apache-iotdb-1.3.1-all-bin` |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
+#### 3.7.3 简单示例
+
+1. 配置文件 `iotdb-cluster.properties`
+
+```properties
+# Configure ConfigNodes machine addresses separated by ,
+confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# Configure DataNodes machine addresses separated by ,
+datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# User name for logging in to the deployment machine using ssh
+ssh_account=root
+
+# ssh login port
+ssh_port=22
+
+# iotdb deployment directory (iotdb will be deployed to the target node in
this folder)
+confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+```
+
+2. 执行 ./start-all.sh 命令验证启动结果，在 cli 中执行 show cluster，可看到类似如下结果
+```SQL
+IoTDB> show cluster
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+|NodeID| NodeType| Status|InternalAddress|InternalPort| Version|
BuildInfo| ActivateStatus|
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
+| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
+| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+```
+
## 4. 节点维护步骤
diff --git
a/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_apache.md
b/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_apache.md
index 27500e88..da1d6fdf 100644
---
a/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_apache.md
+++
b/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_apache.md
@@ -217,18 +217,18 @@ cd sbin
* confignode\_address\_list
-| 名字 | confignode\_address\_list
|
-| :--------------: |
:------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的 ConfigNode 节点所在主机的 IP 列表，如果有多个需要用“,”分隔。 |
-| 类型 | String
|
-| 默认值 | 无
|
-| 改后生效方式 | 重启服务生效
|
+| 名字 | confignode\_address\_list |
+| :--------------: |:-----------------------------------------------------|
+| 描述 | 待启动/停止的 ConfigNode 节点所在主机的 IP 或主机名列表，如果有多个需要用“,”分隔。 |
+| 类型 | String |
+| 默认值 | 无 |
+| 改后生效方式 | 重启服务生效 |
* datanode\_address\_list
| 名字 | datanode\_address\_list |
| :----------------: |
:---------------------------------------------------------------------------- |
-| 描述 | 待启动/停止的 DataNode 节点所在主机的 IP 列表，如果有多个需要用“,”分隔。 |
+| 描述 | 待启动/停止的 DataNode 节点所在主机的 IP 或主机名列表，如果有多个需要用“,”分隔。 |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -253,23 +253,58 @@ cd sbin
* confignode\_deploy\_path
-| 名字 | confignode\_deploy\_path
|
-| :----------------: |
:----------------------------------------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的所有 ConfigNode 所在目标主机的路径，需要所有待启动/停止的 ConfigNode
节点在目标主机的相同目录下。 |
-| 类型 | String
|
-| 默认值 | 无
|
-| 改后生效方式 | 重启服务生效
|
+| 名字 | confignode\_deploy\_path
|
+| :----------------:
|:------------------------------------------------------------------------|
+| 描述 | 待启动/停止的所有 ConfigNode 所在目标主机的路径，需要所有待启动/停止的 ConfigNode
节点在目标主机的相同目录下。例如：`/data/demo/apache-iotdb-1.3.1-all-bin` |
+| 类型 | String
|
+| 默认值 | 无
|
+| 改后生效方式 | 重启服务生效
|
* datanode\_deploy\_path
| 名字 | datanode\_deploy\_path
|
| :----------------: |
:------------------------------------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的所有 DataNode 所在目标主机的路径，需要所有待启动/停止的 DataNode
节点在目标主机的相同目录下。 |
+| 描述 | 待启动/停止的所有 DataNode 所在目标主机的路径，需要所有待启动/停止的 DataNode
节点在目标主机的相同目录下。例如：`/data/demo/apache-iotdb-1.3.1-all-bin` |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
+#### 3.6.3 简单示例
+1. 配置文件 `iotdb-cluster.properties`
+
+```properties
+# Configure ConfigNodes machine addresses separated by ,
+confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# Configure DataNodes machine addresses separated by ,
+datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# User name for logging in to the deployment machine using ssh
+ssh_account=root
+
+# ssh login port
+ssh_port=22
+
+# iotdb deployment directory (iotdb will be deployed to the target node in
this folder)
+confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+```
+
+2. 执行 ./start-all.sh 命令验证启动结果，在 cli 中执行 show cluster，可看到类似如下结果
+```SQL
+IoTDB> show cluster
++------+----------+-------+---------------+------------+--------------+-----------+
+|NodeID| NodeType| Status|InternalAddress|InternalPort| Version|
BuildInfo|
++------+----------+-------+---------------+------------+--------------+-----------+
+| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1|
0xxxxxx|
+| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1|
0xxxxxx|
+| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1|
0xxxxxx|
+| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1|
0xxxxxx|
+| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1|
0xxxxxx|
+| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1|
0xxxxxx|
++------+----------+-------+---------------+------------+--------------+-----------+
+```
## 4. 节点维护步骤
diff --git
a/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
b/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
index 229f0134..022c90ee 100644
---
a/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
+++
b/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
@@ -294,7 +294,7 @@ IoTDB> show activation
| 名字 | confignode\_address\_list
|
| :--------------: |
:------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的 ConfigNode 节点所在主机的 IP 列表，如果有多个需要用“,”分隔。 |
+| 描述 | 待启动/停止的 ConfigNode 节点所在主机的 IP 或主机名列表，如果有多个需要用“,”分隔。 |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -303,7 +303,7 @@ IoTDB> show activation
| 名字 | datanode\_address\_list |
| :----------------: |
:---------------------------------------------------------------------------- |
-| 描述 | 待启动/停止的 DataNode 节点所在主机的 IP 列表，如果有多个需要用“,”分隔。 |
+| 描述 | 待启动/停止的 DataNode 节点所在主机的 IP 或主机名列表，如果有多个需要用“,”分隔。 |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -330,7 +330,7 @@ IoTDB> show activation
| 名字 | confignode\_deploy\_path
|
| :----------------: |
:----------------------------------------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的所有 ConfigNode 所在目标主机的路径，需要所有待启动/停止的 ConfigNode
节点在目标主机的相同目录下。 |
+| 描述 | 待启动/停止的所有 ConfigNode 所在目标主机的路径，需要所有待启动/停止的 ConfigNode
节点在目标主机的相同目录下。例如：`/data/demo/apache-iotdb-1.3.1-all-bin` |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -339,12 +339,49 @@ IoTDB> show activation
| 名字 | datanode\_deploy\_path
|
| :----------------: |
:------------------------------------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的所有 DataNode 所在目标主机的路径，需要所有待启动/停止的 DataNode
节点在目标主机的相同目录下。 |
+| 描述 | 待启动/停止的所有 DataNode 所在目标主机的路径，需要所有待启动/停止的 DataNode
节点在目标主机的相同目录下。例如：`/data/demo/apache-iotdb-1.3.1-all-bin` |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
+#### 3.7.3 简单示例
+
+1. 配置文件 `iotdb-cluster.properties`
+
+```properties
+# Configure ConfigNodes machine addresses separated by ,
+confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# Configure DataNodes machine addresses separated by ,
+datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# User name for logging in to the deployment machine using ssh
+ssh_account=root
+
+# ssh login port
+ssh_port=22
+
+# iotdb deployment directory (iotdb will be deployed to the target node in
this folder)
+confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+```
+
+2. 执行 ./start-all.sh 命令验证启动结果，在 cli 中执行 show cluster，可看到类似如下结果
+```SQL
+IoTDB> show cluster
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+|NodeID| NodeType| Status|InternalAddress|InternalPort| Version|
BuildInfo| ActivateStatus|
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
+| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
+| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+```
+
## 4. 节点维护步骤
### 4.1 ConfigNode节点维护
diff --git
a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md
b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md
index f13164d6..ff0b4d6b 100644
---
a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md
+++
b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md
@@ -217,7 +217,7 @@ cd sbin
| 名字 | confignode\_address\_list
|
| :--------------: |
:------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的 ConfigNode 节点所在主机的 IP 列表，如果有多个需要用“,”分隔。 |
+| 描述 | 待启动/停止的 ConfigNode 节点所在主机的 IP 或主机名列表，如果有多个需要用“,”分隔。 |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -226,7 +226,7 @@ cd sbin
| 名字 | datanode\_address\_list |
| :----------------: |
:---------------------------------------------------------------------------- |
-| 描述 | 待启动/停止的 DataNode 节点所在主机的 IP 列表，如果有多个需要用“,”分隔。 |
+| 描述 | 待启动/停止的 DataNode 节点所在主机的 IP 或主机名列表，如果有多个需要用“,”分隔。 |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -253,7 +253,7 @@ cd sbin
| 名字 | confignode\_deploy\_path
|
| :----------------: |
:----------------------------------------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的所有 ConfigNode 所在目标主机的路径，需要所有待启动/停止的 ConfigNode
节点在目标主机的相同目录下。 |
+| 描述 | 待启动/停止的所有 ConfigNode 所在目标主机的路径，需要所有待启动/停止的 ConfigNode
节点在目标主机的相同目录下。例如：`/data/demo/apache-iotdb-1.3.1-all-bin` |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -262,12 +262,49 @@ cd sbin
| 名字 | datanode\_deploy\_path
|
| :----------------: |
:------------------------------------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的所有 DataNode 所在目标主机的路径，需要所有待启动/停止的 DataNode
节点在目标主机的相同目录下。 |
+| 描述 | 待启动/停止的所有 DataNode 所在目标主机的路径，需要所有待启动/停止的 DataNode
节点在目标主机的相同目录下。例如：`/data/demo/apache-iotdb-1.3.1-all-bin` |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
+#### 3.6.3 简单示例
+
+1. 配置文件 `iotdb-cluster.properties`
+
+```properties
+# Configure ConfigNodes machine addresses separated by ,
+confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# Configure DataNodes machine addresses separated by ,
+datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# User name for logging in to the deployment machine using ssh
+ssh_account=root
+
+# ssh login port
+ssh_port=22
+
+# iotdb deployment directory (iotdb will be deployed to the target node in
this folder)
+confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+```
+
+2. 执行 ./start-all.sh 命令验证启动结果，在 cli 中执行 show cluster，可看到类似如下结果
+```SQL
+IoTDB> show cluster
++------+----------+-------+---------------+------------+--------------+-----------+
+|NodeID| NodeType| Status|InternalAddress|InternalPort| Version|
BuildInfo|
++------+----------+-------+---------------+------------+--------------+-----------+
+| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1|
0xxxxxx|
+| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1|
0xxxxxx|
+| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1|
0xxxxxx|
+| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1|
0xxxxxx|
+| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1|
0xxxxxx|
+| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1|
0xxxxxx|
++------+----------+-------+---------------+------------+--------------+-----------+
+```
+
## 4. 节点维护步骤
diff --git
a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
index 6c9c2410..1f38b3ac 100644
---
a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
+++
b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
@@ -294,7 +294,7 @@ IoTDB> show activation
| 名字 | confignode\_address\_list
|
| :--------------: |
:------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的 ConfigNode 节点所在主机的 IP 列表，如果有多个需要用“,”分隔。 |
+| 描述 | 待启动/停止的 ConfigNode 节点所在主机的 IP 或主机名列表，如果有多个需要用“,”分隔。 |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -303,7 +303,7 @@ IoTDB> show activation
| 名字 | datanode\_address\_list |
| :----------------: |
:---------------------------------------------------------------------------- |
-| 描述 | 待启动/停止的 DataNode 节点所在主机的 IP 列表，如果有多个需要用“,”分隔。 |
+| 描述 | 待启动/停止的 DataNode 节点所在主机的 IP 或主机名列表，如果有多个需要用“,”分隔。 |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -330,7 +330,7 @@ IoTDB> show activation
| 名字 | confignode\_deploy\_path
|
| :----------------: |
:----------------------------------------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的所有 ConfigNode 所在目标主机的路径，需要所有待启动/停止的 ConfigNode
节点在目标主机的相同目录下。 |
+| 描述 | 待启动/停止的所有 ConfigNode 所在目标主机的路径，需要所有待启动/停止的 ConfigNode
节点在目标主机的相同目录下。例如：`/data/demo/apache-iotdb-1.3.1-all-bin` |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -339,12 +339,49 @@ IoTDB> show activation
| 名字 | datanode\_deploy\_path
|
| :----------------: |
:------------------------------------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的所有 DataNode 所在目标主机的路径，需要所有待启动/停止的 DataNode
节点在目标主机的相同目录下。 |
+| 描述 | 待启动/停止的所有 DataNode 所在目标主机的路径，需要所有待启动/停止的 DataNode
节点在目标主机的相同目录下。例如：`/data/demo/apache-iotdb-1.3.1-all-bin` |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
+#### 3.7.3 简单示例
+
+1. 配置文件 `iotdb-cluster.properties`
+
+```properties
+# Configure ConfigNodes machine addresses separated by ,
+confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# Configure DataNodes machine addresses separated by ,
+datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# User name for logging in to the deployment machine using ssh
+ssh_account=root
+
+# ssh login port
+ssh_port=22
+
+# iotdb deployment directory (iotdb will be deployed to the target node in
this folder)
+confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+```
+
+2. 执行 ./start-all.sh 命令验证启动结果，在 cli 中执行 show cluster，可看到类似如下结果
+```SQL
+IoTDB> show cluster
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+|NodeID| NodeType| Status|InternalAddress|InternalPort| Version|
BuildInfo| ActivateStatus|
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
+| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
+| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+```
+
## 4. 节点维护步骤
diff --git
a/src/zh/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_apache.md
b/src/zh/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_apache.md
index 27500e88..da1d6fdf 100644
---
a/src/zh/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_apache.md
+++
b/src/zh/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_apache.md
@@ -217,18 +217,18 @@ cd sbin
* confignode\_address\_list
-| 名字 | confignode\_address\_list
|
-| :--------------: |
:------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的 ConfigNode 节点所在主机的 IP 列表，如果有多个需要用“,”分隔。 |
-| 类型 | String
|
-| 默认值 | 无
|
-| 改后生效方式 | 重启服务生效
|
+| 名字 | confignode\_address\_list |
+| :--------------: |:-----------------------------------------------------|
+| 描述 | 待启动/停止的 ConfigNode 节点所在主机的 IP 或主机名列表，如果有多个需要用“,”分隔。 |
+| 类型 | String |
+| 默认值 | 无 |
+| 改后生效方式 | 重启服务生效 |
* datanode\_address\_list
| 名字 | datanode\_address\_list |
| :----------------: |
:---------------------------------------------------------------------------- |
-| 描述 | 待启动/停止的 DataNode 节点所在主机的 IP 列表，如果有多个需要用“,”分隔。 |
+| 描述 | 待启动/停止的 DataNode 节点所在主机的 IP 或主机名列表，如果有多个需要用“,”分隔。 |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -253,23 +253,58 @@ cd sbin
* confignode\_deploy\_path
-| 名字 | confignode\_deploy\_path
|
-| :----------------: |
:----------------------------------------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的所有 ConfigNode 所在目标主机的路径，需要所有待启动/停止的 ConfigNode
节点在目标主机的相同目录下。 |
-| 类型 | String
|
-| 默认值 | 无
|
-| 改后生效方式 | 重启服务生效
|
+| 名字 | confignode\_deploy\_path
|
+| :----------------:
|:------------------------------------------------------------------------|
+| 描述 | 待启动/停止的所有 ConfigNode 所在目标主机的路径，需要所有待启动/停止的 ConfigNode
节点在目标主机的相同目录下。例如：`/data/demo/apache-iotdb-1.3.1-all-bin` |
+| 类型 | String
|
+| 默认值 | 无
|
+| 改后生效方式 | 重启服务生效
|
* datanode\_deploy\_path
| 名字 | datanode\_deploy\_path
|
| :----------------: |
:------------------------------------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的所有 DataNode 所在目标主机的路径，需要所有待启动/停止的 DataNode
节点在目标主机的相同目录下。 |
+| 描述 | 待启动/停止的所有 DataNode 所在目标主机的路径，需要所有待启动/停止的 DataNode
节点在目标主机的相同目录下。例如：`/data/demo/apache-iotdb-1.3.1-all-bin` |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
+#### 3.6.3 简单示例
+1. 配置文件 `iotdb-cluster.properties`
+
+```properties
+# Configure ConfigNodes machine addresses separated by ,
+confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# Configure DataNodes machine addresses separated by ,
+datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# User name for logging in to the deployment machine using ssh
+ssh_account=root
+
+# ssh login port
+ssh_port=22
+
+# iotdb deployment directory (iotdb will be deployed to the target node in
this folder)
+confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+```
+
+2. 执行 ./start-all.sh 命令验证启动结果，在 cli 中执行 show cluster，可看到类似如下结果
+```SQL
+IoTDB> show cluster
++------+----------+-------+---------------+------------+--------------+-----------+
+|NodeID| NodeType| Status|InternalAddress|InternalPort| Version|
BuildInfo|
++------+----------+-------+---------------+------------+--------------+-----------+
+| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1|
0xxxxxx|
+| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1|
0xxxxxx|
+| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1|
0xxxxxx|
+| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1|
0xxxxxx|
+| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1|
0xxxxxx|
+| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1|
0xxxxxx|
++------+----------+-------+---------------+------------+--------------+-----------+
+```
## 4. 节点维护步骤
diff --git
a/src/zh/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
b/src/zh/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
index 229f0134..022c90ee 100644
---
a/src/zh/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
+++
b/src/zh/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
@@ -294,7 +294,7 @@ IoTDB> show activation
| 名字 | confignode\_address\_list
|
| :--------------: |
:------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的 ConfigNode 节点所在主机的 IP 列表，如果有多个需要用“,”分隔。 |
+| 描述 | 待启动/停止的 ConfigNode 节点所在主机的 IP 或主机名列表，如果有多个需要用“,”分隔。 |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -303,7 +303,7 @@ IoTDB> show activation
| 名字 | datanode\_address\_list |
| :----------------: |
:---------------------------------------------------------------------------- |
-| 描述 | 待启动/停止的 DataNode 节点所在主机的 IP 列表，如果有多个需要用“,”分隔。 |
+| 描述 | 待启动/停止的 DataNode 节点所在主机的 IP 或主机名列表，如果有多个需要用“,”分隔。 |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -330,7 +330,7 @@ IoTDB> show activation
| 名字 | confignode\_deploy\_path
|
| :----------------: |
:----------------------------------------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的所有 ConfigNode 所在目标主机的路径，需要所有待启动/停止的 ConfigNode
节点在目标主机的相同目录下。 |
+| 描述 | 待启动/停止的所有 ConfigNode 所在目标主机的路径，需要所有待启动/停止的 ConfigNode
节点在目标主机的相同目录下。例如：`/data/demo/apache-iotdb-1.3.1-all-bin` |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
@@ -339,12 +339,49 @@ IoTDB> show activation
| 名字 | datanode\_deploy\_path
|
| :----------------: |
:------------------------------------------------------------------------------------------------------------
|
-| 描述 | 待启动/停止的所有 DataNode 所在目标主机的路径，需要所有待启动/停止的 DataNode
节点在目标主机的相同目录下。 |
+| 描述 | 待启动/停止的所有 DataNode 所在目标主机的路径，需要所有待启动/停止的 DataNode
节点在目标主机的相同目录下。例如：`/data/demo/apache-iotdb-1.3.1-all-bin` |
| 类型 | String
|
| 默认值 | 无
|
| 改后生效方式 | 重启服务生效
|
+#### 3.7.3 简单示例
+
+1. 配置文件 `iotdb-cluster.properties`
+
+```properties
+# Configure ConfigNodes machine addresses separated by ,
+confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# Configure DataNodes machine addresses separated by ,
+datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
+
+# User name for logging in to the deployment machine using ssh
+ssh_account=root
+
+# ssh login port
+ssh_port=22
+
+# iotdb deployment directory (iotdb will be deployed to the target node in
this folder)
+confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
+```
+
+2. 执行 ./start-all.sh 命令验证启动结果，在 cli 中执行 show cluster，可看到类似如下结果
+```SQL
+IoTDB> show cluster
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+|NodeID| NodeType| Status|InternalAddress|InternalPort| Version|
BuildInfo| ActivateStatus|
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1|
0xxxxxx| ACTIVATED|
+| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
+| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
+| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1|
0xxxxxx| ACTIVATED|
++------+----------+-------+---------------+------------+--------------+-----------+----------------+
+```
+
## 4. 节点维护步骤
### 4.1 ConfigNode节点维护
