feat(testkube-api): ability to specify annotations on job templates (#…

…873) (#874) Similar to `jobPodAnnotations` the introduced `jobAnnotations` enables defining annotations which are applied to the default job templates on installation of testkube-api via Helm. One use case is to add annotations to prevent ArgoCD from automatically pruning (deleting) these jobs as soon as they are spawned, which otherwise prevents tests from executing successfully. Fixes #695 Co-authored-by: frederikb <[email protected]>
kubeshop · Jun 5, 2024 · 02229b6 · 02229b6
1 parent 2b8445d
commit 02229b6
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 0 deletions.
diff --git a/charts/testkube-api/templates/_job-container-template.yaml.tpl b/charts/testkube-api/templates/_job-container-template.yaml.tpl
@@ -5,6 +5,10 @@ kind: Job
 metadata:
   name: "{{`{{ .Name }}`}}"
   namespace: {{`{{ .Namespace }}`}}
+  {{- with .Values.jobAnnotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
 spec:
   {{`{{- if gt .ActiveDeadlineSeconds 0 }}`}}
   activeDeadlineSeconds: {{`{{ .ActiveDeadlineSeconds }}`}}

diff --git a/charts/testkube-api/templates/_job-scraper-template.yaml.tpl b/charts/testkube-api/templates/_job-scraper-template.yaml.tpl
@@ -5,6 +5,10 @@ kind: Job
 metadata:
   name: {{`{{ .Name }}`}}-scraper
   namespace: {{`{{ .Namespace }}`}}
+  {{- with .Values.jobAnnotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
 spec:
   {{`{{- if gt .ActiveDeadlineSeconds 0 }}`}}
   activeDeadlineSeconds: {{`{{ .ActiveDeadlineSeconds }}`}}

diff --git a/charts/testkube-api/templates/_job-template.yaml.tpl b/charts/testkube-api/templates/_job-template.yaml.tpl
@@ -5,6 +5,10 @@ kind: Job
 metadata:
   name: "{{`{{ .Name }}`}}"
   namespace: {{`{{ .Namespace }}`}}
+  {{- with .Values.jobAnnotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
 spec:
   {{`{{- if gt .ActiveDeadlineSeconds 0 }}`}}
   activeDeadlineSeconds: {{`{{ .ActiveDeadlineSeconds }}`}}

diff --git a/charts/testkube-api/values.yaml b/charts/testkube-api/values.yaml
@@ -87,6 +87,10 @@ fullnameOverride: ""
 # set annotations for all workflows.
 jobPodAnnotations: {}
 
+# jobAnnotations adds annotations to the jobs spawned to execute tests using
+# prebuilt and container executors, when using the default job templates.
+jobAnnotations: {}
+
 ## Custom job-container-template.yml that will be passed to Testkube API
 jobContainerTemplate: ""
 

diff --git a/charts/testkube/values.yaml b/charts/testkube/values.yaml
@@ -344,6 +344,10 @@ testkube-api:
   # set annotations for all workflows.
   jobPodAnnotations: {}
 
+  # jobAnnotations adds annotations to the jobs spawned to execute tests using
+  # prebuilt and container executors, when using the default job templates.
+  jobAnnotations: {}
+
   # Custom job-container-template.yml that will be passed to Testkube API
   #  jobContainerTemplate: ""
   #