update docs

yunify · Nov 5, 2018 · 3fb0f07 · 3fb0f07
1 parent 07f76a5
commit 3fb0f07
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 
 > English | [中文](README_zh.md)
 ## Description
-QingStor CSI plugin implements an interface between Container Storage Interface ([CSI](https://github.com/container-storage-interface/)) enabled Container Orchestrator (CO) and the storage of NeonSAN. Currently, QingCloud CSI plugin has volume manager and snapshot manager capabilities, and passed [CSI sanity test](https://github.com/kubernetes-csi/csi-test) in Kubernetes v1.12 environment.
+QingStor CSI plugin implements an interface between Container Storage Interface ([CSI](https://github.com/container-storage-interface/)) enabled Container Orchestrator (CO) and the storage of NeonSAN. Currently, QingCloud CSI plugin has **volume manager** and **snapshot manager** capabilities, and passed [CSI sanity test](https://github.com/kubernetes-csi/csi-test) in Kubernetes v1.12 environment.
 
 ## Installation
 

diff --git a/docs/uninstall_neonsan.md b/docs/uninstall_neonsan.md
@@ -2,6 +2,7 @@
 
 > IMPORTANT: Before uninstalling, please ensure NeonSAN based objects, such as PVC, PV, VolumeSnapshot and VolumeSnapshotContent, have been deleted.
 
+Please execute following commands in the installation package.
 ```
 kubectl delete -f ./sts-controller.yaml
 kubectl delete -f ./ds-node.yaml

diff --git a/docs/uninstall_neonsan_zh.md b/docs/uninstall_neonsan_zh.md
@@ -1,7 +1,9 @@
 # 如何卸载NeonSAN CSI插件
 
+
 > 注：卸载前，请确保基于 NeonSAN 的 PVC，PV，VolumeSnapshot，VolumeSnapshotContent 已删除。
 
+在安装文件夹内执行下列命令：
 ```
 kubectl delete -f ./sts-controller.yaml
 kubectl delete -f ./ds-node.yaml

diff --git a/docs/usage_neonsan_volume.md b/docs/usage_neonsan_volume.md
@@ -67,8 +67,10 @@ No resources found.
 ### Create PVC
 
 -  Create NeonSAN volume
+
+> IMPORTANT: Please ensure `qbd.conf` file, the config file of NeonSAN CLI, is in the current directory.
 ```
-$ neonsan create_volume -volume pre-provisioning-volume -pool csi -size 5G -repcount 1
+$ neonsan create_volume -volume pre-provisioning-volume -pool kube -size 5G -repcount 1 -c ./qbd.conf
 INFO[0000] create volume succeed.                       
 ```
 

diff --git a/docs/usage_neonsan_volume_zh.md b/docs/usage_neonsan_volume_zh.md
@@ -67,8 +67,10 @@ No resources found.
 ### 创建 PVC
 
 - 通过 NeonSAN CLI 创建 image
+
+> 注：请将 NeonSAN CLI 配置文件 qbd.conf 放置在当前文件夹内。
 ```
-$ neonsan create_volume -volume pre-provisioning-volume -pool csi -size 5G -repcount 1
+$ neonsan create_volume -volume pre-provisioning-volume -pool kube -size 5G -repcount 1 -c ./qbd.conf
 INFO[0000] create volume succeed.                       
 ```