refactor(chart): provide CRDs in a subchart

This changeset is mainly intended to skip Jaeger CRDs if it is not
enabled. This is especially relevant when Jaeger tracing is installed
separately from OpenEBS Mayastor.

Helm 3 does not manage CRDs.
- https://helm.sh/docs/chart_best_practices/custom_resource_definitions

`helm uninstall` won't remove CRDs, and `helm updgrade` won't upgrade
them. Manual intervention is required with the current setup.
 - CRDs installed from `crds` folder are not included into the
 helm release.

Additionally, it is not possible to template CRDs in Helm 3 in the
`crds` folder.

Moving CRDs to a chart solves several issues: clean uninstall,
possibility for upgrades, templating.

Also make volumeSnapshots CRD optional

.gitignore

@@ -10,7 +10,9 @@
 /result*
 __pycache__
 /tests/bdd/openapi/
-/chart/charts/
+/chart/charts/*
+# charts/crds is valid chart for git
+!/chart/charts/crds/
 /chart/Chart.lock
 !/openapi/Cargo.toml
 !/openapi/build.rs

chart/Chart.yaml

@@ -25,6 +25,9 @@ version: 0.0.0
 appVersion: "0.0.0"
 
 dependencies:
+  - name: crds
+    version: "0.0.0"
+    condition: crds.enabled
   - name: etcd
     repository: https://charts.bitnami.com/bitnami
     version: 8.6.0

chart/README.md

@@ -33,17 +33,28 @@ $ helm install mayastor . -n <mayastor-namespace>
 
 ### Installing the Chart via Helm Registry
 
-To install the chart with the release name `my-release`:
+To install the chart with the release name `mymayastor`:
 
 ```console
-$ helm repo add openebs https://openebs.github.io/mayastor-extensions/
-$ helm install my-release openebs/mayastor
+$ helm repo add mayastor https://openebs.github.io/mayastor-extensions/
+$ helm install mymayastor mayastor/mayastor
 ```
 
+### Uninstall Helm Chart
+
+```console
+$ helm uninstall [RELEASE_NAME] 
+```
+
+This removes all the Kubernetes components associated with the chart and deletes the release.
+
+*See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation.*
+
 ## Chart Dependencies
 
 | Repository | Name | Version |
 |------------|------|---------|
+|  | crds | 0.0.0 |
 | https://charts.bitnami.com/bitnami | etcd | 8.6.0 |
 | https://grafana.github.io/helm-charts | loki-stack | 2.9.11 |
 | https://jaegertracing.github.io/helm-charts | jaeger-operator | 2.25.0 |
@@ -93,6 +104,8 @@ $ helm install my-release openebs/mayastor
 | base.&ZeroWidthSpace;jaeger.&ZeroWidthSpace;enabled | Enable jaeger tracing | `false` |
 | base.&ZeroWidthSpace;logSilenceLevel | Silence specific module components | `nil` |
 | base.&ZeroWidthSpace;metrics.&ZeroWidthSpace;enabled | Enable the metrics exporter | `true` |
+| crds.&ZeroWidthSpace;enabled | Install CRDs | `true` |
+| crds.&ZeroWidthSpace;jaeger.&ZeroWidthSpace;enabled | Install Jaeger CRDs | `false` |
 | csi.&ZeroWidthSpace;controller.&ZeroWidthSpace;logLevel | Log level for the csi controller | `"info"` |
 | csi.&ZeroWidthSpace;controller.&ZeroWidthSpace;preventVolumeModeConversion | Prevent modifying the volume mode when creating a PVC from an existing VolumeSnapshot | `true` |
 | csi.&ZeroWidthSpace;controller.&ZeroWidthSpace;priorityClassName | Set PriorityClass, overrides global | `""` |

chart/README.md.tmpl

@@ -32,13 +32,23 @@ $ helm install mayastor . -n <mayastor-namespace>
 
 ### Installing the Chart via Helm Registry
 
-To install the chart with the release name `my-release`:
+To install the chart with the release name `mymayastor`:
 
 ```console
-$ helm repo add openebs https://openebs.github.io/mayastor-extensions/
-$ helm install my-release openebs/{{ template "chart.name" . }}
+$ helm repo add mayastor https://openebs.github.io/mayastor-extensions/
+$ helm install mymayastor mayastor/{{ template "chart.name" . }}
 ```
 
+### Uninstall Helm Chart
+
+```console
+$ helm uninstall [RELEASE_NAME] 
+```
+
+This removes all the Kubernetes components associated with the chart and deletes the release.
+
+*See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation.*
+
 ## Chart Dependencies
 
 {{ template "chart.requirementsTable" . }}

chart/charts/crds/Chart.yaml

@@ -0,0 +1,7 @@
+apiVersion: v2
+name: crds
+version: 0.0.0
+description: |
+  A Helm chart that collects custom resource definitions (CRDs) from Mayastor. It also includes one CRD
+  from Jaeger tracing when enabled.
+

chart/charts/crds/README.md

@@ -0,0 +1,4 @@
+# Mayastor CRDs
+
+This chart brings Custom Resource Definitions (CRDs) used by Mayastor.
+

chart/crds/csi-volume-snapshot-class.yaml → chart/charts/crds/templates/csi-volume-snapshot-class.yaml

@@ -1,3 +1,4 @@
+{{- if .Values.volumeSnapshots.enabled -}}
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
@@ -145,3 +146,4 @@ status:
     plural: ""
   conditions: []
   storedVersions: []
+{{- end -}}

chart/crds/csi-volume-snapshot-content.yaml → chart/charts/crds/templates/csi-volume-snapshot-content.yaml

@@ -1,3 +1,4 @@
+{{- if .Values.volumeSnapshots.enabled -}}
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
@@ -483,3 +484,4 @@ status:
     plural: ""
   conditions: []
   storedVersions: []
+{{- end -}}

chart/crds/csi-volume-snapshot.yaml → chart/charts/crds/templates/csi-volume-snapshot.yaml

@@ -1,3 +1,4 @@
+{{- if .Values.volumeSnapshots.enabled -}}
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
@@ -385,3 +386,4 @@ status:
     plural: ""
   conditions: []
   storedVersions: []
+{{- end -}}

chart/crds/jaeger.yaml → chart/charts/crds/templates/jaeger.yaml

@@ -1,3 +1,4 @@
+{{- if .Values.jaeger.enabled -}}
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
@@ -42,3 +43,4 @@ spec:
       storage: true
       subresources:
         status: {}
+{{- end -}}

chart/charts/crds/values.yaml

@@ -0,0 +1,6 @@
+jaeger:
+  # -- Install Jaeger CRDs
+  enabled: true
+  # -- Install Volume Snapshots CRD
+  volumeSnapshots:
+    enabled: true

chart/values.yaml

@@ -1,3 +1,10 @@
+crds:
+  # -- Install CRDs
+  enabled: true
+  jaeger:
+    # -- Install Jaeger CRDs
+    enabled: false
+
 image:
   # -- Image registry to pull our product images
   registry: docker.io