Polish docs for tieredstore configuration (fluid-cloudnative#562)

* Polish tieredstore config docs * Update TOC
zhang-x-z · Feb 3, 2021 · 5466452 · 5466452
1 parent a104b30
commit 5466452
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 4 deletions.
diff --git a/docs/en/TOC.md b/docs/en/TOC.md
@@ -11,9 +11,16 @@
   - [Installation](userguide/install.md)
   - [Troubleshooting](userguide/troubleshooting.md)
 + Samples
-  - [Accelerate Data Accessing](samples/accelerate_data_accessing.md)
+  - [Accelerate Data Accessing(via POSIX)](samples/accelerate_data_accessing.md)
+  - [Accelerate Data Accessing(via HDFS interface)](samples/accelerate_data_accessing_by_hdfs.md)
+  - [Encrypted options for Dataset](samples/use_encryptoptions.md)
   - [Cache Co-locality](samples/data_co_locality.md)
   - [Machine Learning](samples/machinelearning.md)
+  - [Accelerate HostPath with Fluid](samples/hostpath.md)
+  - [Accelerate PVC with Fluid](samples/accelerate_pvc.md)
+  - [Using Fluid to access non-root user's data](samples/nonroot_access.md)
+  - [Data Preloading](samples/data_warmup.md)
+  - [Alluxio Tieredstore Configuration](samples/tieredstore_config.md)
 + Developer Guide
   - [How to develop](dev/how_to_develop.md)
   - [API_Doc](dev/api_doc.md)

diff --git a/docs/en/samples/tieredstore_config.md b/docs/en/samples/tieredstore_config.md
@@ -1,4 +1,4 @@
-# Demo - Allluxio Tieredstore Configuration
+# Demo - Alluxio Tieredstore Configuration
 
 [Alluxio](https://github.com/Alluxio/alluxio) is one of the distributed cache engines leveraged by Fluid.
 It supports tieredstores to store cached data in different location, for example different directories with different storage types.
@@ -136,6 +136,7 @@ Level order defined in `spec.tieredstore.levels` will not affect the actual leve
 Before Alluxio launched, Fluid will firstly sort the levels according to `mediumtype`, and storages with higher I/O throughput will get higher priority.
 That is, Fluid will sort tieredstores in the following orders: "MEM" < "SSD" < "HDD".
 
-> Note: For now, multi-tier configuration may lead to some issue like unexpected `Cached` and `CachedPercentage` in Dataset
+> Note: Alluxio uses a different way to report its capacity usage when using multi-tier configuration. 
+> For now, this will lead to some inaccuracy when showing `Dataset.Cached` and `Dataset.CachedPercentage` in Fluid.
 
 
diff --git a/docs/zh/TOC.md b/docs/zh/TOC.md
@@ -20,6 +20,7 @@
   - [数据卷加速](samples/accelerate_pvc.md)
   - [以non-root用户身份使用Fluid](samples/nonroot_access.md)
   - [数据预加载](samples/data_warmup.md)
+  - [Alluxio分层存储配置](samples/tieredstore_config.md)
 + 运维指南
   - [运行时监控](operation/monitoring.md)
 + 开发者指南

diff --git a/docs/zh/samples/tieredstore_config.md b/docs/zh/samples/tieredstore_config.md
@@ -118,5 +118,5 @@ spec:
 
 `spec.tieredstore.levels`中定义的层级顺序不会影响Alluxio集群分层存储的层级顺序.在Alluxio集群启动前,Fluid会按照`mediumtype`对多个层级进行重排序,以保证数据访问速度快的存储介质("MEM" < "SSD" < "HDD")会被优先使用.
 
-> 注意: 在目前的Fluid版本下,多层存储配置可能会导致已缓存比例(Dataset资源对象中的`Cached`以及`CachedPercentage`属性)显示出错等一些问题.
+> 注意: 多层存储配置的Alluxio使用不同的方式计算存储使用量. 在目前的Fluid版本下,这会使得Alluxio已缓存比例(`Dataset.Cached`以及`Dataset.CachedPercentage`属性)受到一定的精确度影响.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -118,5 +118,5 @@ spec:

		`spec.tieredstore.levels`中定义的层级顺序不会影响Alluxio集群分层存储的层级顺序.在Alluxio集群启动前,Fluid会按照`mediumtype`对多个层级进行重排序,以保证数据访问速度快的存储介质("MEM" < "SSD" < "HDD")会被优先使用.

		> 注意: 在目前的Fluid版本下,多层存储配置可能会导致已缓存比例(Dataset资源对象中的`Cached`以及`CachedPercentage`属性)显示出错等一些问题.
		> 注意: 多层存储配置的Alluxio使用不同的方式计算存储使用量. 在目前的Fluid版本下,这会使得Alluxio已缓存比例(`Dataset.Cached`以及`Dataset.CachedPercentage`属性)受到一定的精确度影响.