Chart: Make cleanup cronjob cmd/args configurable (#17970)

apache · Sep 1, 2021 · 617fed9 · 617fed9
1 parent 4d52207
commit 617fed9
Show file tree

Hide file tree

Showing 4 changed files with 84 additions and 2 deletions.
diff --git a/chart/templates/cleanup/cleanup-cronjob.yaml b/chart/templates/cleanup/cleanup-cronjob.yaml
@@ -63,8 +63,12 @@ spec:
             - name: airflow-cleanup-pods
               image: {{ template "airflow_image" . }}
               imagePullPolicy: {{ .Values.images.airflow.pullPolicy }}
-              # Don't use entry point here, we don't need to wait on pg-bouncer etc being available.
-              args: ["kubernetes", "cleanup-pods", "--namespace={{ .Release.Namespace }}"]
+              {{- if .Values.cleanup.command }}
+              command: {{ tpl (toYaml .Values.cleanup.command) . | nindent 16 }}
+              {{- end }}
+              {{- if .Values.cleanup.args }}
+              args: {{ tpl (toYaml .Values.cleanup.args) . | nindent 16 }}
+              {{- end }}
               env:
               {{- include "standard_airflow_environment" . | indent 12 }}
               volumeMounts:

diff --git a/chart/tests/test_cleanup_pods.py b/chart/tests/test_cleanup_pods.py
@@ -18,6 +18,7 @@
 import unittest
 
 import jmespath
+from parameterized import parameterized
 
 from tests.helm_template_generator import render_chart
 
@@ -104,3 +105,49 @@ def test_should_create_valid_affinity_tolerations_and_node_selector(self):
             "spec.jobTemplate.spec.template.spec.tolerations[0].key",
             docs[0],
         )
+
+    def test_default_command_and_args(self):
+        docs = render_chart(
+            values={"cleanup": {"enabled": True}}, show_only=["templates/cleanup/cleanup-cronjob.yaml"]
+        )
+
+        assert jmespath.search("spec.jobTemplate.spec.template.spec.containers[0].command", docs[0]) is None
+        assert ["bash", "-c", "exec airflow kubernetes cleanup-pods --namespace=default"] == jmespath.search(
+            "spec.jobTemplate.spec.template.spec.containers[0].args", docs[0]
+        )
+
+    @parameterized.expand(
+        [
+            (None, None),
+            (None, ["custom", "args"]),
+            (["custom", "command"], None),
+            (["custom", "command"], ["custom", "args"]),
+        ]
+    )
+    def test_command_and_args_overrides(self, command, args):
+        docs = render_chart(
+            values={"cleanup": {"enabled": True, "command": command, "args": args}},
+            show_only=["templates/cleanup/cleanup-cronjob.yaml"],
+        )
+
+        assert command == jmespath.search(
+            "spec.jobTemplate.spec.template.spec.containers[0].command", docs[0]
+        )
+        assert args == jmespath.search("spec.jobTemplate.spec.template.spec.containers[0].args", docs[0])
+
+    def test_log_groomer_command_and_args_overrides_are_templated(self):
+        docs = render_chart(
+            values={
+                "cleanup": {
+                    "enabled": True,
+                    "command": ["{{ .Release.Name }}"],
+                    "args": ["{{ .Release.Service }}"],
+                }
+            },
+            show_only=["templates/cleanup/cleanup-cronjob.yaml"],
+        )
+
+        assert ["RELEASE-NAME"] == jmespath.search(
+            "spec.jobTemplate.spec.template.spec.containers[0].command", docs[0]
+        )
+        assert ["Helm"] == jmespath.search("spec.jobTemplate.spec.template.spec.containers[0].args", docs[0])
diff --git a/chart/values.schema.json b/chart/values.schema.json
@@ -2862,6 +2862,32 @@
                     "type": "string",
                     "default": "*/15 * * * *"
                 },
+                "command": {
+                    "description": "Command to use when running the cleanup cronjob (templated).",
+                    "type": [
+                        "array",
+                        "null"
+                    ],
+                    "items": {
+                        "type": "string"
+                    },
+                    "default": null
+                },
+                "args": {
+                    "description": "Args to use when running the cleanup cronjob (templated).",
+                    "type": [
+                        "array",
+                        "null"
+                    ],
+                    "items": {
+                        "type": "string"
+                    },
+                    "default": [
+                        "bash",
+                        "-c",
+                        "exec airflow kubernetes cleanup-pods --namespace={{ .Release.Namespace }}"
+                    ]
+                },
                 "nodeSelector": {
                     "description": "Select certain nodes for cleanup pods.",
                     "type": "object",

diff --git a/chart/values.yaml b/chart/values.yaml
@@ -1117,6 +1117,11 @@ cleanup:
   enabled: false
   # Run every 15 minutes
   schedule: "*/15 * * * *"
+  # Command to use when running the cleanup cronjob (templated).
+  command: ~
+  # Args to use when running the cleanup cronjob (templated).
+  args: ["bash", "-c", "exec airflow kubernetes cleanup-pods --namespace={{ .Release.Namespace }}"]
+
 
   # Select certain nodes for airflow cleanup pods.
   nodeSelector: {}