Skip to content

add example and description to start-all #1146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xiaoyekanren merged 1 commit into from
Jun 4, 2026
Merged

add example and description to start-all #1146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 50 additions & 14 deletions src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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 |
Expand All @@ -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

Expand Down
66 changes: 52 additions & 14 deletions ...UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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 |
Expand All @@ -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
Expand Down
Loading
Loading