Skip to content

Commit c3fc642

Browse files
authored
Deployment and Maintenance Module English PR (#575)
1 parent 6f14741 commit c3fc642

46 files changed

Lines changed: 4492 additions & 3027 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

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

Lines changed: 349 additions & 0 deletions
Large diffs are not rendered by default.

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

Lines changed: 248 additions & 238 deletions
Large diffs are not rendered by default.

src/UserGuide/Master/Table/Deployment-and-Maintenance/Database-Resources.md

Lines changed: 59 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -19,50 +19,50 @@
1919
2020
-->
2121
# Database Resources
22-
## CPU
22+
## 1 CPU
2323
<table style="text-align: center;">
2424
<tbody>
2525
<tr>
26-
<th rowspan="2">Number of timeseries (frequency<=1HZ)</th>
26+
<th rowspan="2">Number of timeseries (frequency&lt;=1HZ)</th>
2727
<th rowspan="2">CPU</th>
2828
<th colspan="3">Number of nodes</th>
2929
</tr>
3030
<tr>
31-
<th>standalone mode</th>
32-
<th>Double active</th>
31+
<th>standalone</th>
32+
<th>Dual-Active</th>
3333
<th>Distributed</th>
3434
</tr>
3535
<tr>
3636
<td>Within 100000</td>
37-
<td>2core-4core</td>
37+
<td>2-4 cores</td>
3838
<td>1</td>
3939
<td>2</td>
4040
<td>3</td>
4141
</tr>
4242
<tr>
4343
<td>Within 300000</td>
44-
<td>4core-8core</td>
44+
<td>4-8 cores</td>
4545
<td>1</td>
4646
<td>2</td>
4747
<td>3</td>
4848
</tr>
4949
<tr>
5050
<td>Within 500000</td>
51-
<td>8core-26core</td>
51+
<td>8-16 cores</td>
5252
<td>1</td>
5353
<td>2</td>
5454
<td>3</td>
5555
</tr>
5656
<tr>
5757
<td>Within 1000000</td>
58-
<td>16core-32core</td>
58+
<td>16-32 cores</td>
5959
<td>1</td>
6060
<td>2</td>
6161
<td>3</td>
6262
</tr>
6363
<tr>
6464
<td>Within 2000000</td>
65-
<td>32core-48core</td>
65+
<td>32-48 cores</td>
6666
<td>1</td>
6767
<td>2</td>
6868
<td>3</td>
@@ -81,50 +81,50 @@
8181
</tbody>
8282
</table>
8383

84-
## Memory
84+
## 2 Memory
8585
<table style="text-align: center;">
8686
<tbody>
8787
<tr>
88-
<th rowspan="2">Number of timeseries (frequency<=1HZ)</th>
88+
<th rowspan="2">Number of timeseries (frequency&lt;=1HZ)</th>
8989
<th rowspan="2">Memory</th>
9090
<th colspan="3">Number of nodes</th>
9191
</tr>
9292
<tr>
93-
<th>standalone mode</th>
94-
<th>Double active</th>
93+
<th>standalone</th>
94+
<th>Dual-Active</th>
9595
<th>Distributed</th>
9696
</tr>
9797
<tr>
9898
<td>Within 100000</td>
99-
<td>4G-8G</td>
99+
<td>4-8G</td>
100100
<td>1</td>
101101
<td>2</td>
102102
<td>3</td>
103103
</tr>
104104
<tr>
105105
<td>Within 300000</td>
106-
<td>12G-32G</td>
106+
<td>12-32G</td>
107107
<td>1</td>
108108
<td>2</td>
109109
<td>3</td>
110110
</tr>
111111
<tr>
112112
<td>Within 500000</td>
113-
<td>24G-48G</td>
113+
<td>24-48G</td>
114114
<td>1</td>
115115
<td>2</td>
116116
<td>3</td>
117117
</tr>
118118
<tr>
119119
<td>Within 1000000</td>
120-
<td>32G-96G</td>
120+
<td>32-96G</td>
121121
<td>1</td>
122122
<td>2</td>
123123
<td>3</td>
124124
</tr>
125125
<tr>
126126
<td>Within 2000000</td>
127-
<td>64G-128G</td>
127+
<td>64-128G</td>
128128
<td>1</td>
129129
<td>2</td>
130130
<td>3</td>
@@ -143,19 +143,23 @@
143143
</tbody>
144144
</table>
145145

146-
## Storage (Disk)
147-
### Storage space
148-
Calculation formula: Number of measurement points * Sampling frequency (Hz) * Size of each data point (Byte, different data types may vary, see table below) * Storage time (seconds) * Number of copies (usually 1 copy for a single node and 2 copies for a cluster) ÷ Compression ratio (can be estimated at 5-10 times, but may be higher in actual situations)
146+
## 3 Storage (Disk)
147+
### 3.1 Storage space
148+
Calculation Formula:
149+
150+
```Plain
151+
Storage Space = Number of Measurement Points * Sampling Frequency (Hz) * Size of Each Data Point (Bytes, see the table below) * Storage Duration * Replication Factor / Compression Ratio
152+
```
153+
154+
Data Point Size Calculation Table:
155+
149156
<table style="text-align: center;">
150157
<tbody>
151158
<tr>
152-
<th colspan="4">Data point size calculation</th>
153-
</tr>
154-
<tr>
155-
<th>data type</th>
159+
<th>Data Type</th>
156160
<th>Timestamp (Bytes)</th>
157161
<th> Value (Bytes)</th>
158-
<th> Total size of data points (in bytes)
162+
<th> Total Data Point Size (Bytes)
159163
</th>
160164
</tr>
161165
<tr>
@@ -165,36 +169,48 @@ Calculation formula: Number of measurement points * Sampling frequency (Hz) * Si
165169
<td>9</td>
166170
</tr>
167171
<tr>
168-
<td> INT32/FLOAT</td>
172+
<td> INT32 / FLOAT (Single Precision)</td>
169173
<td>8</td>
170174
<td>4</td>
171175
<td>12</td>
172176
</tr>
173177
<tr>
174-
<td>INT64/DOUBLE</td>
178+
<td>INT64 / DOUBLE (Double Precision)</td>
175179
<td>8</td>
176180
<td>8</td>
177181
<td>16</td>
178182
</tr>
179183
<tr>
180-
<td>TEXT</td>
184+
<td>TEXT (String)</td>
181185
<td>8</td>
182-
<td>The average is a</td>
186+
<td>Average = a</td>
183187
<td>8+a</td>
184188
</tr>
185189
</tbody>
186190
</table>
191+
Example:
192+
193+
- Scenario: 1,000 devices, 100 measurement points per device, i.e. 100,000 sequences in total. Data type is INT32. Sampling frequency is 1Hz (once per second). Storage duration is 1 year. Replication factor is 3.
194+
- Full Calculation:
195+
```Plain
196+
1,000 devices * 100 measurement points * 12 bytes per data point * 86,400 seconds per day * 365 days per year * 3 replicas / 10 compression ratio = 11 TB
197+
```
198+
- Simplified Calculation:
199+
```Plain
200+
1,000 * 100 * 12 * 86,400 * 365 * 3 / 10 = 11 TB
201+
```
202+
### 3.2 Storage Configuration
203+
204+
- For systems with > 10 million measurement points or high query loads, SSD is recommended.
205+
206+
## 4 Network (NIC)
207+
When the write throughput does not exceed 10 million points per second, a gigabit network card is required. When the write throughput exceeds 10 million points per second, a 10-gigabit network card is required.
208+
209+
| **Write** **Throughput** **(Data Points/Second)** | **NIC** **Speed** |
210+
| ------------------------------------------------- | -------------------- |
211+
| < 10 million | 1 Gbps (Gigabit) |
212+
| ≥ 10 million | 10 Gbps (10 Gigabit) |
213+
214+
## 5 Additional Notes
187215
188-
Example: 1000 devices, each with 100 measurement points, a total of 100000 sequences, INT32 type. Sampling frequency 1Hz (once per second), storage for 1 year, 3 copies.
189-
- Complete calculation formula: 1000 devices * 100 measurement points * 12 bytes per data point * 86400 seconds per day * 365 days per year * 3 copies / 10 compression ratio / 1024 / 1024 / 1024 / 1024 =11T
190-
- Simplified calculation formula: 1000 * 100 * 12 * 86400 * 365 * 3 / 10 / 1024 / 1024 / 1024 / 1024 =11T
191-
### Storage Configuration
192-
If the number of nodes is over 10000000 or the query load is high, it is recommended to configure SSD
193-
## Network (Network card)
194-
If the write throughput does not exceed 10 million points/second, configure 1Gbps network card. When the write throughput exceeds 10 million points per second, a 10Gbps network card needs to be configured.
195-
| **Write throughput (data points per second)** | **NIC rate** |
196-
| ------------------- | ------------- |
197-
| <10 million | 1Gbps |
198-
| >=10 million | 10Gbps |
199-
## Other instructions
200-
IoTDB has the ability to scale up clusters in seconds, and expanding node data does not require migration. Therefore, you do not need to worry about the limited cluster capacity estimated based on existing data. In the future, you can add new nodes to the cluster when you need to scale up.
216+
- IoTDB supports second-level cluster scaling . Data migration is not required when adding new nodes, so there is no need to worry about limited cluster capacity based on current data estimates. You can add new nodes to the cluster when scaling is needed in the future.
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
21+
# Deployment-Mode_apache
22+
23+
IoTDB has two operation modes: standalone mode and cluster mode.
24+
25+
## 1 Standalone Mode
26+
27+
An IoTDB standalone instance includes 1 ConfigNode and 1 DataNode, referred to as 1C1D.
28+
29+
- **Features**: Easy for developers to install and deploy, with lower deployment and maintenance costs, and convenient operation.
30+
- **Applicable scenarios**: Situations with limited resources or where high availability is not a critical requirement, such as edge servers.
31+
- **Deployment method**:[Stand-Alone Deployment](../Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md)
32+
33+
34+
## 2 Cluster Mode
35+
36+
An IoTDB cluster instance consists of 3 ConfigNodes and no fewer than 3 DataNodes, typically 3 DataNodes, referred to as 3C3D. In the event of partial node failures, the remaining nodes can still provide services, ensuring high availability of the database service, and the database performance can be improved with the addition of nodes.
37+
38+
- **Features**: High availability and scalability, with the ability to enhance system performance by adding DataNodes.
39+
- **Applicable scenarios**: Enterprise-level application scenarios that require high availability and reliability.
40+
- **Deployment method**: [Cluster Deployment](../Deployment-and-Maintenance/Cluster-Deployment_apache.md)
41+
42+
## 3 Summary of Features
43+
44+
| **Dimension** | **Stand-Alone Mode** | **Cluster Mode** |
45+
| :-------------------------- | :----------------------------------------------------- | :----------------------------------------------------------- |
46+
| Applicable Scenario | Edge deployment, low requirement for high availability | High-availability business, disaster recovery scenarios, etc. |
47+
| Number of Machines Required | 1 | ≥3 |
48+
| Security and Reliability | Cannot tolerate single-point failure | High, can tolerate single-point failure |
49+
| Scalability | Scalable by adding DataNodes to improve performance | Scalable by adding DataNodes to improve performance |
50+
| Performance | Scalable with the number of DataNodes | Scalable with the number of DataNodes |
51+
52+
- The deployment steps for standalone mode and cluster mode are similar (adding ConfigNodes and DataNodes one by one), with the only differences being the number of replicas and the minimum number of nodes required to provide services.
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
21+
# Deployment-Mode_apache
22+
23+
IoTDB has two operation modes: standalone mode and cluster mode.
24+
25+
## 1 Standalone Mode
26+
27+
An IoTDB standalone instance includes 1 ConfigNode and 1 DataNode, i.e., 1C1D.
28+
29+
- **Features**: Easy for developers to install and deploy, with low deployment and maintenance costs and convenient operations.
30+
- **Use Cases**: Scenarios with limited resources or low high-availability requirements, such as edge servers.
31+
- **Deployment Method**: [Stand-Alone Deployment](../Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md)
32+
33+
## 2 Dual-Active Mode
34+
35+
Dual-Active Deployment is a feature of TimechoDB, where two independent instances synchronize bidirectionally and can provide services simultaneously. If one instance stops and restarts, the other instance will resume data transfer from the breakpoint.
36+
37+
> An IoTDB Dual-Active instance typically consists of 2 standalone nodes, i.e., 2 sets of 1C1D. Each instance can also be a cluster.
38+
39+
- **Features**: The high-availability solution with the lowest resource consumption.
40+
- **Use Cases**: Scenarios with limited resources (only two servers) but requiring high availability.
41+
- **Deployment Method**: [Dual-Active Deployment](../Deployment-and-Maintenance/Dual-Active-Deployment_timecho.md)
42+
43+
## 3 Cluster Mode
44+
45+
An IoTDB cluster instance consists of 3 ConfigNodes and no fewer than 3 DataNodes, typically 3 DataNodes, i.e., 3C3D. If some nodes fail, the remaining nodes can still provide services, ensuring high availability of the database. Performance can be improved by adding DataNodes.
46+
47+
- **Features**: High availability, high scalability, and improved system performance by adding DataNodes.
48+
- **Use Cases**: Enterprise-level application scenarios requiring high availability and reliability.
49+
- **Deployment Method**: [Cluster Deployment](../Deployment-and-Maintenance/Cluster-Deployment_timecho.md)
50+
51+
52+
53+
## 4 Feature Summary
54+
55+
| **Dimension** | **Stand-Alone Mode** | **Dual-Active Mode** | **Cluster Mode** |
56+
| :-------------------------- | :------------------------------------------------------- | :------------------------------------------------------ | :------------------------------------------------------ |
57+
| Use Cases | Edge-side deployment, low high-availability requirements | High-availability services, disaster recovery scenarios | High-availability services, disaster recovery scenarios |
58+
| Number of Machines Required | 1 | 2 | ≥3 |
59+
| Security and Reliability | Cannot tolerate single-point failure | High, can tolerate single-point failure | High, can tolerate single-point failure |
60+
| Scalability | Can expand DataNodes to improve performance | Each instance can be scaled as needed | Can expand DataNodes to improve performance |
61+
| Performance | Can scale with the number of DataNodes | Same as one of the instances | Can scale with the number of DataNodes |
62+
63+
- The deployment steps for Stand-Alone Mode and Cluster Mode are similar (adding ConfigNodes and DataNodes one by one), with differences only in the number of replicas and the minimum number of nodes required to provide services.

0 commit comments

Comments
 (0)