Skip to content

Commit e9b0833

Browse files
authored
docs: remove object and tiered storage configuration (#1232)
1 parent 4f12f6d commit e9b0833

8 files changed

Lines changed: 228 additions & 1124 deletions

File tree

‎src/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md‎

Lines changed: 29 additions & 141 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ The environment configuration files (`confignode-env.sh/bat` and `datanode-env.s
128128

129129
## 4. System Parameters (`iotdb-system.properties.template`)
130130

131-
The `iotdb-system.properties` file contains various configurations for managing IoTDB clusters, nodes, replication, directories, monitoring, SSL, connections, object storage, tier management, and REST services. Below is a detailed breakdown of the parameters:
131+
The `iotdb-system.properties` file contains various configurations for managing IoTDB clusters, nodes, replication, directories, monitoring, SSL, connections, and REST services. Below is a detailed breakdown of the parameters:
132132

133133
### 4.1 Cluster Configuration
134134

@@ -705,119 +705,7 @@ The `iotdb-system.properties` file contains various configurations for managing
705705
| Default | 300 |
706706
| Effective | Restart required. |
707707

708-
### 4.9 Object storage management
709-
710-
- remote_tsfile_cache_dirs
711-
712-
| Name | remote_tsfile_cache_dirs |
713-
| ----------- | ---------------------------------------- |
714-
| Description | Local cache directory for cloud storage. |
715-
| Type | String |
716-
| Default | data/datanode/data/cache |
717-
| Effective | Restart required. |
718-
719-
- remote_tsfile_cache_page_size_in_kb
720-
721-
| Name | remote_tsfile_cache_page_size_in_kb |
722-
| ----------- | --------------------------------------------- |
723-
| Description | Block size for cached files in cloud storage. |
724-
| Type | int |
725-
| Default | 20480 |
726-
| Effective | Restart required. |
727-
728-
- remote_tsfile_cache_max_disk_usage_in_mb
729-
730-
| Name | remote_tsfile_cache_max_disk_usage_in_mb |
731-
| ----------- | ------------------------------------------- |
732-
| Description | Maximum disk usage for cloud storage cache. |
733-
| Type | long |
734-
| Default | 51200 |
735-
| Effective | Restart required. |
736-
737-
- object_storage_type
738-
739-
| Name | object_storage_type |
740-
| ----------- | ---------------------- |
741-
| Description | Type of cloud storage. |
742-
| Type | String |
743-
| Default | AWS_S3 |
744-
| Effective | Restart required. |
745-
746-
- object_storage_endpoint
747-
748-
| Name | object_storage_endpoint |
749-
| ----------- | --------------------------- |
750-
| Description | Endpoint for cloud storage. |
751-
| Type | String |
752-
| Default | None |
753-
| Effective | Restart required. |
754-
755-
- object_storage_bucket
756-
757-
| Name | object_storage_bucket |
758-
| ----------- | ------------------------------ |
759-
| Description | Bucket name for cloud storage. |
760-
| Type | String |
761-
| Default | iotdb_data |
762-
| Effective | Restart required. |
763-
764-
- object_storage_access_key
765-
766-
| Name | object_storage_access_key |
767-
| ----------- | ----------------------------- |
768-
| Description | Access key for cloud storage. |
769-
| Type | String |
770-
| Default | None |
771-
| Effective | Restart required. |
772-
773-
- object_storage_access_secret
774-
775-
| Name | object_storage_access_secret |
776-
| ----------- | -------------------------------- |
777-
| Description | Access secret for cloud storage. |
778-
| Type | String |
779-
| Default | None |
780-
| Effective | Restart required. |
781-
782-
### 4.10 Tier management
783-
784-
- dn_default_space_usage_thresholds
785-
786-
| Name | dn_default_space_usage_thresholds |
787-
| ----------- | ------------------------------------------------------------ |
788-
| Description | Disk usage threshold, data will be moved to the next tier when the usage of the tier is higher than this threshold.If tiered storage is enabled, please separate thresholds of different tiers by semicolons ";". |
789-
| Type | double |
790-
| Default | 0.85 |
791-
| Effective | Hot reload. |
792-
793-
- dn_tier_full_policy
794-
795-
| Name | dn_tier_full_policy |
796-
| ----------- | ------------------------------------------------------------ |
797-
| Description | How to deal with the last tier's data when its used space has been higher than its dn_default_space_usage_thresholds. |
798-
| Type | String |
799-
| Default | NULL |
800-
| Effective | Hot reload. |
801-
802-
- migrate_thread_count
803-
804-
| Name | migrate_thread_count |
805-
| ----------- | ------------------------------------------------------------ |
806-
| Description | thread pool size for migrate operation in the DataNode's data directories. |
807-
| Type | int |
808-
| Default | 1 |
809-
| Effective | Hot reload. |
810-
811-
- tiered_storage_migrate_speed_limit_bytes_per_sec
812-
813-
| Name | tiered_storage_migrate_speed_limit_bytes_per_sec |
814-
| ----------- | ------------------------------------------------------------ |
815-
| Description | The migrate speed limit of different tiers can reach per second |
816-
| Type | int |
817-
| Default | 10485760 |
818-
| Effective | Hot reload. |
819-
820-
### 4.11 REST Service Configuration
708+
### 4.9 REST Service Configuration
821709

822710
- enable_rest_service
823711

@@ -918,7 +806,7 @@ The `iotdb-system.properties` file contains various configurations for managing
918806
| Default | 5000 |
919807
| Effective | Restart required. |
920808

921-
### 4.12 Load balancing configuration
809+
### 4.10 Load balancing configuration
922810

923811
- series_slot_num
924812

@@ -1010,7 +898,7 @@ The `iotdb-system.properties` file contains various configurations for managing
1010898
| Default | true |
1011899
| Effective | Restart required. |
1012900

1013-
### 4.13 Cluster management
901+
### 4.11 Cluster management
1014902

1015903
- time_partition_origin
1016904

@@ -1051,7 +939,7 @@ The `iotdb-system.properties` file contains various configurations for managing
1051939
| Default | 0.05 |
1052940
| Effective | Restart required. |
1053941

1054-
### 4.14 Memory Control Configuration
942+
### 4.12 Memory Control Configuration
1055943

1056944
- datanode_memory_proportion
1057945

@@ -1179,7 +1067,7 @@ The `iotdb-system.properties` file contains various configurations for managing
11791067
| Default | true |
11801068
| Effective | Hot reload. |
11811069

1182-
### 4.15 Schema Engine Configuration
1070+
### 4.13 Schema Engine Configuration
11831071

11841072
- schema_engine_mode
11851073

@@ -1271,7 +1159,7 @@ The `iotdb-system.properties` file contains various configurations for managing
12711159
| Default | -1 |
12721160
| Effective | Restart required. |
12731161

1274-
### 4.16 Configurations for creating schema automatically
1162+
### 4.14 Configurations for creating schema automatically
12751163

12761164
- enable_auto_create_schema
12771165

@@ -1437,7 +1325,7 @@ The `iotdb-system.properties` file contains various configurations for managing
14371325
| Effective | Hot_reload |
14381326

14391327

1440-
### 4.17 Query Configurations
1328+
### 4.15 Query Configurations
14411329

14421330
- read_consistency_level
14431331

@@ -1619,7 +1507,7 @@ The `iotdb-system.properties` file contains various configurations for managing
16191507
| Default | 10 |
16201508
| Effective | Hot reload |
16211509

1622-
### 4.18 TTL Configuration
1510+
### 4.16 TTL Configuration
16231511

16241512
- ttl_check_interval
16251513

@@ -1648,7 +1536,7 @@ The `iotdb-system.properties` file contains various configurations for managing
16481536
| Default | 0.3 |
16491537
| Effective | Restart required. |
16501538

1651-
### 4.19 Storage Engine Configuration
1539+
### 4.17 Storage Engine Configuration
16521540

16531541
- timestamp_precision
16541542

@@ -1813,7 +1701,7 @@ The `iotdb-system.properties` file contains various configurations for managing
18131701
| Effective | Restart required. |
18141702

18151703

1816-
### 4.20 Compaction Configurations
1704+
### 4.18 Compaction Configurations
18171705

18181706
- enable_seq_space_compaction
18191707

@@ -2121,7 +2009,7 @@ The `iotdb-system.properties` file contains various configurations for managing
21212009
| Default | 4 |
21222010
| Effective | Hot reload |
21232011

2124-
### 4.21 Write Ahead Log Configuration
2012+
### 4.19 Write Ahead Log Configuration
21252013

21262014
- wal_mode
21272015

@@ -2249,7 +2137,7 @@ The `iotdb-system.properties` file contains various configurations for managing
22492137
| Default | true |
22502138
| Effective | Hot reload |
22512139

2252-
### 4.22 **IoTConsensus Configuration**
2140+
### 4.20 **IoTConsensus Configuration**
22532141

22542142
- data_region_iot_max_log_entries_num_per_batch
22552143

@@ -2296,7 +2184,7 @@ The `iotdb-system.properties` file contains various configurations for managing
22962184
| Default | 33554432 |
22972185
| Effective | Restart required. |
22982186

2299-
### 4.23 TsFile Configurations
2187+
### 4.21 TsFile Configurations
23002188

23012189
- group_size_in_byte
23022190

@@ -2388,7 +2276,7 @@ The `iotdb-system.properties` file contains various configurations for managing
23882276
| Default | None |
23892277
| Effective | Restart required. |
23902278

2391-
### 4.24 Authorization Configuration
2279+
### 4.22 Authorization Configuration
23922280

23932281
- authorizer_provider_class
23942282

@@ -2435,7 +2323,7 @@ The `iotdb-system.properties` file contains various configurations for managing
24352323
| Default | 30 |
24362324
| Effective | Restart required. |
24372325

2438-
### 4.25 UDF Configuration
2326+
### 4.23 UDF Configuration
24392327

24402328
- udf_initial_byte_array_length_for_memory_control
24412329

@@ -2473,7 +2361,7 @@ The `iotdb-system.properties` file contains various configurations for managing
24732361
| Default | ext/udf(Windows:ext\\udf) |
24742362
| Effective | Restart required. |
24752363

2476-
### 4.26 Trigger Configuration
2364+
### 4.24 Trigger Configuration
24772365

24782366
- trigger_lib_dir
24792367

@@ -2493,7 +2381,7 @@ The `iotdb-system.properties` file contains various configurations for managing
24932381
| Default | 3 |
24942382
| Effective | Restart required. |
24952383

2496-
### 4.27 **Select-Into Configuration**
2384+
### 4.25 **Select-Into Configuration**
24972385

24982386
- into_operation_buffer_size_in_byte
24992387

@@ -2522,7 +2410,7 @@ The `iotdb-system.properties` file contains various configurations for managing
25222410
| Default | 2 |
25232411
| Effective | Restart required. |
25242412

2525-
### 4.28 Continuous Query Configuration
2413+
### 4.26 Continuous Query Configuration
25262414

25272415
- continuous_query_submit_thread_count
25282416

@@ -2542,7 +2430,7 @@ The `iotdb-system.properties` file contains various configurations for managing
25422430
| Default | 1000 |
25432431
| Effective | Restart required. |
25442432

2545-
### 4.29 Pipe Configuration
2433+
### 4.27 Pipe Configuration
25462434

25472435
- pipe_lib_dir
25482436

@@ -2616,7 +2504,7 @@ The `iotdb-system.properties` file contains various configurations for managing
26162504
| Default | -1 |
26172505
| Effective | Hot reload |
26182506

2619-
### 4.30 RatisConsensus Configuration
2507+
### 4.28 RatisConsensus Configuration
26202508

26212509
- config_node_ratis_log_appender_buffer_size_max
26222510

@@ -3077,7 +2965,7 @@ The `iotdb-system.properties` file contains various configurations for managing
30772965
| Default | 86400 (s) |
30782966
| Effective | Restart required. |
30792967

3080-
### 4.31 IoTConsensusV2 Configuration
2968+
### 4.29 IoTConsensusV2 Configuration
30812969

30822970
- iot_consensus_v2_pipeline_size
30832971

@@ -3097,7 +2985,7 @@ The `iotdb-system.properties` file contains various configurations for managing
30972985
| Default | batch |
30982986
| Effective | Restart required. |
30992987

3100-
### 4.32 Procedure Configuration
2988+
### 4.30 Procedure Configuration
31012989

31022990
- procedure_core_worker_thread_count
31032991

@@ -3126,7 +3014,7 @@ The `iotdb-system.properties` file contains various configurations for managing
31263014
| Default | 60(s) |
31273015
| Effective | Restart required. |
31283016

3129-
### 4.33 MQTT Broker Configuration
3017+
### 4.31 MQTT Broker Configuration
31303018

31313019
- enable_mqtt_service
31323020

@@ -3182,7 +3070,7 @@ The `iotdb-system.properties` file contains various configurations for managing
31823070
| Default | 1048576 |
31833071
| Effective | Hot reload |
31843072

3185-
### 4.34 Audit log Configuration
3073+
### 4.32 Audit log Configuration
31863074

31873075
- enable_audit_log
31883076

@@ -3220,7 +3108,7 @@ The `iotdb-system.properties` file contains various configurations for managing
32203108
| Default | true |
32213109
| Effective | Restart required. |
32223110

3223-
### 4.35 White List Configuration
3111+
### 4.33 White List Configuration
32243112

32253113
- enable_white_list
32263114

@@ -3231,7 +3119,7 @@ The `iotdb-system.properties` file contains various configurations for managing
32313119
| Default | false |
32323120
| Effective | Hot reload |
32333121

3234-
### 4.36 IoTDB-AI Configuration
3122+
### 4.34 IoTDB-AI Configuration
32353123

32363124
- model_inference_execution_thread_count
32373125

@@ -3242,7 +3130,7 @@ The `iotdb-system.properties` file contains various configurations for managing
32423130
| Default | 5 |
32433131
| Effective | Restart required. |
32443132

3245-
### 4.37 Load TsFile Configuration
3133+
### 4.35 Load TsFile Configuration
32463134

32473135
- load_clean_up_task_execution_delay_time_seconds
32483136

@@ -3335,7 +3223,7 @@ The `iotdb-system.properties` file contains various configurations for managing
33353223
|Effective| Effective after restart |
33363224

33373225

3338-
### 4.38 Dispatch Retry Configuration
3226+
### 4.36 Dispatch Retry Configuration
33393227

33403228
- enable_retry_for_unknown_error
33413229

0 commit comments

Comments
 (0)