Skip to content

add one click cluster start and stop in cluster deployment #648

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
HTHou merged 1 commit into from
Mar 13, 2025
Merged

add one click cluster start and stop in cluster deployment #648

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
71 changes: 71 additions & 0 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 @@ -169,6 +169,77 @@ On each server, navigate to the `sbin` directory and start the DataNode:
./start-cli.bat -sql_dialect table
```

### 3.7 One-click Cluster Start and Stop

#### 3.7.1 Overview

Within the root directory of IoTDB, the `sbin `subdirectory houses the `start-all.sh` and `stop-all.sh` scripts, which work in concert with the `iotdb-cluster.properties` configuration file located in the `conf` subdirectory. This synergy enables the one-click initiation or termination of all nodes within the cluster from a single node. This approach facilitates efficient management of the IoTDB cluster's lifecycle, streamlining the deployment and operational maintenance processes.

This following section will introduce the specific configuration items in the `iotdb-cluster.properties` file.

#### 3.7.2 Configuration Items

> Note:
>
> * When the cluster changes, this configuration file needs to be manually updated.
> * If the `iotdb-cluster.properties` configuration file is not set up and the `start-all.sh` or `stop-all.sh` scripts are executed, the scripts will, by default, start or stop the ConfigNode and DataNode nodes located in the IOTDB\_HOME directory where the scripts reside.
> * It is recommended to configure SSH passwordless login: If not configured, the script will prompt for the server password after execution to facilitate subsequent start, stop, or destroy operations. If already configured, there is no need to enter the server password during script execution.

* 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 |

* 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 |

* ssh\_account

| **Name** | **ssh\_account** |
| :----------------: | :------------------------------------------------------------------------------------------------- |
| Description | The username used to log in to the target hosts via SSH. All hosts must have the same username. |
| Type | String |
| Default | root |
| Effective | After restarting the system |

* 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 |

* 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. |
| Type | String |
| Default | None |
| Effective | After restarting the system |

* datanode\_deploy\_path

| **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. |
| Type | String |
| Default | None |
| Effective | After restarting the system |


## 4. Maintenance

### 4.1 ConfigNode Maintenance
Expand Down
71 changes: 71 additions & 0 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 @@ -217,6 +217,77 @@ Check the `ClusterActivationStatus` field. If it shows `ACTIVATED`, the database

![](/img/%E9%9B%86%E7%BE%A4-%E9%AA%8C%E8%AF%81.png)

### 3.8 One-click Cluster Start and Stop

#### 3.8.1 Overview

Within the root directory of IoTDB, the `sbin `subdirectory houses the `start-all.sh` and `stop-all.sh` scripts, which work in concert with the `iotdb-cluster.properties` configuration file located in the `conf` subdirectory. This synergy enables the one-click initiation or termination of all nodes within the cluster from a single node. This approach facilitates efficient management of the IoTDB cluster's lifecycle, streamlining the deployment and operational maintenance processes.

This following section will introduce the specific configuration items in the `iotdb-cluster.properties` file.

#### 3.8.2 Configuration Items

> Note:
>
> * When the cluster changes, this configuration file needs to be manually updated.
> * If the `iotdb-cluster.properties` configuration file is not set up and the `start-all.sh` or `stop-all.sh` scripts are executed, the scripts will, by default, start or stop the ConfigNode and DataNode nodes located in the IOTDB\_HOME directory where the scripts reside.
> * It is recommended to configure SSH passwordless login: If not configured, the script will prompt for the server password after execution to facilitate subsequent start, stop, or destroy operations. If already configured, there is no need to enter the server password during script execution.

* 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 |

* 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 |

* ssh\_account

| **Name** | **ssh\_account** |
| :----------------: | :------------------------------------------------------------------------------------------------- |
| Description | The username used to log in to the target hosts via SSH. All hosts must have the same username. |
| Type | String |
| Default | root |
| Effective | After restarting the system |

* 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 |

* 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. |
| Type | String |
| Default | None |
| Effective | After restarting the system |

* datanode\_deploy\_path

| **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. |
| Type | String |
| Default | None |
| Effective | After restarting the system |


## 4. Maintenance

### 4.1 ConfigNode Maintenance
Expand Down
Loading