Skip to content

Commit 1b57358

Browse files
leto-bbqleto-bbq
committed
add example and description to start-all
1 parent 1f5fa77 commit 1b57358

16 files changed

Lines changed: 768 additions & 176 deletions

File tree

‎src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md‎

Lines changed: 50 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -226,21 +226,21 @@ This following section will introduce the specific configuration items in the `i
226226
227227
* confignode\_address\_list
228228
229-
| **Name** | **confignode\_address\_list** |
230-
| :----------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
231-
| 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. |
232-
| Type | String |
233-
| Default | None |
234-
| Effective | After restarting the system |
229+
| **Name** | **confignode\_address\_list** |
230+
| :----------------: |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
231+
| 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. |
232+
| Type | String |
233+
| Default | None |
234+
| Effective | After restarting the system |
235235
236236
* datanode\_address\_list
237237
238-
| **Name** | **datanode\_address\_list** |
239-
| :----------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------- |
240-
| 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. |
241-
| Type | String |
242-
| Default | None |
243-
| Effective | After restarting the system |
238+
| **Name** | **datanode\_address\_list** |
239+
| :----------------: |:------------------------------------------------------------------------------------------------------------------------------------------------------------------|
240+
| 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. |
241+
| Type | String |
242+
| Default | None |
243+
| Effective | After restarting the system |
244244
245245
* ssh\_account
246246
@@ -264,7 +264,7 @@ This following section will introduce the specific configuration items in the `i
264264
265265
| **Name** | **confignode\_deploy\_path** |
266266
| :----------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
267-
| 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. |
267+
| 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`|
268268
| Type | String |
269269
| Default | None |
270270
| Effective | After restarting the system |
@@ -273,11 +273,47 @@ This following section will introduce the specific configuration items in the `i
273273
274274
| **Name** | **datanode\_deploy\_path** |
275275
| :----------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------ |
276-
| 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. |
276+
| 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`|
277277
| Type | String |
278278
| Default | None |
279279
| Effective | After restarting the system |
280280
281+
#### 3.7.3 Quick Example
282+
283+
1. Configuration File: `iotdb-cluster.properties`
284+
```properties
285+
# Configure ConfigNode node addresses, separated by commas
286+
confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
287+
288+
# Configure DataNode node addresses, separated by commas
289+
datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
290+
291+
# SSH login username for target deployment servers
292+
ssh_account=root
293+
294+
# SSH service port number
295+
ssh_port=22
296+
297+
# IoTDB installation directory (the program will be deployed into this path on remote nodes)
298+
confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
299+
datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
300+
```
301+
302+
2. Run `./start-all.sh` to launch cluster and verify status
303+
Connect to IoTDB CLI and execute `show cluster`. A successful output is shown below:
304+
```SQL
305+
IoTDB> show cluster
306+
+------+----------+-------+---------------+------------+--------------+-----------+
307+
|NodeID| NodeType| Status|InternalAddress|InternalPort| Version| BuildInfo|
308+
+------+----------+-------+---------------+------------+--------------+-----------+
309+
| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1| 0xxxxxx|
310+
| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1| 0xxxxxx|
311+
| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1| 0xxxxxx|
312+
| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1| 0xxxxxx|
313+
| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1| 0xxxxxx|
314+
| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1| 0xxxxxx|
315+
+------+----------+-------+---------------+------------+--------------+-----------+
316+
```
281317
282318
## 4. Maintenance
283319

‎src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md‎

Lines changed: 52 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -303,21 +303,21 @@ This following section will introduce the specific configuration items in the `i
303303

304304
* confignode\_address\_list
305305

306-
| **Name** | **confignode\_address\_list** |
307-
| :----------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
308-
| 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. |
309-
| Type | String |
310-
| Default | None |
311-
| Effective | After restarting the system |
306+
| **Name** | **confignode\_address\_list** |
307+
| :----------------: |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
308+
| 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. |
309+
| Type | String |
310+
| Default | None |
311+
| Effective | After restarting the system |
312312

313313
* datanode\_address\_list
314314

315-
| **Name** | **datanode\_address\_list** |
316-
| :----------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------- |
317-
| 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. |
318-
| Type | String |
319-
| Default | None |
320-
| Effective | After restarting the system |
315+
| **Name** | **datanode\_address\_list** |
316+
| :----------------: |:------------------------------------------------------------------------------------------------------------------------------------------------------------------|
317+
| 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. |
318+
| Type | String |
319+
| Default | None |
320+
| Effective | After restarting the system |
321321

322322
* ssh\_account
323323

@@ -341,7 +341,7 @@ This following section will introduce the specific configuration items in the `i
341341

342342
| **Name** | **confignode\_deploy\_path** |
343343
| :----------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
344-
| 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. |
344+
| 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`|
345345
| Type | String |
346346
| Default | None |
347347
| Effective | After restarting the system |
@@ -350,12 +350,50 @@ This following section will introduce the specific configuration items in the `i
350350

351351
| **Name** | **datanode\_deploy\_path** |
352352
| :----------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------ |
353-
| 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. |
353+
| 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` |
354354
| Type | String |
355355
| Default | None |
356356
| Effective | After restarting the system |
357357

358358

359+
#### 3.8.3 Quick Example
360+
361+
1. Configuration File: `iotdb-cluster.properties`
362+
```properties
363+
# Configure ConfigNode node addresses, separated by commas
364+
confignode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
365+
366+
# Configure DataNode node addresses, separated by commas
367+
datanode_address_list=172.xx.xx.16,172.xx.xx.17,172.xx.xx.18
368+
369+
# SSH login username for target deployment servers
370+
ssh_account=root
371+
372+
# SSH service port number
373+
ssh_port=22
374+
375+
# IoTDB installation directory (the program will be deployed into this path on remote nodes)
376+
confignode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
377+
datanode_deploy_path=/data/demo/apache-iotdb-1.3.1-all-bin
378+
```
379+
380+
2. Run `./start-all.sh` to launch cluster and verify status
381+
Connect to IoTDB CLI and execute `show cluster`. A successful output is shown below:
382+
```SQL
383+
IoTDB> show cluster
384+
+------+----------+-------+---------------+------------+--------------+-----------+----------------+
385+
|NodeID| NodeType| Status|InternalAddress|InternalPort| Version| BuildInfo| ActivateStatus|
386+
+------+----------+-------+---------------+------------+--------------+-----------+----------------+
387+
| 0|ConfigNode|Running| 172.xx.xx.16| 10710| 1.3.1| 0xxxxxx| ACTIVATED|
388+
| 1|ConfigNode|Running| 172.xx.xx.18| 10710| 1.3.1| 0xxxxxx| ACTIVATED|
389+
| 2|ConfigNode|Running| 172.xx.xx.17| 10710| 1.3.1| 0xxxxxx| ACTIVATED|
390+
| 3| DataNode|Running| 172.xx.xx.18| 10730| 1.3.1| 0xxxxxx| ACTIVATED|
391+
| 4| DataNode|Running| 172.xx.xx.17| 10730| 1.3.1| 0xxxxxx| ACTIVATED|
392+
| 5| DataNode|Running| 172.xx.xx.16| 10730| 1.3.1| 0xxxxxx| ACTIVATED|
393+
+------+----------+-------+---------------+------------+--------------+-----------+----------------+
394+
```
395+
396+
359397
## 4. Maintenance
360398

361399
### 4.1 ConfigNode Maintenance

0 commit comments

Comments
 (0)