feat(charts): add lvm local pv chart as a dependency (#220)

- add LVM local pv chart as a dependency chart of openebs chart.
- update dependency map in chart readme.
- update readme on how to install a csi driver using this chart.


Signed-off-by: Shovan Maity <shovan.cse91@gmail.com>

.github/workflows/lint-test.yaml

@@ -54,6 +54,7 @@ jobs:
           helm repo add openebs-jiva https://openebs.github.io/jiva-operator
           helm repo add openebs-cstor https://openebs.github.io/cstor-operators
           helm repo add openebs-zfslocalpv https://openebs.github.io/zfs-localpv
+          helm repo add openebs-lvmlocalpv https://openebs.github.io/lvm-localpv
           helm repo update
 
       - name: Run chart-testing (install)

charts/openebs/Chart.yaml

@@ -1,5 +1,5 @@
 apiVersion: v2
-version: 2.9.2
+version: 2.9.3
 name: openebs
 appVersion: 2.9.0
 description: Containerized Storage for Containers
@@ -38,3 +38,7 @@ dependencies:
     version: "1.7.0"
     repository: "https://openebs.github.io/zfs-localpv"
     condition: zfs-localpv.enabled
+  - name: lvm-localpv
+    version: "0.5.0"
+    repository: "https://openebs.github.io/lvm-localpv"
+    condition: lvm-localpv.enabled

charts/openebs/README.md

@@ -147,3 +147,98 @@ helm install --name openebs -f values.yaml openebs/openebs
 ```
 
 > **Tip**: You can use the default [values.yaml](values.yaml)
+
+## Below charts are dependent charts of this chart
+-  [openebs-ndm](https://openebs.github.io/node-disk-manager)
+-  [localpv-provisioner](https://openebs.github.io/dynamic-localpv-provisioner)
+-  [cstor](https://openebs.github.io/cstor-operators)
+-  [jiva](https://openebs.github.io/jiva-operator)
+-  [zfs-localpv](https://openebs.github.io/zfs-localpv)
+-  [lvm-localpv](https://openebs.github.io/lvm-localpv)
+
+## Dependency tree of this chart
+```bash
+openebs
+├── openebs-ndm
+├── localpv-provisioner
+│   └── openebs-ndm (optional)
+├── jiva
+│   └── localpv-provisioner
+│       └── openebs-ndm (optional)
+├── cstor
+│   └── openebs-ndm
+├── zfs-localpv
+└── lvm-localpv
+```
+
+#### (Default) Install Jiva, cStor and Local PV with out-of-tree provisioners
+```bash
+helm install openebs openebs/openebs --namespace openebs --create-namespace
+```
+
+#### Install cStor with CSI driver
+```bash
+helm install openebs openebs/openebs --namespace openebs --create-namespace \
+--set localprovisioner.enabled=false \
+--set ndm.enabled=false \
+--set ndmOperator.enabled=false \
+--set webhook.enabled=false \
+--set snapshotOperator.enabled=false \
+--set provisioner.enabled=false \
+--set apiserver.enabled=false \
+--set cstor.enabled=true \
+--set openebs-ndm.enabled=true
+```
+
+#### Install Jiva with CSI driver
+```bash
+helm install openebs openebs/openebs --namespace openebs --create-namespace \
+--set localprovisioner.enabled=false \
+--set ndm.enabled=false \
+--set ndmOperator.enabled=false \
+--set webhook.enabled=false \
+--set snapshotOperator.enabled=false \
+--set provisioner.enabled=false \
+--set apiserver.enabled=false \
+--set jiva.enabled=true \
+--set openebs-ndm.enabled=true \
+--set localpv-provisioner.enabled=true
+```
+
+#### Install ZFS Local PV
+```bash
+helm install openebs openebs/openebs --namespace openebs --create-namespace \
+--set localprovisioner.enabled=false \
+--set ndm.enabled=false \
+--set ndmOperator.enabled=false \
+--set webhook.enabled=false \
+--set snapshotOperator.enabled=false \
+--set provisioner.enabled=false \
+--set apiserver.enabled=false \
+--set zfs-localpv.enabled=true
+```
+
+#### Install LVM Local PV
+```bash
+helm install openebs openebs/openebs --namespace openebs --create-namespace \
+--set localprovisioner.enabled=false \
+--set ndm.enabled=false \
+--set ndmOperator.enabled=false \
+--set webhook.enabled=false \
+--set snapshotOperator.enabled=false \
+--set provisioner.enabled=false \
+--set apiserver.enabled=false \
+--set lvm-localpv.enabled=true
+```
+
+#### Install Local PV hostpath and device
+```bash
+helm install openebs openebs/openebs --namespace openebs --create-namespace \
+--set localprovisioner.enabled=false \
+--set ndm.enabled=false \
+--set ndmOperator.enabled=false \
+--set openebs-ndm.enabled=true \
+--set localpv-provisioner.enabled=true
+```
+
+> **Tip**: You can install multiple csi driver by merging the configuration.

charts/openebs/templates/cleanup-webhook.yaml

@@ -1,3 +1,4 @@
+{{- if .Values.webhook.enabled }}
 # HELM first deletes RBAC, then it tries to delete other resources like SPC and PVC. 
 # We've got validating webhook on SPC and PVC.
 # But even that the policy of this webhook is Ignore, it fails because the ServiceAccount 
@@ -41,3 +42,4 @@ spec:
           - >
               kubectl delete validatingWebhookConfiguration openebs-validation-webhook-cfg;
       restartPolicy: OnFailure
+{{- end }}

charts/openebs/values.yaml

@@ -571,6 +571,28 @@ zfs-localpv:
 #      repository: openebs/zfs-driver
 #      pullPolicy: IfNotPresent
 #      tag: 1.7.0
+
+# lvm local pv configuration goes here
+# ref - https://openebs.github.io/lvm-localpv
+lvm-localpv:
+  enabled: false
+
+  # Sample configuration if you want to configure lvm locapv with custom values.
+  # This is a small part of the full configuration. Full configuration available
+  # here - https://openebs.github.io/lvm-localpv
+
+#  imagePullSecrets: []
+#
+#  rbac:
+#    pspEnabled: false
+#
+#  lvmPlugin:
+#    image:
+#      registry: quay.io/
+#      repository: openebs/lvm-driver
+#      pullPolicy: IfNotPresent
+#      tag: 0.5.0
+
 cleanup:
   image:
     # Make sure that registry name end with a '/'.