Skip to content

Commit b824a13

Browse files
leto-bleto-b
authored
update cluster activation via cli (#796)
* update cluster activation via cli * Adjust the order of activation methods * adjust activate database of 1.3.x
1 parent 7efe9ea commit b824a13

File tree

24 files changed

+716
-353
lines changed

24 files changed

+716
-353
lines changed

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

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -159,15 +159,9 @@ On each server, navigate to the `sbin` directory and start the DataNode:
159159

160160
### 3.6 Activate the Database
161161

162-
#### Option 1: File-Based Activation
162+
#### Option 1: Command-Based Activation
163163

164-
1. Start all ConfigNodes and DataNodes.
165-
2. Copy the `system_info` file from the `activation` directory on each server and send them to the Timecho team.
166-
3. Place the license files provided by the Timecho team into the corresponding `activation` folder for each node.
167-
168-
#### Option 2: Command-Based Activation
169-
170-
1. Enter the IoTDB CLI for each node:
164+
1. Enter the IoTDB CLI on any node of the cluster:
171165
- **For Table Model**:
172166
```SQL
173167
# For Linux or macOS
@@ -177,22 +171,14 @@ On each server, navigate to the `sbin` directory and start the DataNode:
177171
./start-cli.bat -sql_dialect table
178172
```
179173

180-
- **For Tree Model**:
181-
```SQL
182-
# For Linux or macOS
183-
./start-cli.sh
184-
185-
# For Windows
186-
./start-cli.bat
187-
```
188174
2. Run the following command to retrieve the machine code required for activation:
189175

190176
```Bash
191177
show system info
192178
```
193179

194180

195-
3. Copy the returned machine code of each server (displayed as a green string) and send it to the Timecho team:
181+
3. Copy the returned machine codes of all nodes in the cluster (displayed as a green string) and send it to the Timecho team:
196182

197183
```Bash
198184
+--------------------------------------------------------------+
@@ -210,6 +196,14 @@ It costs 0.030s
210196
IoTDB> activate '01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA===,01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA===,01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA==='
211197
```
212198
199+
200+
#### Option 2: File-Based Activation
201+
202+
1. Start all ConfigNodes and DataNodes.
203+
2. Copy the `system_info` file from the `activation` directory on each server and send them to the Timecho team.
204+
3. Place the license files provided by the Timecho team into the corresponding `activation` folder for each node.
205+
206+
213207
### 3.7 Verify Activation
214208
215209
Check the `ClusterActivationStatus` field. If it shows `ACTIVATED`, the database has been successfully activated.

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

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -126,14 +126,7 @@ Navigate to the `sbin` directory of IoTDB and start the DataNode:
126126

127127
### 2.5 Activate the Database
128128

129-
#### Option 1: File-Based Activation
130-
131-
- Start both the ConfigNode and DataNode.
132-
- Navigate to the `activation` folder and copy the `system_info` file.
133-
- Send the `system_info` file to the Timecho team.
134-
- Place the license file provided by the Timecho team into the corresponding `activation` folder for each node.
135-
136-
#### Option 2: Command-Based Activation
129+
#### Option 1: Command-Based Activation
137130

138131
1. Enter the IoTDB CLI.
139132
- **For Table Model**:
@@ -145,14 +138,6 @@ Navigate to the `sbin` directory of IoTDB and start the DataNode:
145138
./start-cli.bat -sql_dialect table
146139
```
147140

148-
- **For Tree Model**:
149-
- ```SQL
150-
# For Linux or macOS
151-
./start-cli.sh
152-
153-
# For Windows
154-
./start-cli.bat
155-
```
156141
2. Run the following command to retrieve the machine code required for activation:
157142

158143
```Bash
@@ -177,6 +162,15 @@ It costs 0.030s
177162
IoTDB> activate '01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA==='
178163
```
179164
165+
166+
#### Option 2: File-Based Activation
167+
168+
- Start both the ConfigNode and DataNode.
169+
- Navigate to the `activation` folder and copy the `system_info` file.
170+
- Send the `system_info` file to the Timecho team.
171+
- Place the license file provided by the Timecho team into the corresponding `activation` folder for each node.
172+
173+
180174
### 2.6 Verify Activation
181175
182176
Check the `ClusterActivationStatus` field. If it shows `ACTIVATED`, the database has been successfully activated.

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

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -161,25 +161,9 @@ cd sbin
161161

162162
### 3.6 Activate Database
163163

164-
#### Option 1: File-Based Activation
164+
#### Option 1: Command-Based Activation
165165

166-
1. Start all ConfigNodes and DataNodes.
167-
2. Copy the `system_info` file from the `activation` directory on each server and send them to the Timecho team.
168-
3. Place the license files provided by the Timecho team into the corresponding `activation` folder for each node.
169-
170-
#### Option 2: Command-Based Activation
171-
172-
1. Enter the IoTDB CLI for each node:
173-
174-
- **For Table Model**:
175-
176-
```SQL
177-
# For Linux or macOS
178-
./start-cli.sh -sql_dialect table
179-
180-
# For Windows
181-
./start-cli.bat -sql_dialect table
182-
```
166+
1. Enter the IoTDB CLI on any node of the cluster:
183167

184168
- **For Tree Model**:
185169

@@ -197,7 +181,7 @@ cd sbin
197181
show system info
198182
```
199183

200-
3. Copy the returned machine code of each server (displayed as a green string) and send it to the Timecho team:
184+
3. Copy the returned machine codes of all nodes in the cluster (displayed as a green string) and send it to the Timecho team:
201185

202186
```Bash
203187
+--------------------------------------------------------------+
@@ -215,6 +199,14 @@ cd sbin
215199
IoTDB> activate '01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA===,01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA===,01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA==='
216200
```
217201
202+
203+
#### Option 2: File-Based Activation
204+
205+
1. Start all ConfigNodes and DataNodes.
206+
2. Copy the `system_info` file from the `activation` directory on each server and send them to the Timecho team.
207+
3. Place the license files provided by the Timecho team into the corresponding `activation` folder for each node.
208+
209+
218210
### 3.7 Verify Activation
219211
220212
Check the `ClusterActivationStatus` field. If it shows `ACTIVATED`, the database has been successfully activated.

‎src/UserGuide/Master/Tree/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md‎

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -124,27 +124,10 @@ Navigate to the `sbin` directory of IoTDB and start the DataNode:
124124

125125
### 2.5 Activate Database
126126

127-
#### Option 1: File-Based Activation
128-
129-
1. Start both the ConfigNode and DataNode.
130-
2. Navigate to the `activation` folder and copy the `system_info` file.
131-
3. Send the `system_info` file to the Timecho team.
132-
4. Place the license file provided by the Timecho team into the corresponding `activation` folder for each node.
133-
134-
#### Option 2: Command-Based Activation
127+
#### Option 1: Command-Based Activation
135128

136129
1. Enter the IoTDB CLI.
137130

138-
- **For Table Model**:
139-
140-
```SQL
141-
# For Linux or macOS
142-
./start-cli.sh -sql_dialect table
143-
144-
# For Windows
145-
./start-cli.bat -sql_dialect table
146-
```
147-
148131
- **For Tree Model**:
149132

150133
```SQL
@@ -179,6 +162,15 @@ It costs 0.030s
179162
IoTDB> activate '01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA==='
180163
```
181164

165+
166+
#### Option 2: File-Based Activation
167+
168+
1. Start both the ConfigNode and DataNode.
169+
2. Navigate to the `activation` folder and copy the `system_info` file.
170+
3. Send the `system_info` file to the Timecho team.
171+
4. Place the license file provided by the Timecho team into the corresponding `activation` folder for each node.
172+
173+
182174
### 2.6 Verify Activation
183175

184176
Check the `ClusterActivationStatus` field. If it shows `ACTIVATED`, the database has been successfully activated.

‎src/UserGuide/V1.3.x/Deployment-and-Maintenance/Cluster-Deployment_timecho.md‎

Lines changed: 66 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -133,27 +133,87 @@ Open DataNode Configuration File `./conf/iotdb-system.properties`,Set the follow
133133

134134
> ❗️Attention: Editors such as VSCode Remote do not have automatic configuration saving function. Please ensure that the modified files are saved persistently, otherwise the configuration items will not take effect
135135
136-
### Start ConfigNode
136+
### Start and Activate Database (Available since V1.3.4)
137+
138+
#### Start ConfigNode
137139

138140
Start the first confignode of IoTDB-1 first, ensuring that the seed confignode node starts first, and then start the second and third confignode nodes in sequence
139141

140142
```Bash
141-
cd sbin
142143
./start-confignode.sh -d #"- d" parameter will start in the background
143144
```
144145

145146
If the startup fails, please refer to [Common Questions](#common-questions).
146147

148+
#### Start DataNode
149+
150+
Enter the `sbin` directory of iotdb and start three datanode nodes in sequence:
151+
152+
```Bash
153+
./start-datanode.sh -d #"- d" parameter will start in the background
154+
```
155+
156+
#### Activate Database
157+
158+
##### Activation via CLI
159+
160+
- Enter the CLI of any node in the cluster
161+
162+
```SQL
163+
./sbin/start-cli.sh
164+
```
165+
166+
- Obtain the machine codes of all nodes:
167+
168+
- Execute the following command to get the machine codes required for activation:
169+
170+
```Bash
171+
show system info
172+
```
173+
174+
- The machine codes of all nodes in the cluster will be displayed:
175+
176+
```Bash
177+
+--------------------------------------------------------------+
178+
| SystemInfo|
179+
+--------------------------------------------------------------+
180+
|01-TE5NLES4-UDDWCMYE,01-GG5NLES4-XXDWCMYE,01-FF5NLES4-WWWWCMYE|
181+
+--------------------------------------------------------------+
182+
Total line number = 1
183+
It costs 0.030s
184+
```
185+
186+
- Copy the obtained machine codes and provide them to the Timecho team
187+
188+
- The Timecho team will return an activation code, which normally corresponds to the order of the provided machine codes. Paste the complete activation code into the CLI for activation
189+
190+
- Note: The activation code must be enclosed in ' symbols, as shown below:
191+
192+
```Bash
193+
IoTDB> activate '01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA===,01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA===,01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA==='
194+
```
195+
196+
### Start and Activate Database (Available before V1.3.4)
197+
198+
#### Start ConfigNode
199+
200+
Start the first confignode of IoTDB-1 first, ensuring that the seed confignode node starts first, and then start the second and third confignode nodes in sequence
201+
202+
```Bash
203+
./start-confignode.sh -d #"- d" parameter will start in the background
204+
```
205+
206+
If the startup fails, please refer to [Common Questions](#common-questions).
147207
148-
### Activate Database
208+
#### Activate Database
149209
150-
#### Method 1: Activate file copy activation
210+
##### Method 1: Activate file copy activation
151211
152212
- After starting three confignode nodes in sequence, copy the `activation` folder of each machine and the `system_info` file of each machine to the Timecho staff;
153213
- The staff will return the license files for each ConfigNode node, where 3 license files will be returned;
154214
- Put the three license files into the `activation` folder of the corresponding ConfigNode node;
155215
156-
#### Method 2: Activate Script Activation
216+
##### Method 2: Activate Script Activation
157217
158218
- Obtain the machine codes of three machines in sequence, enter the `sbin` directory of the installation directory, and execute the activation script `start activate.sh`:
159219
@@ -180,12 +240,11 @@ If the startup fails, please refer to [Common Questions](#common-questions).
180240
Import completed. Please start cluster and excute 'show cluster' to verify activation status
181241
```
182242

183-
### Start DataNode
243+
#### Start DataNode
184244

185245
Enter the `sbin` directory of iotdb and start three datanode nodes in sequence:
186246

187247
```Bash
188-
cd sbin
189248
./start-datanode.sh -d #"- d" parameter will start in the background
190249
```
191250

0 commit comments

Comments
 (0)