Skip to content

Commit 7e03206

Browse files
authored
add upgrade ainode (#1075)
1 parent 53d7fd6 commit 7e03206

16 files changed

Lines changed: 470 additions & 72 deletions

File tree

src/UserGuide/Master/Table/Deployment-and-Maintenance/AINode_Deployment_Upgrade_apache.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,9 @@
2626

2727
AINode is the third type of endogenous node provided by IoTDB after ConfigNode and DataNode. By interacting with the DataNodes and ConfigNodes of an IoTDB cluster, this node extends the capability for machine learning analysis on time series. AINode integrates model management, training, and inference within the database engine. It supports performing time series analysis tasks on specified time series data using registered models through simple SQL statements and also supports registering and using custom machine learning models. AINode currently integrates machine learning algorithms and self-developed models for common time series analysis scenarios (e.g., forecasting).
2828

29-
### 1.2 Delivery Method
29+
### 1.2 Deployment Modes
3030

31-
AINode is an additional suite outside the IoTDB cluster, provided as an independent installation package.
32-
33-
### 1.3 Deployment Modes
31+
AINode is an additional component outside the IoTDB cluster and is deployed using a separate installation package.
3432

3533
<div >
3634
<img src="/img/ainode-deployment-upgrade-apache-1-en.png" alt="" style="width: 45%;"/>
@@ -85,7 +83,7 @@ To ensure the AINode installation package you obtained is complete and correct,
8583
### 2.3 Environment Requirements
8684

8785
- Recommended operating environment: Linux, macOS.
88-
- IoTDB Version: >= V2.0.8.
86+
- IoTDB Version: >= V2.0.8-beta.
8987

9088
## 3. Installation, Deployment, and Usage
9189

@@ -206,6 +204,34 @@ IoTDB> show cluster
206204

207205
If you need to restart the node, re-execute the startup script.
208206

207+
### 3.7 Upgrading AINode
208+
If you need to upgrade the version of the current AINode, you can refer to the following steps:
209+
210+
1. Stop the current AINode service
211+
212+
* Run the stop command and ensure the service has completely exited before performing subsequent operations.
213+
214+
```shell
215+
# Linux / MacOS
216+
bash sbin/stop-ainode.sh
217+
bash sbin/stop-ainode.sh -p <port_id> # Specify port
218+
219+
# Windows
220+
sbin\stop-ainode.bat
221+
sbin\stop-ainode.bat -p <port_id> # Specify port
222+
```
223+
224+
2. Replace core files
225+
226+
* Delete the `lib` and `sbin` directories of the current version, then copy the `lib` and `sbin` directories of the new version to the corresponding locations.
227+
* Back up the modified configuration files in the `conf` directory, then replace the `conf` folder and synchronize the modified configurations to the corresponding locations.
228+
229+
3. Update built-in model weights (optional)
230+
231+
* If the new version involves updates to built-in models, relevant information will be updated in the [Release History](../IoTDB-Introduction/Release-history_apache.md). You may contact Timecho staff to obtain the latest weight package and replace it in the `data/ainode/models/builtin` directory.
232+
233+
4. After the upgrade is completed, you can start the AINode service and check the node status. For specific commands, refer to Sections 3.4 and 3.5.
234+
209235
## 4. AINode Build
210236

211237
AINode supports building the installation package in the following way.

src/UserGuide/Master/Table/Deployment-and-Maintenance/AINode_Deployment_Upgrade_timecho.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,9 @@
2626

2727
AINode is the third type of endogenous node provided by TimechoDB after ConfigNode and DataNode. By interacting with the DataNodes and ConfigNodes of an TimechoDB cluster, this node extends the capability for machine learning analysis on time series. AINode integrates model management, training, and inference within the database engine. It supports performing time series analysis tasks on specified time series data using registered models through simple SQL statements and also supports registering and using custom machine learning models. AINode currently integrates machine learning algorithms and self-developed models for common time series analysis scenarios (e.g., forecasting).
2828

29-
### 1.2 Delivery Method
29+
### 1.2 Deployment Modes
3030

31-
AINode is an additional suite outside the TimechoDB cluster, provided as an independent installation package.
32-
33-
### 1.3 Deployment Modes
31+
AINode is an additional component outside the TimechoDB cluster and is deployed using a separate installation package.
3432

3533
<div >
3634
<img src="/img/ainode-deployment-upgrade-timecho-1-en.png" alt="" style="width: 45%;"/>
@@ -89,7 +87,7 @@ sha512sum timechodb-2.0.6.1-ainode-bin.zip
8987
### 2.3 Environment Requirements
9088

9189
- Recommended operating environment: Linux, macOS.
92-
- TimechoDB Version: >= V2.0.8.
90+
- TimechoDB Version: >= V2.0.8-beta.
9391

9492
## 3. Installation, Deployment, and Usage
9593

@@ -242,3 +240,28 @@ IoTDB> show cluster
242240
```
243241

244242
If you need to restart the node, re-execute the startup script.
243+
244+
### 3.8 Upgrading AINode
245+
If you need to upgrade the version of the current AINode, follow these steps:
246+
247+
1. Stop the current AINode service
248+
- Run the stop command and ensure the service has completely exited before proceeding with subsequent operations.
249+
250+
```bash
251+
# Linux / MacOS
252+
bash sbin/stop-ainode.sh
253+
bash sbin/stop-ainode.sh -p <port_id> # Specify port
254+
255+
# Windows
256+
sbin\stop-ainode.bat
257+
sbin\stop-ainode.bat -p <port_id> # Specify port
258+
```
259+
260+
2. Replace core files
261+
- Delete the `lib` and `sbin` directories of the current version, then copy the `lib` and `sbin` directories from the new version to the corresponding locations.
262+
- Back up the modified configuration files in the `conf` directory, then replace the `conf` folder and synchronize your modified configurations to the corresponding files.
263+
264+
3. Update built-in model weights (optional)
265+
- If the new version includes updates to built-in models, relevant information will be announced in the [Release History](../IoTDB-Introduction/Release-history_timecho.md). You may contact Timecho staff to obtain the latest weight package, and replace it in the `data/ainode/models/builtin` directory.
266+
267+
4. After the upgrade is complete, start the AINode service and check the node status. For detailed commands, refer to Sections 3.4 and 3.6.

src/UserGuide/Master/Tree/Deployment-and-Maintenance/AINode_Deployment_Upgrade_apache.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,9 @@
2626

2727
AINode is the third type of endogenous node provided by IoTDB after ConfigNode and DataNode. By interacting with the DataNodes and ConfigNodes of an IoTDB cluster, this node extends the capability for machine learning analysis on time series. AINode integrates model management, training, and inference within the database engine. It supports performing time series analysis tasks on specified time series data using registered models through simple SQL statements and also supports registering and using custom machine learning models. AINode currently integrates machine learning algorithms and self-developed models for common time series analysis scenarios (e.g., forecasting).
2828

29-
### 1.2 Delivery Method
29+
### 1.2 Deployment Modes
3030

31-
AINode is an additional suite outside the IoTDB cluster, provided as an independent installation package.
32-
33-
### 1.3 Deployment Modes
31+
AINode is an additional component outside the IoTDB cluster and is deployed using a separate installation package.
3432

3533
<div >
3634
<img src="/img/ainode-deployment-upgrade-apache-1-en.png" alt="" style="width: 45%;"/>
@@ -85,7 +83,7 @@ To ensure the AINode installation package you obtained is complete and correct,
8583
### 2.3 Environment Requirements
8684

8785
- Recommended operating environment: Linux, macOS.
88-
- IoTDB Version: >= V2.0.8.
86+
- IoTDB Version: >= V2.0.8-beta.
8987

9088
## 3. Installation, Deployment, and Usage
9189

@@ -206,6 +204,35 @@ IoTDB> show cluster
206204

207205
If you need to restart the node, re-execute the startup script.
208206

207+
### 3.7 Upgrading AINode
208+
If you need to upgrade the version of the current AINode, you can refer to the following steps:
209+
210+
1. Stop the current AINode service
211+
212+
* Run the stop command and ensure the service has completely exited before performing subsequent operations.
213+
214+
```shell
215+
# Linux / MacOS
216+
bash sbin/stop-ainode.sh
217+
bash sbin/stop-ainode.sh -p <port_id> # Specify port
218+
219+
# Windows
220+
sbin\stop-ainode.bat
221+
sbin\stop-ainode.bat -p <port_id> # Specify port
222+
```
223+
224+
2. Replace core files
225+
226+
* Delete the `lib` and `sbin` directories of the current version, then copy the `lib` and `sbin` directories of the new version to the corresponding locations.
227+
* Back up the modified configuration files in the `conf` directory, then replace the `conf` folder and synchronize the modified configurations to the corresponding locations.
228+
229+
3. Update built-in model weights (optional)
230+
231+
* If the new version involves updates to built-in models, relevant information will be updated in the [Release History](../IoTDB-Introduction/Release-history_apache.md). You may contact Timecho staff to obtain the latest weight package and replace it in the `data/ainode/models/builtin` directory.
232+
233+
4. After the upgrade is completed, you can start the AINode service and check the node status. For specific commands, refer to Sections 3.4 and 3.5.
234+
235+
209236
## 4. AINode Build
210237

211238
AINode supports building the installation package in the following way.

src/UserGuide/Master/Tree/Deployment-and-Maintenance/AINode_Deployment_Upgrade_timecho.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,9 @@
2626

2727
AINode is the third type of endogenous node provided by TimechoDB after ConfigNode and DataNode. By interacting with the DataNodes and ConfigNodes of an TimechoDB cluster, this node extends the capability for machine learning analysis on time series. AINode integrates model management, training, and inference within the database engine. It supports performing time series analysis tasks on specified time series data using registered models through simple SQL statements and also supports registering and using custom machine learning models. AINode currently integrates machine learning algorithms and self-developed models for common time series analysis scenarios (e.g., forecasting).
2828

29-
### 1.2 Delivery Method
29+
### 1.2 Deployment Modes
3030

31-
AINode is an additional suite outside the TimechoDB cluster, provided as an independent installation package.
32-
33-
### 1.3 Deployment Modes
31+
AINode is an additional component outside the TimechoDB cluster and is deployed using a separate installation package.
3432

3533
<div >
3634
<img src="/img/ainode-deployment-upgrade-timecho-1-en.png" alt="" style="width: 45%;"/>
@@ -89,7 +87,7 @@ sha512sum timechodb-2.0.6.1-ainode-bin.zip
8987
### 2.3 Environment Requirements
9088

9189
- Recommended operating environment: Linux, macOS.
92-
- TimechoDB Version: >= V2.0.8.
90+
- TimechoDB Version: >= V2.0.8-beta.
9391

9492
## 3. Installation, Deployment, and Usage
9593

@@ -242,3 +240,28 @@ IoTDB> show cluster
242240
```
243241

244242
If you need to restart the node, re-execute the startup script.
243+
244+
### 3.8 Upgrading AINode
245+
If you need to upgrade the version of the current AINode, follow these steps:
246+
247+
1. Stop the current AINode service
248+
- Run the stop command and ensure the service has completely exited before proceeding with subsequent operations.
249+
250+
```bash
251+
# Linux / MacOS
252+
bash sbin/stop-ainode.sh
253+
bash sbin/stop-ainode.sh -p <port_id> # Specify port
254+
255+
# Windows
256+
sbin\stop-ainode.bat
257+
sbin\stop-ainode.bat -p <port_id> # Specify port
258+
```
259+
260+
2. Replace core files
261+
- Delete the `lib` and `sbin` directories of the current version, then copy the `lib` and `sbin` directories from the new version to the corresponding locations.
262+
- Back up the modified configuration files in the `conf` directory, then replace the `conf` folder and synchronize your modified configurations to the corresponding files.
263+
264+
3. Update built-in model weights (optional)
265+
- If the new version includes updates to built-in models, relevant information will be announced in the [Release History](../IoTDB-Introduction/Release-history_timecho.md). You may contact Timecho staff to obtain the latest weight package, and replace it in the `data/ainode/models/builtin` directory.
266+
267+
4. A

src/UserGuide/latest-Table/Deployment-and-Maintenance/AINode_Deployment_Upgrade_apache.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,9 @@
2626

2727
AINode is the third type of endogenous node provided by IoTDB after ConfigNode and DataNode. By interacting with the DataNodes and ConfigNodes of an IoTDB cluster, this node extends the capability for machine learning analysis on time series. AINode integrates model management, training, and inference within the database engine. It supports performing time series analysis tasks on specified time series data using registered models through simple SQL statements and also supports registering and using custom machine learning models. AINode currently integrates machine learning algorithms and self-developed models for common time series analysis scenarios (e.g., forecasting).
2828

29-
### 1.2 Delivery Method
29+
### 1.2 Deployment Modes
3030

31-
AINode is an additional suite outside the IoTDB cluster, provided as an independent installation package.
32-
33-
### 1.3 Deployment Modes
31+
AINode is an additional component outside the IoTDB cluster and is deployed using a separate installation package.
3432

3533
<div >
3634
<img src="/img/ainode-deployment-upgrade-apache-1-en.png" alt="" style="width: 45%;"/>
@@ -206,6 +204,34 @@ IoTDB> show cluster
206204

207205
If you need to restart the node, re-execute the startup script.
208206

207+
### 3.7 Upgrading AINode
208+
If you need to upgrade the version of the current AINode, you can refer to the following steps:
209+
210+
1. Stop the current AINode service
211+
212+
* Run the stop command and ensure the service has completely exited before performing subsequent operations.
213+
214+
```shell
215+
# Linux / MacOS
216+
bash sbin/stop-ainode.sh
217+
bash sbin/stop-ainode.sh -p <port_id> # Specify port
218+
219+
# Windows
220+
sbin\stop-ainode.bat
221+
sbin\stop-ainode.bat -p <port_id> # Specify port
222+
```
223+
224+
2. Replace core files
225+
226+
* Delete the `lib` and `sbin` directories of the current version, then copy the `lib` and `sbin` directories of the new version to the corresponding locations.
227+
* Back up the modified configuration files in the `conf` directory, then replace the `conf` folder and synchronize the modified configurations to the corresponding locations.
228+
229+
3. Update built-in model weights (optional)
230+
231+
* If the new version involves updates to built-in models, relevant information will be updated in the [Release History](../IoTDB-Introduction/Release-history_apache.md). You may contact Timecho staff to obtain the latest weight package and replace it in the `data/ainode/models/builtin` directory.
232+
233+
4. After the upgrade is completed, you can start the AINode service and check the node status. For specific commands, refer to Sections 3.4 and 3.5.
234+
209235
## 4. AINode Build
210236

211237
AINode supports building the installation package in the following way.

src/UserGuide/latest-Table/Deployment-and-Maintenance/AINode_Deployment_Upgrade_timecho.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,9 @@
2626

2727
AINode is the third type of endogenous node provided by TimechoDB after ConfigNode and DataNode. By interacting with the DataNodes and ConfigNodes of an TimechoDB cluster, this node extends the capability for machine learning analysis on time series. AINode integrates model management, training, and inference within the database engine. It supports performing time series analysis tasks on specified time series data using registered models through simple SQL statements and also supports registering and using custom machine learning models. AINode currently integrates machine learning algorithms and self-developed models for common time series analysis scenarios (e.g., forecasting).
2828

29-
### 1.2 Delivery Method
29+
### 1.2 Deployment Modes
3030

31-
AINode is an additional suite outside the TimechoDB cluster, provided as an independent installation package.
32-
33-
### 1.3 Deployment Modes
31+
AINode is an additional component outside the TimechoDB cluster and is deployed using a separate installation package.
3432

3533
<div >
3634
<img src="/img/ainode-deployment-upgrade-timecho-1-en.png" alt="" style="width: 45%;"/>
@@ -242,3 +240,28 @@ IoTDB> show cluster
242240
```
243241

244242
If you need to restart the node, re-execute the startup script.
243+
244+
### 3.8 Upgrading AINode
245+
If you need to upgrade the version of the current AINode, follow these steps:
246+
247+
1. Stop the current AINode service
248+
- Run the stop command and ensure the service has completely exited before proceeding with subsequent operations.
249+
250+
```bash
251+
# Linux / MacOS
252+
bash sbin/stop-ainode.sh
253+
bash sbin/stop-ainode.sh -p <port_id> # Specify port
254+
255+
# Windows
256+
sbin\stop-ainode.bat
257+
sbin\stop-ainode.bat -p <port_id> # Specify port
258+
```
259+
260+
2. Replace core files
261+
- Delete the `lib` and `sbin` directories of the current version, then copy the `lib` and `sbin` directories from the new version to the corresponding locations.
262+
- Back up the modified configuration files in the `conf` directory, then replace the `conf` folder and synchronize your modified configurations to the corresponding files.
263+
264+
3. Update built-in model weights (optional)
265+
- If the new version includes updates to built-in models, relevant information will be announced in the [Release History](../IoTDB-Introduction/Release-history_timecho.md). You may contact Timecho staff to obtain the latest weight package, and replace it in the `data/ainode/models/builtin` directory.
266+
267+
4. After the upgrade is complete, start the AINode service and check the node status. For detailed commands, refer to Sections 3.4 and 3.6.

src/UserGuide/latest/Deployment-and-Maintenance/AINode_Deployment_Upgrade_apache.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,9 @@
2626

2727
AINode is the third type of endogenous node provided by IoTDB after ConfigNode and DataNode. By interacting with the DataNodes and ConfigNodes of an IoTDB cluster, this node extends the capability for machine learning analysis on time series. AINode integrates model management, training, and inference within the database engine. It supports performing time series analysis tasks on specified time series data using registered models through simple SQL statements and also supports registering and using custom machine learning models. AINode currently integrates machine learning algorithms and self-developed models for common time series analysis scenarios (e.g., forecasting).
2828

29-
### 1.2 Delivery Method
29+
### 1.2 Deployment Modes
3030

31-
AINode is an additional suite outside the IoTDB cluster, provided as an independent installation package.
32-
33-
### 1.3 Deployment Modes
31+
AINode is an additional component outside the IoTDB cluster and is deployed using a separate installation package.
3432

3533
<div >
3634
<img src="/img/ainode-deployment-upgrade-apache-1-en.png" alt="" style="width: 45%;"/>
@@ -206,6 +204,35 @@ IoTDB> show cluster
206204

207205
If you need to restart the node, re-execute the startup script.
208206

207+
### 3.7 Upgrading AINode
208+
If you need to upgrade the version of the current AINode, you can refer to the following steps:
209+
210+
1. Stop the current AINode service
211+
212+
* Run the stop command and ensure the service has completely exited before performing subsequent operations.
213+
214+
```shell
215+
# Linux / MacOS
216+
bash sbin/stop-ainode.sh
217+
bash sbin/stop-ainode.sh -p <port_id> # Specify port
218+
219+
# Windows
220+
sbin\stop-ainode.bat
221+
sbin\stop-ainode.bat -p <port_id> # Specify port
222+
```
223+
224+
2. Replace core files
225+
226+
* Delete the `lib` and `sbin` directories of the current version, then copy the `lib` and `sbin` directories of the new version to the corresponding locations.
227+
* Back up the modified configuration files in the `conf` directory, then replace the `conf` folder and synchronize the modified configurations to the corresponding locations.
228+
229+
3. Update built-in model weights (optional)
230+
231+
* If the new version involves updates to built-in models, relevant information will be updated in the [Release History](../IoTDB-Introduction/Release-history_apache.md). You may contact Timecho staff to obtain the latest weight package and replace it in the `data/ainode/models/builtin` directory.
232+
233+
4. After the upgrade is completed, you can start the AINode service and check the node status. For specific commands, refer to Sections 3.4 and 3.5.
234+
235+
209236
## 4. AINode Build
210237

211238
AINode supports building the installation package in the following way.

0 commit comments

Comments
 (0)