Run migrate job as pre hook with option to auto cleanup

xref: https://x.com/tsaha/status/1805382111844778275

Signed-off-by: Tamal Saha <[email protected]>

Author: tamalsaha

charts/openfga/Chart.yaml

@@ -3,7 +3,7 @@ name: openfga
 description: A Kubernetes Helm chart for the OpenFGA project.
 
 type: application
-version: 0.2.6
+version: 0.2.7
 appVersion: "v1.5.4"
 
 home: "https://openfga.github.io/helm-charts"

charts/openfga/templates/deployment.yaml

@@ -15,6 +15,7 @@ spec:
   selector:
     matchLabels:
       {{- include "openfga.selectorLabels" . | nindent 6 }}
+      app.kubernetes.io/component: server
   template:
     metadata:
       annotations:
@@ -26,6 +27,7 @@ spec:
         prometheus.io/port: "{{ (split ":" .Values.telemetry.metrics.addr)._1 }}"
       labels:
         {{- include "openfga.selectorLabels" . | nindent 8 }}
+        app.kubernetes.io/component: server
     spec:
       {{- with .Values.imagePullSecrets }}
       imagePullSecrets:

charts/openfga/templates/job.yaml

@@ -8,19 +8,35 @@ metadata:
   {{- with .Values.migrate.labels }}
     {{- toYaml . | nindent 4}}
   {{- end}}
-  {{- with .Values.migrate.annotations }}
   annotations:
-    {{- toYaml . | nindent 4 }}
-  {{- end }}
+  {{- with .Values.migrate.annotations }}
+    {{- toYaml . | nindent 4}}
+  {{- end}}
+  {{- if .Values.migrate.hook.enable }}
+    helm.sh/hook: {{ .Values.migrate.hook.hook | quote }}
+    helm.sh/hook-weight: {{ .Values.migrate.hook.hookWeight | quote }}
+    helm.sh/hook-delete-policy: {{ .Values.migrate.hook.hookDeletePolicy | quote }}
+  {{- end}}
 spec:
+  backoffLimit: 3
+  {{- if ge (int .Values.migrate.ttlSecondsAfterFinished) 0 }}
+  ttlSecondsAfterFinished: {{ .Values.migrate.ttlSecondsAfterFinished }}
+  {{- end }}
+  manualSelector: true
+  selector:
+    matchLabels:
+      {{- include "openfga.selectorLabels" . | nindent 6 }}
+      app.kubernetes.io/component: migrate
   template:
     metadata:
       {{- with .Values.migrate.annotations }}
       annotations:
         {{- toYaml . | nindent 8 }}
       {{- end }}
-      {{- with .Values.migrate.labels }}
       labels:
+        {{- include "openfga.selectorLabels" . | nindent 8 }}
+        app.kubernetes.io/component: migrate
+      {{- with .Values.migrate.labels }}
         {{- toYaml . | nindent 8 }}
       {{- end }}
     spec:
@@ -79,5 +95,4 @@ spec:
       tolerations:
         {{- toYaml . | nindent 8 }}
       {{- end }}
-  backoffLimit: 1
 {{- end }}

charts/openfga/values.yaml

@@ -320,9 +320,14 @@ affinity: {}
 sidecars: []
 migrate:
   sidecars: []
-  annotations:
-    helm.sh/hook: "post-install, post-upgrade, post-rollback, post-delete"
-    helm.sh/hook-weight: "-5"
-    helm.sh/hook-delete-policy: "before-hook-creation"
+  # https://github.com/fluxcd/flux2/discussions/1085#discussioncomment-473271
+  # https://github.com/helm/helm/issues/9027#issuecomment-1908032461
+  hook:
+    enable: true
+    hook: "post-install, post-upgrade, post-rollback, post-delete"
+    hookWeight: "-5"
+    hookDeletePolicy: "before-hook-creation"
+  annotations: {}
   labels: {}
   timeout:
+  ttlSecondsAfterFinished: -1