chore(bors): merge pull request #458

458: feat(chart): prevent CRDs from being recycled r=tiagolobocastro a=cmontemuino <! Co-authored-by: cmontemuino <1761056+cmontemuino@users.noreply.github.com>
openebs · Mar 27, 2024 · 8edc783 · 8edc783
2 parents 23092a3 + 4ab5529
commit 8edc783
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 29 deletions.
diff --git a/chart/charts/crds/README.md b/chart/charts/crds/README.md
@@ -4,8 +4,12 @@ A Helm chart that collects CustomResourceDefinitions (CRDs) from Mayastor.
 
 ## Values
 
-| Key | Description | Default |
-|:----|:------------|:--------|
-| csi.&ZeroWidthSpace;volumeSnapshots.&ZeroWidthSpace;enabled | Install Volume Snapshot CRDs | `true` |
-| jaeger.&ZeroWidthSpace;enabled | Install Jaeger CRDs | `true` |
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| csi.volumeSnapshots.annotations | object | `{}` | Annotations to be added to all CRDs |
+| csi.volumeSnapshots.enabled | bool | `true` | Install Volume Snapshot CRDs |
+| csi.volumeSnapshots.keep | bool | `true` | Keep CRDs on chart uninstall |
+| jaeger.annotations | object | `{}` | Annotations to be added to all CRDs |
+| jaeger.enabled | bool | `true` | Install Jaeger CRDs |
+| jaeger.keep | bool | `true` | Keep CRDs on chart uninstall |
 
diff --git a/chart/charts/crds/templates/_helpers.tpl b/chart/charts/crds/templates/_helpers.tpl
@@ -1,19 +1,20 @@
 {{/* vim: set filetype=mustache: */}}
 
 {{/*
-    This returns a "1" if the CRD is absent in the cluster
+    Adds extra annotations to CRDs. This targets two scenarios: preventing CRD recycling in case
+    the chart is removed; and adding custom annotations.
+    NOTE: This function assumes the element `metadata.annotations` already exists.
+
     Usage:
-      {{- if (include "crdIsAbsent" (list <crd-name>)) -}}
-      # CRD Yaml
-      {{- end -}}
+      {{- include "crds.extraAnnotations" .Values.csi.volumeSnapshots | nindent 4 }}
 */}}
-{{- define "crdIsAbsent" -}}
-    {{- $crdName := index . 0 -}}
-    {{- $crd := lookup "apiextensions.k8s.io/v1" "CustomResourceDefinition" "" $crdName -}}
-    {{- $output := "1" -}}
-    {{- if $crd -}}
-        {{- $output = "" -}}
-    {{- end -}}
 
-    {{- $output -}}
-{{- end -}}
+{{- define "crds.extraAnnotations" -}}
+{{- if .keep -}}
+helm.sh/resource-policy: keep
+{{ end }}
+{{- with .annotations }}
+  {{- toYaml . }}
+{{- end }}
+{{- end -}}
+
diff --git a/chart/charts/crds/templates/csi-volume-snapshot-class.yaml b/chart/charts/crds/templates/csi-volume-snapshot-class.yaml
@@ -1,12 +1,11 @@
 {{- if .Values.csi.volumeSnapshots.enabled -}}
-{{- $crdName := "volumesnapshotclasses.snapshot.storage.k8s.io" -}}
-{{- if (include "crdIsAbsent" (list $crdName)) -}}
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
     api-approved.kubernetes.io: https://github.com/kubernetes-csi/external-snapshotter/pull/814
     controller-gen.kubebuilder.io/version: v0.11.3
+    {{- include "crds.extraAnnotations" .Values.csi.volumeSnapshots | nindent 4 }}
   creationTimestamp: null
   name: volumesnapshotclasses.snapshot.storage.k8s.io
 spec:
@@ -149,4 +148,3 @@ status:
   conditions: []
   storedVersions: []
 {{- end -}}
-{{- end -}}
diff --git a/chart/charts/crds/templates/csi-volume-snapshot-content.yaml b/chart/charts/crds/templates/csi-volume-snapshot-content.yaml
@@ -1,12 +1,11 @@
 {{- if .Values.csi.volumeSnapshots.enabled -}}
-{{- $crdName := "volumesnapshotcontents.snapshot.storage.k8s.io" -}}
-{{- if (include "crdIsAbsent" (list $crdName)) -}}
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
     api-approved.kubernetes.io: https://github.com/kubernetes-csi/external-snapshotter/pull/814
     controller-gen.kubebuilder.io/version: v0.11.3
+    {{- include "crds.extraAnnotations" .Values.csi.volumeSnapshots | nindent 4 }}
   creationTimestamp: null
   name: volumesnapshotcontents.snapshot.storage.k8s.io
 spec:
@@ -487,4 +486,3 @@ status:
   conditions: []
   storedVersions: []
 {{- end -}}
-{{- end -}}
diff --git a/chart/charts/crds/templates/csi-volume-snapshot.yaml b/chart/charts/crds/templates/csi-volume-snapshot.yaml
@@ -1,12 +1,11 @@
 {{- if .Values.csi.volumeSnapshots.enabled -}}
-{{- $crdName := "volumesnapshots.snapshot.storage.k8s.io" -}}
-{{- if (include "crdIsAbsent" (list $crdName)) -}}
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
     api-approved.kubernetes.io: https://github.com/kubernetes-csi/external-snapshotter/pull/814
     controller-gen.kubebuilder.io/version: v0.11.3
+    {{- include "crds.extraAnnotations" .Values.csi.volumeSnapshots | nindent 4 }}
   creationTimestamp: null
   name: volumesnapshots.snapshot.storage.k8s.io
 spec:
@@ -389,4 +388,3 @@ status:
   conditions: []
   storedVersions: []
 {{- end -}}
-{{- end -}}
diff --git a/chart/charts/crds/templates/jaeger.yaml b/chart/charts/crds/templates/jaeger.yaml
@@ -1,10 +1,12 @@
 {{- if .Values.jaeger.enabled -}}
-{{- $crdName := "jaegers.jaegertracing.io" -}}
-{{- if (include "crdIsAbsent" (list $crdName)) -}}
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   name: jaegers.jaegertracing.io
+  {{- if or (.Values.jaeger.keep) (.Values.jaeger.annotations) }}
+  annotations:
+    {{- include "crds.extraAnnotations" .Values.jaeger | nindent 4 }}
+  {{- end }}
   labels:
     app: jaeger-operator
 spec:
@@ -46,4 +48,3 @@ spec:
       subresources:
         status: {}
 {{- end -}}
-{{- end -}}
diff --git a/chart/charts/crds/values.yaml b/chart/charts/crds/values.yaml
@@ -1,8 +1,21 @@
 jaeger:
   # -- Install Jaeger CRDs
   enabled: true
+  # -- Keep CRDs on chart uninstall
+  keep: true
+  # -- Annotations to be added to all CRDs
+  annotations: {}
+    # Example for Argo CD to prevent CRDs from being recycled
+    # argocd.argoproj.io/sync-options: Prune=false
 
 csi:
   volumeSnapshots:
     # -- Install Volume Snapshot CRDs
     enabled: true
+    # -- Keep CRDs on chart uninstall
+    keep: true
+    # -- Annotations to be added to all CRDs
+    annotations: {}
+    # Example for Argo CD to prevent CRDs from being recycled
+    # argocd.argoproj.io/sync-options: Prune=false
+