Merge pull request hwameistor#130 from alexzhc/main

[doc] update "configure storage pool"
angel0507 · Aug 8, 2022 · d959e39 · d959e39
2 parents 1a69dc5 + f367daf
commit d959e39
Show file tree

Hide file tree

Showing 27 changed files with 1,007 additions and 42 deletions.
diff --git a/docs/docs/01.installation/02.post-deploy.md b/docs/docs/01.installation/02.post-deploy.md
@@ -41,18 +41,7 @@ hwameistor-webhook-986479678-278cr                         1/1     Running
 `local-disk-manager` and `local-storage` are `DaemonSets`. They should have one pod on each Kubernetes node.
 :::
 
-
-## Step 2: Check the storageclass
-
-A `storageClass` should be created:
-
-```bash
-$ kubectl get storageclass hwameistor-storage-disk-hdd
-NAME                          PROVISIONER          RECLAIMPOLICY   VOLUMEBINDINGMODE      ALLOWVOLUMEEXPANSION   AGE
-hwameistor-storage-disk-hdd   disk.hwameistor.io   Delete          WaitForFirstConsumer   true                   4m29s
-```
-
-## Step 3: Check the APIs
+## Step 2: Check the APIs
 
 HwameiStor CRDs create the following APIs.
 
@@ -74,9 +63,9 @@ localvolumereplicas        lvr          hwameistor.io/v1alpha1   false        Lo
 localvolumes               lv           hwameistor.io/v1alpha1   false        LocalVolume
 ```
 
-For the details about CRDs, please also refer to the chapter [CRDs](../04.components/00.crd.md).
+For the details about CRDs, please also refer to the chapter [CRDs](../04.modules/00.crd.md).
 
-# Step 4: Check the localDiskNode and localDisks
+# Step 3: Check the localDiskNode and localDisks
 
 HwameiStor autoscans each node and registers each disk as CRD `localDisk(ld)`. The unused disks are displayed with `PHASE: Unclaimed`.
 

diff --git a/docs/docs/01.installation/03.config-pool.md b/docs/docs/01.installation/03.config-pool.md
@@ -0,0 +1,98 @@
+---
+sidebar_position: 4
+sidebar_label: "Configure Storage Pool"
+---
+
+# Configure Storage Pool
+
+## Step 1: Create LocalDiskClaim objects
+
+HwameiStor sets up storage pools by creating `LocalDiskClaim` objects according to the storage media types. To create an HDD pool on all kubernetes worker nodes:
+
+```bash
+$ helm template helm/hwameistor \
+        -s templates/post-install-claim-disks.yaml \
+        --set storageNodes='{k8s-worker-1,k8s-worker-2,k8s-worker-3}' \
+        | kubectl apply -f -
+```
+
+## Step 2: Verify LocalDiskClaim objects
+
+```bash
+$ kubectl get ldc
+NAME           NODEMATCH      PHASE
+k8s-worker-1   k8s-worker-1   Bound
+k8s-worker-2   k8s-worker-2   Bound
+k8s-worker-3   k8s-worker-3   Bound
+```
+
+## Step 3: Verify StorageClass
+
+```bash
+$  kubectl get sc hwameistor-storage-lvm-hdd
+NAME                         PROVISIONER         RECLAIMPOLICY   VOLUMEBINDINGMODE      ALLOWVOLUMEEXPANSION   AGE
+hwameistor-storage-lvm-hdd   lvm.hwameistor.io   Delete          WaitForFirstConsumer   true                   114s
+```
+
+## Step 4: Verify LocalDisk objects
+
+```bash
+$ kubectl get ld
+NAME               NODEMATCH      CLAIM          PHASE
+k8s-worker-1-sda   k8s-worker-1                  Inuse
+k8s-worker-1-sdb   k8s-worker-1   k8s-worker-1   Claimed
+k8s-worker-1-sdc   k8s-worker-1   k8s-worker-1   Claimed
+k8s-worker-1-sdd   k8s-worker-1                  Inuse
+k8s-worker-1-sde   k8s-worker-1                  Inuse
+k8s-worker-2-sda   k8s-worker-2                  Inuse
+k8s-worker-2-sdb   k8s-worker-2   k8s-worker-2   Claimed
+k8s-worker-2-sdc   k8s-worker-2   k8s-worker-2   Claimed
+k8s-worker-2-sdd   k8s-worker-2                  Inuse
+k8s-worker-2-sde   k8s-worker-2                  Inuse
+k8s-worker-3-sda   k8s-worker-3                  Inuse
+k8s-worker-3-sdb   k8s-worker-3   k8s-worker-3   Claimed
+k8s-worker-3-sdc   k8s-worker-3   k8s-worker-3   Claimed
+k8s-worker-3-sdd   k8s-worker-3                  Inuse
+k8s-worker-3-sde   k8s-worker-3                  Inuse
+```
+
+## Step 5 (Optional): Observe VG
+
+On a kubernetes worker node, observe a `VG` is created for an `LocalDiskClaim` object
+
+```bash
+root@k8s-worker-1:~$ vgdisplay LocalStorage_PoolHDD
+  --- Volume group ---
+  VG Name               LocalStorage_PoolHDD
+  System ID
+  Format                lvm2
+  Metadata Areas        2
+  Metadata Sequence No  1
+  VG Access             read/write
+  VG Status             resizable
+  MAX LV                0
+  Cur LV                0
+  Open LV               0
+  Max PV                0
+  Cur PV                2
+  Act PV                2
+  VG Size               199.99 GiB
+  PE Size               4.00 MiB
+  Total PE              51198
+  Alloc PE / Size       0 / 0
+  Free  PE / Size       51198 / 199.99 GiB
+  VG UUID               jJ3s7g-iyoJ-c4zr-3Avc-3K4K-BrJb-A5A5Oe
+```
+
+## Set up storage pool during deployment
+
+A storage pool can be configured during HwameiStor deployment by helm command:
+
+```bash
+$ helm install \
+    --namespace hwameistor \
+    --create-namespace \
+    hwameistor \
+    helm/hwameistor \
+    --set storageNodes='{k8s-worker-1,k8s-worker-2,k8s-worker-3}'
+```
diff --git a/docs/docs/01.installation/03.upgrade.md → docs/docs/01.installation/04.upgrade.md b/docs/docs/01.installation/03.upgrade.md → docs/docs/01.installation/04.upgrade.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 5
 sidebar_label: "Upgrade"
 ---
 

diff --git a/docs/docs/01.installation/04.uninstall.md → docs/docs/01.installation/05.uninstall.md b/docs/docs/01.installation/04.uninstall.md → docs/docs/01.installation/05.uninstall.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 5
+sidebar_position: 6
 sidebar_label: "Uninstall"
 ---
 
@@ -33,10 +33,18 @@ $ kubectl get crd -o name \
     | xargs -t kubectl delete
 ```
 
-### Remove clusterroles and rolebindings
+### Remove clusterRoles and roleBindings
 
 ```bash
 $ kubectl get clusterrolebinding,clusterrole -o name \
     | grep hwameistor \
     | xargs -t kubectl delete
-```
+```
+
+### Remove storageClass
+
+```bash
+$ kubectl get sc -o name \
+    | grep hwameistor-storage-lvm- \
+    | xargs -t kubectl delete
+```
diff --git a/docs/docs/04.components/_category_.json b/docs/docs/04.components/_category_.json
diff --git a/docs/docs/04.components/00.crd.md → docs/docs/04.modules/00.crd.md b/docs/docs/04.components/00.crd.md → docs/docs/04.modules/00.crd.md
diff --git a/...cs/04.components/01.local-disk-manager.md → .../docs/04.modules/01.local-disk-manager.md b/...cs/04.components/01.local-disk-manager.md → .../docs/04.modules/01.local-disk-manager.md
diff --git a/docs/docs/04.components/02.local-storage.md → docs/docs/04.modules/02.local-storage.md b/docs/docs/04.components/02.local-storage.md → docs/docs/04.modules/02.local-storage.md
diff --git a/docs/docs/04.components/03.DRBD.md → docs/docs/04.modules/03.DRBD.md b/docs/docs/04.components/03.DRBD.md → docs/docs/04.modules/03.DRBD.md
diff --git a/docs/docs/04.components/04.scheduler.md → docs/docs/04.modules/04.scheduler.md b/docs/docs/04.components/04.scheduler.md → docs/docs/04.modules/04.scheduler.md
diff --git a/docs/docs/04.modules/_category_.json b/docs/docs/04.modules/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Modules",
+  "position": 5
+}
diff --git a/docs/i18n/cn/docusaurus-plugin-content-docs/current.json b/docs/i18n/cn/docusaurus-plugin-content-docs/current.json
@@ -15,9 +15,9 @@
     "message": "后端操作",
     "description": "The label for category Backend Operations in sidebar tutorialSidebar"
   },
-  "sidebar.tutorialSidebar.category.Components": {
-    "message": "组件",
-    "description": "The label for category Components in sidebar tutorialSidebar"
+  "sidebar.tutorialSidebar.category.Modules": {
+    "message": "模块",
+    "description": "The label for category modules in sidebar tutorialSidebar"
   },
   "sidebar.tutorialSidebar.category.Applications": {
     "message": "应用",

diff --git a/...18n/cn/docusaurus-plugin-content-docs/current/01.installation/02.post-deploy.md b/...18n/cn/docusaurus-plugin-content-docs/current/01.installation/02.post-deploy.md
@@ -74,7 +74,7 @@ localvolumereplicas        lvr          hwameistor.io/v1alpha1   false        Lo
 localvolumes               lv           hwameistor.io/v1alpha1   false        LocalVolume
 ```
 
-For the details about CRDs, please also refer to the chapter [CRDs](../04.components/00.crd.md).
+For the details about CRDs, please also refer to the chapter [CRDs](../04.modules/00.crd.md).
 
 # Step 4: Check the localDiskNode and localDisks
 

diff --git a/...18n/cn/docusaurus-plugin-content-docs/current/01.installation/03.config-pool.md b/...18n/cn/docusaurus-plugin-content-docs/current/01.installation/03.config-pool.md
@@ -0,0 +1,98 @@
+---
+sidebar_position: 4
+sidebar_label: "配置存储池"
+---
+
+# Configure Storage Pool
+
+## Step 1: Create LocalDiskClaim objects
+
+HwameiStor sets up storage pools by creating `LocalDiskClaim` objects according to the storage media types. To create an HDD pool on all kubernetes worker nodes:
+
+```bash
+$ helm template helm/hwameistor \
+        -s templates/post-install-claim-disks.yaml \
+        --set storageNodes='{k8s-worker-1,k8s-worker-2,k8s-worker-3}' \
+        | kubectl apply -f -
+```
+
+## Step 2: Verify LocalDiskClaim objects
+
+```bash
+$ kubectl get ldc
+NAME           NODEMATCH      PHASE
+k8s-worker-1   k8s-worker-1   Bound
+k8s-worker-2   k8s-worker-2   Bound
+k8s-worker-3   k8s-worker-3   Bound
+```
+
+## Step 3: Verify StorageClass
+
+```bash
+$  kubectl get sc hwameistor-storage-lvm-hdd
+NAME                         PROVISIONER         RECLAIMPOLICY   VOLUMEBINDINGMODE      ALLOWVOLUMEEXPANSION   AGE
+hwameistor-storage-lvm-hdd   lvm.hwameistor.io   Delete          WaitForFirstConsumer   true                   114s
+```
+
+## Step 4: Verify LocalDisk objects
+
+```bash
+$ kubectl get ld
+NAME               NODEMATCH      CLAIM          PHASE
+k8s-worker-1-sda   k8s-worker-1                  Inuse
+k8s-worker-1-sdb   k8s-worker-1   k8s-worker-1   Claimed
+k8s-worker-1-sdc   k8s-worker-1   k8s-worker-1   Claimed
+k8s-worker-1-sdd   k8s-worker-1                  Inuse
+k8s-worker-1-sde   k8s-worker-1                  Inuse
+k8s-worker-2-sda   k8s-worker-2                  Inuse
+k8s-worker-2-sdb   k8s-worker-2   k8s-worker-2   Claimed
+k8s-worker-2-sdc   k8s-worker-2   k8s-worker-2   Claimed
+k8s-worker-2-sdd   k8s-worker-2                  Inuse
+k8s-worker-2-sde   k8s-worker-2                  Inuse
+k8s-worker-3-sda   k8s-worker-3                  Inuse
+k8s-worker-3-sdb   k8s-worker-3   k8s-worker-3   Claimed
+k8s-worker-3-sdc   k8s-worker-3   k8s-worker-3   Claimed
+k8s-worker-3-sdd   k8s-worker-3                  Inuse
+k8s-worker-3-sde   k8s-worker-3                  Inuse
+```
+
+## Step 5 (Optional): Observe VG
+
+On a kubernetes worker node, observe a `VG` is created for an `LocalDiskClaim` object
+
+```bash
+root@k8s-worker-1:~$ vgdisplay LocalStorage_PoolHDD
+  --- Volume group ---
+  VG Name               LocalStorage_PoolHDD
+  System ID
+  Format                lvm2
+  Metadata Areas        2
+  Metadata Sequence No  1
+  VG Access             read/write
+  VG Status             resizable
+  MAX LV                0
+  Cur LV                0
+  Open LV               0
+  Max PV                0
+  Cur PV                2
+  Act PV                2
+  VG Size               199.99 GiB
+  PE Size               4.00 MiB
+  Total PE              51198
+  Alloc PE / Size       0 / 0
+  Free  PE / Size       51198 / 199.99 GiB
+  VG UUID               jJ3s7g-iyoJ-c4zr-3Avc-3K4K-BrJb-A5A5Oe
+```
+
+## Configure storage pool during deployment
+
+A storage pool can be configured during HwameiStor deployment by helm command:
+
+```bash
+$ helm install \
+    --namespace hwameistor \
+    --create-namespace \
+    hwameistor \
+    helm/hwameistor \
+    --set storageNodes='{k8s-worker-1,k8s-worker-2,k8s-worker-3}'
+```
diff --git a/...ocs/current/01.installation/03.upgrade.md → ...ocs/current/01.installation/04.upgrade.md b/...ocs/current/01.installation/03.upgrade.md → ...ocs/current/01.installation/04.upgrade.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 5
 sidebar_label: "升级"
 ---
 

diff --git a/...s/current/01.installation/04.uninstall.md → ...s/current/01.installation/05.uninstall.md b/...s/current/01.installation/04.uninstall.md → ...s/current/01.installation/05.uninstall.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 5
+sidebar_position: 6
 sidebar_label: "卸载"
 ---
 

diff --git a/docs/i18n/cn/docusaurus-plugin-content-docs/current/04.components/_category_.json b/docs/i18n/cn/docusaurus-plugin-content-docs/current/04.components/_category_.json
diff --git a/...tent-docs/current/04.components/00.crd.md → ...content-docs/current/04.modules/00.crd.md b/...tent-docs/current/04.components/00.crd.md → ...content-docs/current/04.modules/00.crd.md
diff --git a/...nt/04.components/01.local-disk-manager.md → ...rrent/04.modules/01.local-disk-manager.md b/...nt/04.components/01.local-disk-manager.md → ...rrent/04.modules/01.local-disk-manager.md
diff --git a/...current/04.components/02.local-storage.md → ...cs/current/04.modules/02.local-storage.md b/...current/04.components/02.local-storage.md → ...cs/current/04.modules/02.local-storage.md
diff --git a/...ent-docs/current/04.components/03.DRBD.md → ...ontent-docs/current/04.modules/03.DRBD.md b/...ent-docs/current/04.components/03.DRBD.md → ...ontent-docs/current/04.modules/03.DRBD.md
diff --git a/...ocs/current/04.components/04.scheduler.md → ...t-docs/current/04.modules/04.scheduler.md b/...ocs/current/04.components/04.scheduler.md → ...t-docs/current/04.modules/04.scheduler.md
diff --git a/docs/i18n/cn/docusaurus-plugin-content-docs/current/04.modules/_category_.json b/docs/i18n/cn/docusaurus-plugin-content-docs/current/04.modules/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "模块",
+  "position": 5
+}
diff --git a/helm/hwameistor/templates/post-install-claim-disks.yaml b/helm/hwameistor/templates/post-install-claim-disks.yaml
@@ -14,6 +14,6 @@ spec:
   # The field value should be consistent with the nodeName in localdisk
   nodeName: {{ . }}
   description:
-    diskType: {{ $.Values.storageclass.diskType }}
+    diskType: {{ $.Values.storageClass.diskType }}
 ---
 {{- end}}
diff --git a/helm/hwameistor/templates/storageclass.yaml b/helm/hwameistor/templates/storageclass.yaml
@@ -1,19 +1,19 @@
-{{- if .Values.storageclass.enabled -}}
+{{- if .Values.storageClass.enabled -}}
 apiVersion: storage.k8s.io/v1
 kind: StorageClass
 metadata:
   annotations:
-    storageclass.kubernetes.io/is-default-class: {{ .Values.storageclass.default | quote }}
-  name: hwameistor-storage-lvm-{{ .Values.storageclass.diskType | lower}}
+    storageClass.kubernetes.io/is-default-class: {{ .Values.storageClass.default | quote }}
+  name: hwameistor-storage-lvm-{{ .Values.storageClass.diskType | lower}}
 provisioner: lvm.hwameistor.io
 volumeBindingMode: WaitForFirstConsumer
-allowVolumeExpansion: {{ .Values.storageclass.allowVolumeExpansion }}
-reclaimPolicy: {{ .Values.storageclass.reclaimPolicy }}
+allowVolumeExpansion: {{ .Values.storageClass.allowVolumeExpansion }}
+reclaimPolicy: {{ .Values.storageClass.reclaimPolicy }}
 parameters:
-  replicaNumber: {{ .Values.storageclass.replicaNumber | quote}}
-  poolClass: {{ .Values.storageclass.diskType | quote}}
+  replicaNumber: {{ .Values.storageClass.replicaNumber | quote}}
+  poolClass: {{ .Values.storageClass.diskType | quote}}
   poolType: "REGULAR"
   volumeKind: "LVM"
   striped: "true"
-  csi.storage.k8s.io/fstype: {{ .Values.storageclass.fsType | quote}}
+  csi.storage.k8s.io/fstype: {{ .Values.storageClass.fsType | quote}}
 {{- end }}
diff --git a/helm/hwameistor/values.yaml b/helm/hwameistor/values.yaml
@@ -7,7 +7,7 @@ hwameistorImageRegistry: ghcr.io
 kubeletRootDir: /var/lib/kubelet
 
 # StorageClass Settings
-storageclass:
+storageClass:
   # If enabled, a hwameistor storageclass will be created in your system
   enabled: true
   # If enabled, hwameistor storageclass will be a default storageclass in system