StefanieZhao7 commented on code in PR #100:
URL: https://github.com/apache/iotdb-docs/pull/100#discussion_r1361818738
##########
src/UserGuide/V1.2.x/User-Manual/Tiered-Storage_timecho.md:
##########
@@ -19,6 +19,78 @@
-->
-# Tiered Storage
+# Tiered Storage
+## Overview
-TODO
\ No newline at end of file
+Tiered storage function provides users with the ability to manage tiered
storage media. users can use the tiered storage function to configure different
types of storage media for IoTDB and to classify the storage media. ioTDB can
support tiered storage from memory, SSD, normal hard disc to network hard disc
by parameter configuration only according to the degree of hot and cold data.
Specifically, in IoTDB, the configuration of tiered storage is reflected in the
management of multiple directories. Users can group tiered storage directories
into the same category and configure them into IoTDB as a "tier", which is
called storage tier; at the same time, users can categorize data according to
hot or cold, and store different categories of data into designated storage
tiers. Meanwhile, users can categorise data according to hot or cold and store
different categories of data in the specified tier. Currently, IoTDB supports
the classification of hot and cold data by TTL, when the data in
one tier does not meet the TTL rules defined in the current tier, the data
will be automatically migrated to the next tier.
+
+## Parameter Definition
+
+To enable tiered storage in IoTDB, you need to configure the following aspects:
+
+1. configure the data catalogue and divide the data catalogue into different
tiers
+2. configure the TTL of the data managed in each tier to distinguish between
hot and cold data categories managed in different tiers.
+3. configure the minimum remaining storage space ratio for each tier so that
when the storage space of the tier triggers the threshold, the data of the tier
will be automatically migrated to the next tier (optional).
+
+The specific parameter definitions and their descriptions are as follows.
+
+| Configuration | Default
| Description |
Constraint |
+| ---------------------------------------- | ------------------------ |
------------------------------------------------------------ |
------------------------------------------------------------ |
+| dn_data_dirs | None |
specify different storage directories and divide the storage directories into
tiers | Each level of storage uses a semicolon to separate, and
commas to separate within a single level; cloud configuration can only be used
as the last level of storage and the first level can't be used as cloud
storage; a cloud object at most; the remote storage directory is denoted by
OBJECT_STORAGE |
+| default_ttl_in_ms | None |
Define the scope of data for which each tier is responsible, expressed through
a TTL | Each level of storage is separated by a semicolon;
the number of levels should match the number of levels defined by dn_data_dirs |
+| dn_default_space_move_thresholds | 0.15 | Define
the minimum remaining space ratio for each tier data catalogue; when the
remaining space is less than this ratio, the data will be automatically
migrated to the next tier; when the remaining storage space of the last tier
falls below this threshold, the system will be set to READ_ONLY | Each level of
storage is separated by a semicolon; the number of levels should match the
number of levels defined by dn_data_dirs |
+| object_storage_type | AWS_S3 | Cloud
Storage Type | IoTDB currently
only supports AWS S3 as a remote storage type, and this parameter can't be
modified |
+| object_storage_bucket | None |
Name of cloud storage bucket | Bucket
definition in AWS S3; no need to configure if remote storage is not used
|
+| object_storage_endpoiont | |
endpoint of cloud storage | endpoint
of AWS S3；If remote storage is not used, no configuration required |
+| object_storage_access_key | |
Authentication information stored in the cloud: key
| AWS S3 的 credential key；If remote storage is not used, no
configuration required |
+| object_storage_access_secret | |
Authentication information stored in the cloud: secret
| AWS S3 的 credential secret；If remote storage is not used, no
configuration required |
+| remote_tsfile_cache_dirs | data/datanode/data/cache | Cache
directory stored locally in the cloud | If
remote storage is not used, no configuration required
|
+| remote_tsfile_cache_page_size_in_kb | 20480 |Block
size of locally cached files stored in the cloud
| If remote storage is not used, no configuration required
|
+| remote_tsfile_cache_max_disk_usage_in_mb | 51200 |
Maximum Disk Occupancy Size for Cloud Storage Local Cache
| If remote storage is not used, no configuration required
|
+
+## local tiered storag configuration example
+
+The following is an example of a local two-level storage configuration.
+
+```JavaScript
+//Required configuration items
+dn_data_dirs=/data1/data;/data2/data,/data3/data;
+default_ttl_in_ms=86400000;-1
+dn_default_space_move_thresholds=0.2;0.1
+```
+
+In this example, two levels of storage are configured, specifically:
+
+| **层级** | **数据目录** | **数据范围** | **磁盘最小剩余空间阈值** |
+| -------- | -------------------------------------- | --------------- |
------------------------ |
+| 层级一 | 目录一：/data1/data | 最近 1 天的数据 | 20%
|
+| 层级二 | 目录一：/data2/data目录二：/data3/data | 1 天以前的数据 | 10%
|
+
+## remote tiered storag configuration example
+
+The following takes three-level storage as an example:
+
+```JavaScript
+//Required configuration items
+dn_data_dirs=/data1/data;/data2/data,/data3/data;OBJECT_STORAGE
+default_ttl_in_ms=86400000;864000000;-1
+dn_default_space_move_thresholds=0.2;0.15;0.1
+object_storage_name=AWS_S3
+object_storage_bucket=iotdb
+object_storage_endpoiont=<your_endpoint>
+object_storage_access_key=<your_access_key>
+object_storage_access_secret=<your_access_secret>
+
+// Optional configuration items
+remote_tsfile_cache_dirs=data/datanode/data/cache
+remote_tsfile_cache_page_size_in_kb=20971520
+remote_tsfile_cache_max_disk_usage_in_mb=53687091200
+```
+
+In this example, a total of three levels of storage are configured,
specifically:
+
+| **层级** | **数据目录** | **数据范围** |
**磁盘最小剩余空间阈值** |
Review Comment:
这部分也还是中文
##########
src/UserGuide/V1.2.x/User-Manual/Tiered-Storage_timecho.md:
##########
@@ -19,6 +19,78 @@
-->
-# Tiered Storage
+# Tiered Storage
+## Overview
-TODO
\ No newline at end of file
+Tiered storage function provides users with the ability to manage tiered
storage media. users can use the tiered storage function to configure different
types of storage media for IoTDB and to classify the storage media. ioTDB can
support tiered storage from memory, SSD, normal hard disc to network hard disc
by parameter configuration only according to the degree of hot and cold data.
Specifically, in IoTDB, the configuration of tiered storage is reflected in the
management of multiple directories. Users can group tiered storage directories
into the same category and configure them into IoTDB as a "tier", which is
called storage tier; at the same time, users can categorize data according to
hot or cold, and store different categories of data into designated storage
tiers. Meanwhile, users can categorise data according to hot or cold and store
different categories of data in the specified tier. Currently, IoTDB supports
the classification of hot and cold data by TTL, when the data in
one tier does not meet the TTL rules defined in the current tier, the data
will be automatically migrated to the next tier.
+
+## Parameter Definition
+
+To enable tiered storage in IoTDB, you need to configure the following aspects:
+
+1. configure the data catalogue and divide the data catalogue into different
tiers
+2. configure the TTL of the data managed in each tier to distinguish between
hot and cold data categories managed in different tiers.
+3. configure the minimum remaining storage space ratio for each tier so that
when the storage space of the tier triggers the threshold, the data of the tier
will be automatically migrated to the next tier (optional).
+
+The specific parameter definitions and their descriptions are as follows.
+
+| Configuration | Default
| Description |
Constraint |
+| ---------------------------------------- | ------------------------ |
------------------------------------------------------------ |
------------------------------------------------------------ |
+| dn_data_dirs | None |
specify different storage directories and divide the storage directories into
tiers | Each level of storage uses a semicolon to separate, and
commas to separate within a single level; cloud configuration can only be used
as the last level of storage and the first level can't be used as cloud
storage; a cloud object at most; the remote storage directory is denoted by
OBJECT_STORAGE |
+| default_ttl_in_ms | None |
Define the scope of data for which each tier is responsible, expressed through
a TTL | Each level of storage is separated by a semicolon;
the number of levels should match the number of levels defined by dn_data_dirs |
+| dn_default_space_move_thresholds | 0.15 | Define
the minimum remaining space ratio for each tier data catalogue; when the
remaining space is less than this ratio, the data will be automatically
migrated to the next tier; when the remaining storage space of the last tier
falls below this threshold, the system will be set to READ_ONLY | Each level of
storage is separated by a semicolon; the number of levels should match the
number of levels defined by dn_data_dirs |
+| object_storage_type | AWS_S3 | Cloud
Storage Type | IoTDB currently
only supports AWS S3 as a remote storage type, and this parameter can't be
modified |
+| object_storage_bucket | None |
Name of cloud storage bucket | Bucket
definition in AWS S3; no need to configure if remote storage is not used
|
+| object_storage_endpoiont | |
endpoint of cloud storage | endpoint
of AWS S3；If remote storage is not used, no configuration required |
+| object_storage_access_key | |
Authentication information stored in the cloud: key
| AWS S3 的 credential key；If remote storage is not used, no
configuration required |
+| object_storage_access_secret | |
Authentication information stored in the cloud: secret
| AWS S3 的 credential secret；If remote storage is not used, no
configuration required |
+| remote_tsfile_cache_dirs | data/datanode/data/cache | Cache
directory stored locally in the cloud | If
remote storage is not used, no configuration required
|
+| remote_tsfile_cache_page_size_in_kb | 20480 |Block
size of locally cached files stored in the cloud
| If remote storage is not used, no configuration required
|
+| remote_tsfile_cache_max_disk_usage_in_mb | 51200 |
Maximum Disk Occupancy Size for Cloud Storage Local Cache
| If remote storage is not used, no configuration required
|
+
+## local tiered storag configuration example
+
+The following is an example of a local two-level storage configuration.
+
+```JavaScript
+//Required configuration items
+dn_data_dirs=/data1/data;/data2/data,/data3/data;
+default_ttl_in_ms=86400000;-1
+dn_default_space_move_thresholds=0.2;0.1
+```
+
+In this example, two levels of storage are configured, specifically:
+
+| **层级** | **数据目录** | **数据范围** | **磁盘最小剩余空间阈值** |
Review Comment:
这部分还是中文，需要翻译一下
##########
src/UserGuide/V1.2.x/User-Manual/Tiered-Storage_timecho.md:
##########
@@ -19,6 +19,78 @@
-->
-# Tiered Storage
+# Tiered Storage
+## Overview
-TODO
\ No newline at end of file
+Tiered storage function provides users with the ability to manage tiered
storage media. users can use the tiered storage function to configure different
types of storage media for IoTDB and to classify the storage media. ioTDB can
support tiered storage from memory, SSD, normal hard disc to network hard disc
by parameter configuration only according to the degree of hot and cold data.
Specifically, in IoTDB, the configuration of tiered storage is reflected in the
management of multiple directories. Users can group tiered storage directories
into the same category and configure them into IoTDB as a "tier", which is
called storage tier; at the same time, users can categorize data according to
hot or cold, and store different categories of data into designated storage
tiers. Meanwhile, users can categorise data according to hot or cold and store
different categories of data in the specified tier. Currently, IoTDB supports
the classification of hot and cold data by TTL, when the data in
one tier does not meet the TTL rules defined in the current tier, the data
will be automatically migrated to the next tier.
+
+## Parameter Definition
+
+To enable tiered storage in IoTDB, you need to configure the following aspects:
+
+1. configure the data catalogue and divide the data catalogue into different
tiers
+2. configure the TTL of the data managed in each tier to distinguish between
hot and cold data categories managed in different tiers.
+3. configure the minimum remaining storage space ratio for each tier so that
when the storage space of the tier triggers the threshold, the data of the tier
will be automatically migrated to the next tier (optional).
+
+The specific parameter definitions and their descriptions are as follows.
+
+| Configuration | Default
| Description |
Constraint |
+| ---------------------------------------- | ------------------------ |
------------------------------------------------------------ |
------------------------------------------------------------ |
+| dn_data_dirs | None |
specify different storage directories and divide the storage directories into
tiers | Each level of storage uses a semicolon to separate, and
commas to separate within a single level; cloud configuration can only be used
as the last level of storage and the first level can't be used as cloud
storage; a cloud object at most; the remote storage directory is denoted by
OBJECT_STORAGE |
+| default_ttl_in_ms | None |
Define the scope of data for which each tier is responsible, expressed through
a TTL | Each level of storage is separated by a semicolon;
the number of levels should match the number of levels defined by dn_data_dirs |
+| dn_default_space_move_thresholds | 0.15 | Define
the minimum remaining space ratio for each tier data catalogue; when the
remaining space is less than this ratio, the data will be automatically
migrated to the next tier; when the remaining storage space of the last tier
falls below this threshold, the system will be set to READ_ONLY | Each level of
storage is separated by a semicolon; the number of levels should match the
number of levels defined by dn_data_dirs |
+| object_storage_type | AWS_S3 | Cloud
Storage Type | IoTDB currently
only supports AWS S3 as a remote storage type, and this parameter can't be
modified |
+| object_storage_bucket | None |
Name of cloud storage bucket | Bucket
definition in AWS S3; no need to configure if remote storage is not used
|
+| object_storage_endpoiont | |
endpoint of cloud storage | endpoint
of AWS S3；If remote storage is not used, no configuration required |
+| object_storage_access_key | |
Authentication information stored in the cloud: key
| AWS S3 的 credential key；If remote storage is not used, no
configuration required |
+| object_storage_access_secret | |
Authentication information stored in the cloud: secret
| AWS S3 的 credential secret；If remote storage is not used, no
configuration required |
+| remote_tsfile_cache_dirs | data/datanode/data/cache | Cache
directory stored locally in the cloud | If
remote storage is not used, no configuration required
|
+| remote_tsfile_cache_page_size_in_kb | 20480 |Block
size of locally cached files stored in the cloud
| If remote storage is not used, no configuration required
|
+| remote_tsfile_cache_max_disk_usage_in_mb | 51200 |
Maximum Disk Occupancy Size for Cloud Storage Local Cache
| If remote storage is not used, no configuration required
|
+
+## local tiered storag configuration example
+
+The following is an example of a local two-level storage configuration.
+
+```JavaScript
+//Required configuration items
+dn_data_dirs=/data1/data;/data2/data,/data3/data;
+default_ttl_in_ms=86400000;-1
+dn_default_space_move_thresholds=0.2;0.1
+```
+
+In this example, two levels of storage are configured, specifically:
+
+| **层级** | **数据目录** | **数据范围** | **磁盘最小剩余空间阈值** |
+| -------- | -------------------------------------- | --------------- |
------------------------ |
+| 层级一 | 目录一：/data1/data | 最近 1 天的数据 | 20%
|
+| 层级二 | 目录一：/data2/data目录二：/data3/data | 1 天以前的数据 | 10%
|
+
+## remote tiered storag configuration example
+
+The following takes three-level storage as an example:
+
+```JavaScript
+//Required configuration items
+dn_data_dirs=/data1/data;/data2/data,/data3/data;OBJECT_STORAGE
+default_ttl_in_ms=86400000;864000000;-1
+dn_default_space_move_thresholds=0.2;0.15;0.1
+object_storage_name=AWS_S3
+object_storage_bucket=iotdb
+object_storage_endpoiont=<your_endpoint>
+object_storage_access_key=<your_access_key>
+object_storage_access_secret=<your_access_secret>
+
+// Optional configuration items
+remote_tsfile_cache_dirs=data/datanode/data/cache
+remote_tsfile_cache_page_size_in_kb=20971520
+remote_tsfile_cache_max_disk_usage_in_mb=53687091200
+```
+
+In this example, a total of three levels of storage are configured,
specifically:
+
+| **层级** | **数据目录** | **数据范围** |
**磁盘最小剩余空间阈值** |
Review Comment:
这部分也还是中文
##########
src/UserGuide/V1.2.x/User-Manual/Tiered-Storage_timecho.md:
##########
@@ -19,6 +19,78 @@
-->
-# Tiered Storage
+# Tiered Storage
+## Overview
-TODO
\ No newline at end of file
+Tiered storage function provides users with the ability to manage tiered
storage media. users can use the tiered storage function to configure different
types of storage media for IoTDB and to classify the storage media. ioTDB can
support tiered storage from memory, SSD, normal hard disc to network hard disc
by parameter configuration only according to the degree of hot and cold data.
Specifically, in IoTDB, the configuration of tiered storage is reflected in the
management of multiple directories. Users can group tiered storage directories
into the same category and configure them into IoTDB as a "tier", which is
called storage tier; at the same time, users can categorize data according to
hot or cold, and store different categories of data into designated storage
tiers. Meanwhile, users can categorise data according to hot or cold and store
different categories of data in the specified tier. Currently, IoTDB supports
the classification of hot and cold data by TTL, when the data in
one tier does not meet the TTL rules defined in the current tier, the data
will be automatically migrated to the next tier.
+
+## Parameter Definition
+
+To enable tiered storage in IoTDB, you need to configure the following aspects:
+
+1. configure the data catalogue and divide the data catalogue into different
tiers
+2. configure the TTL of the data managed in each tier to distinguish between
hot and cold data categories managed in different tiers.
+3. configure the minimum remaining storage space ratio for each tier so that
when the storage space of the tier triggers the threshold, the data of the tier
will be automatically migrated to the next tier (optional).
+
+The specific parameter definitions and their descriptions are as follows.
+
+| Configuration | Default
| Description |
Constraint |
+| ---------------------------------------- | ------------------------ |
------------------------------------------------------------ |
------------------------------------------------------------ |
+| dn_data_dirs | None |
specify different storage directories and divide the storage directories into
tiers | Each level of storage uses a semicolon to separate, and
commas to separate within a single level; cloud configuration can only be used
as the last level of storage and the first level can't be used as cloud
storage; a cloud object at most; the remote storage directory is denoted by
OBJECT_STORAGE |
+| default_ttl_in_ms | None |
Define the scope of data for which each tier is responsible, expressed through
a TTL | Each level of storage is separated by a semicolon;
the number of levels should match the number of levels defined by dn_data_dirs |
+| dn_default_space_move_thresholds | 0.15 | Define
the minimum remaining space ratio for each tier data catalogue; when the
remaining space is less than this ratio, the data will be automatically
migrated to the next tier; when the remaining storage space of the last tier
falls below this threshold, the system will be set to READ_ONLY | Each level of
storage is separated by a semicolon; the number of levels should match the
number of levels defined by dn_data_dirs |
+| object_storage_type | AWS_S3 | Cloud
Storage Type | IoTDB currently
only supports AWS S3 as a remote storage type, and this parameter can't be
modified |
+| object_storage_bucket | None |
Name of cloud storage bucket | Bucket
definition in AWS S3; no need to configure if remote storage is not used
|
+| object_storage_endpoiont | |
endpoint of cloud storage | endpoint
of AWS S3；If remote storage is not used, no configuration required |
+| object_storage_access_key | |
Authentication information stored in the cloud: key
| AWS S3 的 credential key；If remote storage is not used, no
configuration required |
+| object_storage_access_secret | |
Authentication information stored in the cloud: secret
| AWS S3 的 credential secret；If remote storage is not used, no
configuration required |
+| remote_tsfile_cache_dirs | data/datanode/data/cache | Cache
directory stored locally in the cloud | If
remote storage is not used, no configuration required
|
+| remote_tsfile_cache_page_size_in_kb | 20480 |Block
size of locally cached files stored in the cloud
| If remote storage is not used, no configuration required
|
+| remote_tsfile_cache_max_disk_usage_in_mb | 51200 |
Maximum Disk Occupancy Size for Cloud Storage Local Cache
| If remote storage is not used, no configuration required
|
+
+## local tiered storag configuration example
+
+The following is an example of a local two-level storage configuration.
+
+```JavaScript
+//Required configuration items
+dn_data_dirs=/data1/data;/data2/data,/data3/data;
+default_ttl_in_ms=86400000;-1
+dn_default_space_move_thresholds=0.2;0.1
+```
+
+In this example, two levels of storage are configured, specifically:
+
+| **层级** | **数据目录** | **数据范围** | **磁盘最小剩余空间阈值** |
Review Comment:
这部分还是中文，需要翻译一下
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
