Skip to content

Commit 2b74869

Browse files
authored
add memory size default description (#1082)
1 parent 52bcc49 commit 2b74869

48 files changed

Lines changed: 262 additions & 182 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: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,11 +125,18 @@ cd apache-iotdb-{version}-all-bin
125125
Edit the following files for memory allocation:
126126

127127
- **ConfigNode**: `./conf/confignode-env.sh` (or `.bat` for Windows)
128-
- **DataNode**: `./conf/datanode-env.sh` (or `.bat` for Windows)
129128

130129
| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** |
131130
| :------------ | :--------------------------------- | :---------- | :-------------- | :-------------------------------------- |
132-
| MEMORY_SIZE | Total memory allocated to the node | Empty | As needed | Save changes without immediate execution; modifications take effect after service restart. |
131+
| MEMORY_SIZE | Total memory allocated to the node | Automatically calculated based on system memory, defaulting to 30% of the system memory. | As needed | Save changes without immediate execution; modifications take effect after service restart. |
132+
133+
134+
- **DataNode**: `./conf/datanode-env.sh` (or `.bat` for Windows)
135+
136+
| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** |
137+
| :------------ | :--------------------------------- |:-----------------------------------------------------------------------------------------| :-------------- | :-------------------------------------- |
138+
| MEMORY_SIZE | Total memory allocated to the node | Automatically calculated based on system memory, defaulting to 50% of the system memory. | As needed | Save changes without immediate execution; modifications take effect after service restart. |
139+
133140

134141
#### 3.3.2 General Configuration
135142

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,11 +125,18 @@ cd timechodb-{version}-bin
125125
Edit the following files for memory allocation:
126126

127127
- **ConfigNode**: `./conf/confignode-env.sh` (or `.bat` for Windows)
128-
- **DataNode**: `./conf/datanode-env.sh` (or `.bat` for Windows)
129128

130129
| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** |
131130
| :------------ | :--------------------------------- | :---------- | :-------------- | :-------------------------------------- |
132-
| MEMORY_SIZE | Total memory allocated to the node | Empty | As needed | Save changes without immediate execution; modifications take effect after service restart. |
131+
| MEMORY_SIZE | Total memory allocated to the node | Automatically calculated based on system memory, defaulting to 30% of the system memory. | As needed | Save changes without immediate execution; modifications take effect after service restart. |
132+
133+
134+
- **DataNode**: `./conf/datanode-env.sh` (or `.bat` for Windows)
135+
136+
| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** |
137+
| :------------ | :--------------------------------- |:-----------------------------------------------------------------------------------------| :-------------- | :-------------------------------------- |
138+
| MEMORY_SIZE | Total memory allocated to the node | Automatically calculated based on system memory, defaulting to 50% of the system memory. | As needed | Save changes without immediate execution; modifications take effect after service restart. |
139+
133140

134141
#### 3.3.2 General Configuration
135142

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

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -97,12 +97,19 @@ cd apache-iotdb-{version}-all-bin
9797

9898
Edit the following files for memory allocation:
9999

100-
- **ConfigNode**: `conf/confignode-env.sh` (or `.bat` for Windows)
101-
- **DataNode**: `conf/datanode-env.sh` (or `.bat` for Windows)
100+
- **ConfigNode**: `./conf/confignode-env.sh` (or `.bat` for Windows)
101+
102+
| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** |
103+
| :------------ | :--------------------------------- | :---------- | :-------------- | :-------------------------------------- |
104+
| MEMORY_SIZE | Total memory allocated to the node | Automatically calculated based on system memory, defaulting to 30% of the system memory. | As needed | Save changes without immediate execution; modifications take effect after service restart. |
105+
106+
107+
- **DataNode**: `./conf/datanode-env.sh` (or `.bat` for Windows)
108+
109+
| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** |
110+
| :------------ | :--------------------------------- |:-----------------------------------------------------------------------------------------| :-------------- | :-------------------------------------- |
111+
| MEMORY_SIZE | Total memory allocated to the node | Automatically calculated based on system memory, defaulting to 50% of the system memory. | As needed | Save changes without immediate execution; modifications take effect after service restart. |
102112

103-
| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** |
104-
| :------------ | :---------------------------------- | :---------- | :-------------- | :---------------------- |
105-
| MEMORY_SIZE | Total memory allocated for the node | Empty | As needed | Save changes without immediate execution; modifications take effect after service restart. |
106113

107114
#### 2.3.2 General Configuration
108115

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

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,12 +95,19 @@ cd timechodb-{version}-bin
9595

9696
Edit the following files for memory allocation:
9797

98-
- **ConfigNode**: `conf/confignode-env.sh` (or `.bat` for Windows)
99-
- **DataNode**: `conf/datanode-env.sh` (or `.bat` for Windows)
98+
- **ConfigNode**: `./conf/confignode-env.sh` (or `.bat` for Windows)
99+
100+
| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** |
101+
| :------------ | :--------------------------------- | :---------- | :-------------- | :-------------------------------------- |
102+
| MEMORY_SIZE | Total memory allocated to the node | Automatically calculated based on system memory, defaulting to 30% of the system memory. | As needed | Save changes without immediate execution; modifications take effect after service restart. |
103+
104+
105+
- **DataNode**: `./conf/datanode-env.sh` (or `.bat` for Windows)
106+
107+
| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** |
108+
| :------------ | :--------------------------------- |:-----------------------------------------------------------------------------------------| :-------------- | :-------------------------------------- |
109+
| MEMORY_SIZE | Total memory allocated to the node | Automatically calculated based on system memory, defaulting to 50% of the system memory. | As needed | Save changes without immediate execution; modifications take effect after service restart. |
100110

101-
| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** |
102-
| :------------ | :---------------------------------- | :---------- | :-------------- | :---------------------- |
103-
| MEMORY_SIZE | Total memory allocated for the node | Empty | As needed | Save changes without immediate execution; modifications take effect after service restart. |
104111

105112
#### 2.3.2 General Configuration
106113

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,13 +122,13 @@ cd apache-iotdb-{version}-all-bin
122122

123123
| **配置项** | **Description** | **Default** | **Recommended value** | **Note** |
124124
| :---------- | :----------------------------------------------------------- | :---------- | :----------------------------------------------------------- | :---------------------------------- |
125-
| MEMORY_SIZE | The total amount of memory that IoTDB ConfigNode nodes can use | - | Can be filled in as needed, and the system will allocate memory based on the filled in values | Save changes without immediate execution; modifications take effect after service restart. |
125+
| MEMORY_SIZE | The total amount of memory that IoTDB ConfigNode nodes can use | Automatically calculated based on system memory, defaulting to 30% of the system memory. | Can be filled in as needed, and the system will allocate memory based on the filled in values | Save changes without immediate execution; modifications take effect after service restart. |
126126

127127
- `./conf/datanode-env.sh` configuration
128128

129-
| **Configuration** | **Description** | **Default** | **Recommended value** | **Note** |
130-
| :---------------- | :----------------------------------------------------------- | :---------- | :----------------------------------------------------------- | :---------------------------------- |
131-
| MEMORY_SIZE | The total amount of memory that IoTDB DataNode nodes can use | - | Can be filled in as needed, and the system will allocate memory based on the filled in values | Save changes without immediate execution; modifications take effect after service restart. |
129+
| **Configuration** | **Description** | **Default** | **Recommended value** | **Note** |
130+
| :---------------- | :----------------------------------------------------------- |:-----------------------------------------------------------------------------------------| :----------------------------------------------------------- | :---------------------------------- |
131+
| MEMORY_SIZE | The total amount of memory that IoTDB DataNode nodes can use | Automatically calculated based on system memory, defaulting to 50% of the system memory. | Can be filled in as needed, and the system will allocate memory based on the filled in values | Save changes without immediate execution; modifications take effect after service restart. |
132132

133133
#### General Configuration
134134

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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,11 +127,17 @@ cd timechodb-{version}-bin
127127
Edit the following files for memory allocation:
128128

129129
- **ConfigNode**: `./conf/confignode-env.sh` (or `.bat` for Windows)
130-
- **DataNode**: `./conf/datanode-env.sh` (or `.bat` for Windows)
131130

132131
| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** |
133132
| :------------ | :--------------------------------- | :---------- | :-------------- | :-------------------------------------- |
134-
| MEMORY_SIZE | Total memory allocated to the node | Empty | As needed | Save changes without immediate execution; modifications take effect after service restart. |
133+
| MEMORY_SIZE | Total memory allocated to the node | Automatically calculated based on system memory, defaulting to 30% of the system memory. | As needed | Save changes without immediate execution; modifications take effect after service restart. |
134+
135+
- **DataNode**: `./conf/datanode-env.sh` (or `.bat` for Windows)
136+
137+
| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** |
138+
| :------------ | :--------------------------------- |:-----------------------------------------------------------------------------------------| :-------------- | :-------------------------------------- |
139+
| MEMORY_SIZE | Total memory allocated to the node | Automatically calculated based on system memory, defaulting to 50% of the system memory. | As needed | Save changes without immediate execution; modifications take effect after service restart. |
140+
135141

136142
**General Configuration**
137143

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,13 +91,13 @@ cd apache-iotdb-{version}-all-bin
9191

9292
| **Configuration** | **Description** | **Default** | **Recommended value** | Note |
9393
| :---------------: | :----------------------------------------------------------: | :---------: | :----------------------------------------------------------: | :---------------------------------: |
94-
| MEMORY_SIZE | The total amount of memory that IoTDB ConfigNode nodes can use | empty | Can be filled in as needed, and the system will allocate memory based on the filled in values | Save changes without immediate execution; modifications take effect after service restart. |
94+
| MEMORY_SIZE | The total amount of memory that IoTDB ConfigNode nodes can use | Automatically calculated based on system memory, defaulting to 30% of the system memory. | Can be filled in as needed, and the system will allocate memory based on the filled in values | Save changes without immediate execution; modifications take effect after service restart. |
9595

9696
- ./conf/datanode-env.sh (./conf/datanode-env.bat) configuration
9797

98-
| **Configuration** | **Description** | **Default** | **Recommended value** | **Note** |
99-
| :---------: | :----------------------------------: | :--------: | :----------------------------------------------: | :----------: |
100-
| MEMORY_SIZE | The total amount of memory that IoTDB DataNode nodes can use | empty | Can be filled in as needed, and the system will allocate memory based on the filled in values | Save changes without immediate execution; modifications take effect after service restart. |
98+
| **Configuration** | **Description** | **Default** | **Recommended value** | **Note** |
99+
| :---------: | :----------------------------------: |:----------------------------------------------------------------------------------------:| :----------------------------------------------: | :----------: |
100+
| MEMORY_SIZE | The total amount of memory that IoTDB DataNode nodes can use | Automatically calculated based on system memory, defaulting to 50% of the system memory. | Can be filled in as needed, and the system will allocate memory based on the filled in values | Save changes without immediate execution; modifications take effect after service restart. |
101101

102102
#### System General Configuration
103103

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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,17 @@ cd timechodb-{version}-bin
9696
Edit the following files for memory allocation:
9797

9898
- **ConfigNode**: `conf/confignode-env.sh` (or `.bat` for Windows)
99-
- **DataNode**: `conf/datanode-env.sh` (or `.bat` for Windows)
10099

101100
| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** |
102101
| :------------ | :---------------------------------- | :---------- | :-------------- | :---------------------- |
103-
| MEMORY_SIZE | Total memory allocated for the node | Empty | As needed | Save changes without immediate execution; modifications take effect after service restart. |
102+
| MEMORY_SIZE | Total memory allocated for the node | Automatically calculated based on system memory, defaulting to 30% of the system memory. | As needed | Save changes without immediate execution; modifications take effect after service restart. |
103+
104+
- **DataNode**: `conf/datanode-env.sh` (or `.bat` for Windows)
105+
106+
| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** |
107+
| :------------ | :---------------------------------- |:-----------------------------------------------------------------------------------------| :-------------- | :---------------------- |
108+
| MEMORY_SIZE | Total memory allocated for the node | Automatically calculated based on system memory, defaulting to 50% of the system memory. | As needed | Save changes without immediate execution; modifications take effect after service restart. |
109+
104110

105111
#### General Configuration
106112

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,13 +121,13 @@ cd apache-iotdb-{version}-all-bin
121121

122122
| **配置项** | **Description** | **Default** | **Recommended value** | **Note** |
123123
| :---------- | :----------------------------------------------------------- | :---------- | :----------------------------------------------------------- | :---------------------------------- |
124-
| MEMORY_SIZE | The total amount of memory that IoTDB ConfigNode nodes can use | - | Can be filled in as needed, and the system will allocate memory based on the filled in values | Save changes without immediate execution; modifications take effect after service restart. |
124+
| MEMORY_SIZE | The total amount of memory that IoTDB ConfigNode nodes can use | Automatically calculated based on system memory, defaulting to 30% of the system memory. | Can be filled in as needed, and the system will allocate memory based on the filled in values | Save changes without immediate execution; modifications take effect after service restart. |
125125

126126
- `./conf/datanode-env.sh` configuration
127127

128-
| **Configuration** | **Description** | **Default** | **Recommended value** | **Note** |
129-
| :---------------- | :----------------------------------------------------------- | :---------- | :----------------------------------------------------------- | :---------------------------------- |
130-
| MEMORY_SIZE | The total amount of memory that IoTDB DataNode nodes can use | - | Can be filled in as needed, and the system will allocate memory based on the filled in values | Save changes without immediate execution; modifications take effect after service restart. |
128+
| **Configuration** | **Description** | **Default** | **Recommended value** | **Note** |
129+
| :---------------- | :----------------------------------------------------------- |:-----------------------------------------------------------------------------------------| :----------------------------------------------------------- | :---------------------------------- |
130+
| MEMORY_SIZE | The total amount of memory that IoTDB DataNode nodes can use | Automatically calculated based on system memory, defaulting to 50% of the system memory. | Can be filled in as needed, and the system will allocate memory based on the filled in values | Save changes without immediate execution; modifications take effect after service restart. |
131131

132132
#### General Configuration
133133

0 commit comments

Comments
 (0)