(feat): Add TTLSecondsAfterFinished with a default of 600 seconds

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

api/v1/agentconfig_types.go

@@ -65,6 +65,11 @@ type AgentConfigSpec struct {
 	// +optional
 	VolumeSize string `json:"volumeSize,omitempty" mapstructure:"volumeSize,omitempty"`
 
+	// TTLSecondsAfterFinished set the time limit of the lifetime of a Job
+	// that has finished execution.
+	// +kubebuilder:default:=600
+	TTLSecondsAfterFinished *int32 `json:"ttlSecondsAfterFinished,omitempty" mapstructure:"ttlSecondsAftterFinished,omitempty"`
+
 	// PullPolicy specifies when to pull the Porter Agent image. The default
 	// is to use PullAlways when the tag is canary or latest, and PullIfNotPresent
 	// otherwise.
@@ -327,11 +332,16 @@ func (c AgentConfigSpecAdapter) GetInstallationServiceAccount() string {
 	return c.original.InstallationServiceAccount
 }
 
-// SetRetryAnnotation flags the resource to retry its last operation.
+// GetRetryLimit flags the resource to retry its last operation.
 func (c *AgentConfigSpecAdapter) GetRetryLimit() *int32 {
 	return c.original.RetryLimit
 }
 
+// GetTTLSecondsAfterFinished returns the config value of TTLSecondsAfterFinished
+func (c *AgentConfigSpecAdapter) GetTTLSecondsAfterFinished() *int32 {
+	return c.original.TTLSecondsAfterFinished
+}
+
 func (c AgentConfigSpecAdapter) ToPorterDocument() ([]byte, error) {
 	raw := struct {
 		SchemaType    string            `yaml:"schemaType"`

api/v1/agentconfig_types_test.go

@@ -370,6 +370,30 @@ func TestAgentConfigSpecAdapter_GetRetryLimit(t *testing.T) {
 	}
 }
 
+func TestAgentConfigSpecAdapter_GetTTLSecondsAfterFinished(t *testing.T) {
+	var testdataNonZero int32 = 2
+	var testdataZero int32 = 0
+	testcases := []struct {
+		name                    string
+		TTLSecondsAfterFinished *int32
+		expected                *int32
+	}{
+		{name: "non-zero value", TTLSecondsAfterFinished: &testdataNonZero, expected: &testdataNonZero},
+		{name: "set to 0", TTLSecondsAfterFinished: &testdataZero, expected: &testdataZero},
+		{name: "not defined", TTLSecondsAfterFinished: nil, expected: nil},
+	}
+
+	for _, tc := range testcases {
+		t.Run(tc.name, func(t *testing.T) {
+			adapter := NewAgentConfigSpecAdapter(AgentConfigSpec{
+				TTLSecondsAfterFinished: tc.TTLSecondsAfterFinished,
+			})
+			result := adapter.GetTTLSecondsAfterFinished()
+			require.Equal(t, tc.expected, result)
+		})
+	}
+}
+
 func TestHashString(t *testing.T) {
 	str := hashString("fake-string")
 	assert.Equal(t, "ab19e45285992b247dd281213f803479", str)

controllers/agentaction_controller.go

@@ -420,8 +420,9 @@ func (r *AgentActionReconciler) createAgentJob(ctx context.Context, log logr.Log
 			},
 		},
 		Spec: batchv1.JobSpec{
-			Completions:  ptr.To(int32(1)),
-			BackoffLimit: agentCfg.GetRetryLimit(),
+			Completions:             ptr.To(int32(1)),
+			BackoffLimit:            agentCfg.GetRetryLimit(),
+			TTLSecondsAfterFinished: agentCfg.GetTTLSecondsAfterFinished(),
 			Template: corev1.PodTemplateSpec{
 				ObjectMeta: metav1.ObjectMeta{
 					GenerateName: action.Name + "-",

tests/integration/suite_test.go

@@ -16,7 +16,7 @@ import (
 	"k8s.io/client-go/kubernetes/scheme"
 	clientgoscheme "k8s.io/client-go/kubernetes/scheme"
 	"k8s.io/client-go/rest"
-	"k8s.io/utils/pointer"
+	"k8s.io/utils/ptr"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/envtest"
@@ -48,7 +48,7 @@ var _ = BeforeSuite(func(done Done) {
 
 	By("bootstrapping test environment")
 	testEnv = &envtest.Environment{
-		UseExistingCluster: pointer.Bool(true),
+		UseExistingCluster: ptr.To(true),
 		CRDDirectoryPaths:  []string{filepath.Join("..", "config", "crd", "bases")},
 	}