From 2dbc25c8d1d2fe2f4364b6c616419dc536a5884f Mon Sep 17 00:00:00 2001 From: Niladri Halder <55788661+niladrih@users.noreply.github.com> Date: Thu, 13 May 2021 12:41:39 +0530 Subject: [PATCH] chore(helm-chart): Disable NDM installation by default (#91) Signed-off-by: Niladri Halder --- deploy/helm/charts/Chart.yaml | 4 ++-- deploy/helm/charts/README.md | 36 +++++++++++++++++++++++++++++----- deploy/helm/charts/values.yaml | 8 ++++++++ 3 files changed, 41 insertions(+), 7 deletions(-) diff --git a/deploy/helm/charts/Chart.yaml b/deploy/helm/charts/Chart.yaml index 244d7ed..95110fb 100644 --- a/deploy/helm/charts/Chart.yaml +++ b/deploy/helm/charts/Chart.yaml @@ -4,7 +4,7 @@ description: Jiva-Operator helm chart for Kubernetes type: application # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. -version: 2.8.2 +version: 2.8.3 # This is the version number of the application being deployed. This version number should be # incremented each time you make changes to the application. appVersion: 2.8.0 @@ -23,7 +23,7 @@ sources: dependencies: - name: localpv-provisioner - version: "2.8.0" + version: "2.8.1" repository: "https://openebs.github.io/dynamic-localpv-provisioner" condition: openebsLocalpv.enabled diff --git a/deploy/helm/charts/README.md b/deploy/helm/charts/README.md index 74e6afc..bc5fbef 100644 --- a/deploy/helm/charts/README.md +++ b/deploy/helm/charts/README.md @@ -31,7 +31,7 @@ Please visit the [link](https://openebs.github.io/jiva-operator) for install ins ```console # Helm -$ helm install [RELEASE_NAME] openebs-jiva/jiva +helm install [RELEASE_NAME] openebs-jiva/jiva --namespace [NAMESPACE] --create-namespace ``` _See [configuration](#configuration) below._ @@ -47,11 +47,12 @@ By default this chart installs additional, dependent charts: |------------|------|---------| | https://openebs.github.io/dynamic-localpv-provisioner | localpv-provisioner | 2.8.0 | +**Note:** Find detailed Dynamic LocalPV Provisioner Helm chart configuration options [here](https://github.com/openebs/dynamic-localpv-provisioner/blob/develop/deploy/helm/charts/README.md). To disable the dependency during installation, set `openebsLocalpv.enabled` to `false`. -```bash -helm install openebs-jiva/jiva --set openebsLocalpv.enabled=false +```console +helm install openebs-jiva/jiva --namespace --create-namespace --set openebsLocalpv.enabled=false ``` For more details on dependency see [Jiva chart readme](https://github.com/openebs/jiva-operator/blob/master/deploy/helm/charts/README.md). @@ -62,7 +63,7 @@ _See [helm dependency](https://helm.sh/docs/helm/helm_dependency/) for command d ```console # Helm -$ helm uninstall [RELEASE_NAME] +helm uninstall [RELEASE_NAME] --namespace [NAMESPACE] ``` This removes all the Kubernetes components associated with the chart and deletes the release. @@ -73,12 +74,37 @@ _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command doc ```console # Helm -$ helm upgrade [RELEASE_NAME] [CHART] --install +helm upgrade [RELEASE_NAME] [CHART] --install --namespace [NAMESPACE] ``` ## Configuration The following table lists the configurable parameters of the OpenEBS Jiva chart and their default values. +You can modify different parameters by specifying the desired value in the helm install command by using the `--set` and/or the `--set-string` flag(s). You can modify the parameters of the [Dynamic LocalPV Provisioner chart](https://openebs.github.io/dynamic-localpv-provisioner) by adding `localpv-provisioner` before the desired parameter in the helm install command. + +In the following sample command we modify `csiNode.nodeSelector` from the Jiva chart to only use the NodeSelector label `openebs.io/data-plane=true` to schedule the openebs-jiva-csi-node DaemonSet pods, and we also modify `hostpathClass.basePath` from the localpv-provisioner chart to change the BasePath directory to '/data' used by the openebs-hostpath StorageClass. + +```console +helm install openebs-jiva openebs-jiva/jiva -n openebs --create-namespace \ + --set-string csiNode.nodeSelector."openebs\.io/data-plane"=true \ + --set-string localpv-provisioner.hostpathClass.basePath="/data" +``` + +The Dynamic LocalPV Provisioner helm chart (this is a dependency for the Jiva helm chart) includes the [Node Disk Manager (NDM)](https://openebs.github.io/node-disk-manager/) helm chart. This NDM helm chart is disabled by default. You can enable the NDM chart during installation using flags as shown below: + +```console +helm install openebs-jiva openebs-jiva/jiva -n openebs --create-namespace \ + --set localpv-provisioner.openebsNDM.enabled=true \ + --set localpv-provisioner.deviceClass.enabled=true +``` + +If you have already installed Jiva without NDM, and would like to enable it after installation, use the following command: + +```console +helm upgrade openebs-jiva openebs-jiva/jiva -n openebs \ + --set localpv-provisioner.openebsNDM.enabled=true \ + --set localpv-provisioner.deviceClass.enabled=true +``` | Key | Type | Default | Description | |-----|------|---------|-------------| diff --git a/deploy/helm/charts/values.yaml b/deploy/helm/charts/values.yaml index ab641d8..23f2cc6 100644 --- a/deploy/helm/charts/values.yaml +++ b/deploy/helm/charts/values.yaml @@ -182,3 +182,11 @@ analytics: enabled: true # Specify in hours the duration after which a ping event needs to be sent. pingInterval: "24h" + +localpv-provisioner: + # Disable installation of node-disk-manager components by default + openebsNDM: + enabled: false + # Disable openebs-device deviceClass by default. + deviceClass: + enabled: false