feat: introduce configurable TTLSecondsAfterFinished for tasks (#2404)

Signed-off-by: Griffin <[email protected]>

.github/scripts/.helm-tests/default/result.yaml

@@ -4238,6 +4238,13 @@ spec:
                   within this time frame, it will be considered to be failed.
                 pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
                 type: string
+              ttlSecondsAfterFinished:
+                default: 300
+                description: TTLSecondsAfterFinished controller makes a job eligible
+                  to be cleaned up after it is finished. The timer starts when the
+                  status shows up to be Complete or Failed.
+                format: int32
+                type: integer
             type: object
           status:
             description: Status describes the current state of the KeptnTaskDefinition.

.github/scripts/.helm-tests/lifecycle-only/result.yaml

@@ -4184,6 +4184,13 @@ spec:
                   within this time frame, it will be considered to be failed.
                 pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
                 type: string
+              ttlSecondsAfterFinished:
+                default: 300
+                description: TTLSecondsAfterFinished controller makes a job eligible
+                  to be cleaned up after it is finished. The timer starts when the
+                  status shows up to be Complete or Failed.
+                format: int32
+                type: integer
             type: object
           status:
             description: Status describes the current state of the KeptnTaskDefinition.

.github/scripts/.helm-tests/lifecycle-with-certs/result.yaml

@@ -4199,6 +4199,13 @@ spec:
                   within this time frame, it will be considered to be failed.
                 pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
                 type: string
+              ttlSecondsAfterFinished:
+                default: 300
+                description: TTLSecondsAfterFinished controller makes a job eligible
+                  to be cleaned up after it is finished. The timer starts when the
+                  status shows up to be Complete or Failed.
+                format: int32
+                type: integer
             type: object
           status:
             description: Status describes the current state of the KeptnTaskDefinition.

docs/content/en/docs/crd-ref/lifecycle/v1alpha3/_index.md

@@ -602,6 +602,7 @@ _Appears in:_
 | `timeout` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#duration-v1-meta)_ | Timeout specifies the maximum time to wait for the task to be completed successfully. If the task does not complete successfully within this time frame, it will be considered to be failed. |
 | `serviceAccount` _[ServiceAccountSpec](#serviceaccountspec)_ | ServiceAccount specifies the service account to be used in jobs to authenticate with the Kubernetes API and access cluster resources. |
 | `automountServiceAccountToken` _[AutomountServiceAccountTokenSpec](#automountserviceaccounttokenspec)_ | AutomountServiceAccountToken allows to enable K8s to assign cluster API credentials to a pod, if set to false the pod will decline the service account |
+| `ttlSecondsAfterFinished` _integer_ | TTLSecondsAfterFinished controller makes a job eligible to be cleaned up after it is finished. The timer starts when the status shows up to be Complete or Failed. |
 
 
 #### KeptnTaskDefinitionStatus

lifecycle-operator/apis/lifecycle/v1alpha3/keptntaskdefinition_types.go

@@ -60,6 +60,10 @@ type KeptnTaskDefinitionSpec struct {
 	// AutomountServiceAccountToken allows to enable K8s to assign cluster API credentials to a pod, if set to false
 	// the pod will decline the service account
 	AutomountServiceAccountToken *AutomountServiceAccountTokenSpec `json:"automountServiceAccountToken,omitempty"`
+	// TTLSecondsAfterFinished controller makes a job eligible to be cleaned up after it is finished.
+	// The timer starts when the status shows up to be Complete or Failed.
+	// +kubebuilder:default:=300
+	TTLSecondsAfterFinished *int32 `json:"ttlSecondsAfterFinished,omitempty"`
 }
 
 type RuntimeSpec struct {

lifecycle-operator/chart/templates/keptntaskdefinition-crd.yaml

@@ -1713,6 +1713,13 @@ spec:
                   within this time frame, it will be considered to be failed.
                 pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
                 type: string
+              ttlSecondsAfterFinished:
+                default: 300
+                description: TTLSecondsAfterFinished controller makes a job eligible
+                  to be cleaned up after it is finished. The timer starts when the
+                  status shows up to be Complete or Failed.
+                format: int32
+                type: integer
             type: object
           status:
             description: Status describes the current state of the KeptnTaskDefinition.

lifecycle-operator/config/crd/bases/lifecycle.keptn.sh_keptntaskdefinitions.yaml

@@ -1708,6 +1708,13 @@ spec:
                   within this time frame, it will be considered to be failed.
                 pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
                 type: string
+              ttlSecondsAfterFinished:
+                default: 300
+                description: TTLSecondsAfterFinished controller makes a job eligible
+                  to be cleaned up after it is finished. The timer starts when the
+                  status shows up to be Complete or Failed.
+                format: int32
+                type: integer
             type: object
           status:
             description: Status describes the current state of the KeptnTaskDefinition.

lifecycle-operator/controllers/lifecycle/keptntask/job_utils.go

@@ -111,8 +111,9 @@ func (r *KeptnTaskReconciler) generateJob(ctx context.Context, task *klcv1alpha3
 					AutomountServiceAccountToken: definition.GetAutomountServiceAccountToken(),
 				},
 			},
-			BackoffLimit:          task.Spec.Retries,
-			ActiveDeadlineSeconds: task.GetActiveDeadlineSeconds(),
+			BackoffLimit:            task.Spec.Retries,
+			ActiveDeadlineSeconds:   task.GetActiveDeadlineSeconds(),
+			TTLSecondsAfterFinished: definition.Spec.TTLSecondsAfterFinished,
 		},
 	}
 	err := controllerutil.SetControllerReference(task, job, r.Scheme)

lifecycle-operator/controllers/lifecycle/keptntask/job_utils_test.go

@@ -207,8 +207,9 @@ func TestKeptnTaskReconciler_generateJob(t *testing.T) {
 	svcAccname := "svcAccname"
 	taskDefinitionName := "my-task-definition"
 	token := true
+	var ttlSecondsAfterFinished int32 = 100
 
-	taskDefinition := makeTaskDefinitionWithServiceAccount(taskDefinitionName, namespace, svcAccname, &token)
+	taskDefinition := makeTaskDefinitionWithServiceAccount(taskDefinitionName, namespace, svcAccname, &token, &ttlSecondsAfterFinished)
 	taskDefinition.Spec.ServiceAccount.Name = svcAccname
 	fakeClient := testcommon.NewTestClient(taskDefinition)
 	task := makeTask(taskName, namespace, taskDefinitionName)
@@ -249,6 +250,7 @@ func TestKeptnTaskReconciler_generateJob(t *testing.T) {
 	require.NotNil(t, resultingJob.Spec.Template.Spec.Containers)
 	require.Equal(t, resultingJob.Spec.Template.Spec.ServiceAccountName, svcAccname)
 	require.Equal(t, resultingJob.Spec.Template.Spec.AutomountServiceAccountToken, &token)
+	require.Equal(t, resultingJob.Spec.TTLSecondsAfterFinished, &ttlSecondsAfterFinished)
 	require.Equal(t, map[string]string{
 		"label1": "label2",
 	}, resultingJob.Labels)
@@ -334,7 +336,7 @@ func makeConfigMap(name, namespace string) *v1.ConfigMap {
 	}
 }
 
-func makeTaskDefinitionWithServiceAccount(name, namespace, serviceAccountName string, token *bool) *klcv1alpha3.KeptnTaskDefinition {
+func makeTaskDefinitionWithServiceAccount(name, namespace, serviceAccountName string, token *bool, ttlSeconds *int32) *klcv1alpha3.KeptnTaskDefinition {
 	return &klcv1alpha3.KeptnTaskDefinition{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:      name,
@@ -356,6 +358,7 @@ func makeTaskDefinitionWithServiceAccount(name, namespace, serviceAccountName st
 			AutomountServiceAccountToken: &klcv1alpha3.AutomountServiceAccountTokenSpec{
 				Type: token,
 			},
+			TTLSecondsAfterFinished: ttlSeconds,
 		},
 	}
 }

test/integration/TTLSecondsAfterFinished-in-jobs/00-assert.yaml

@@ -0,0 +1,15 @@
+apiVersion: batch/v1
+kind: Job
+metadata:
+  annotations:
+    keptn.sh/app: test-app
+    keptn.sh/task-name: ttlsecondstask-job
+    keptn.sh/version: 1.0.0
+    keptn.sh/workload: my-test-workload
+spec:
+  ttlSecondsAfterFinished: 100
+status:
+  conditions:
+    - type: Complete
+      status: 'True'
+  succeeded: 1

test/integration/TTLSecondsAfterFinished-in-jobs/00-install.yaml

@@ -0,0 +1,28 @@
+apiVersion: lifecycle.keptn.sh/v1alpha3
+kind: KeptnTaskDefinition
+metadata:
+  name: ttlsecondsafterfinished-task
+spec:
+  ttlSecondsAfterFinished: 100
+  retries: 0
+  timeout: 30s
+  container:
+    command:
+    name: rancher
+    image: rancher/cowsay:latest
+    args:
+      - 'hello world'
+---
+apiVersion: lifecycle.keptn.sh/v1alpha3
+kind: KeptnTask
+metadata:
+  name: ttlsecondstask-job
+spec:
+  taskDefinition: ttlsecondsafterfinished-task
+  context:
+    appName: "test-app"
+    appVersion: "1.0.0"
+    objectType: ""
+    taskType: ""
+    workloadName: "my-test-workload"
+    workloadVersion: "1.0.0"