Merge pull request #745 from terraform-providers/add-ttl-after

Add ttlSecondsAfterFinished to kubernetes_job and kubernetes_cron_job

Author: jrhouston

kubernetes/provider_test.go

@@ -8,6 +8,7 @@ import (
 	"testing"
 
 	gversion "github.com/hashicorp/go-version"
+	"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
 	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/terraform"
 	"github.com/terraform-providers/terraform-provider-aws/aws"
@@ -218,20 +219,8 @@ func getClusterVersion() (*gversion.Version, error) {
 }
 
 func skipIfClusterVersionLessThan(t *testing.T, vs string) {
-	cv, err := getClusterVersion()
-
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	v, err := gversion.NewVersion(vs)
-
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	if cv.LessThan(v) {
-		t.Skip(fmt.Sprintf("This test will only run on cluster versions %v and above", v))
+	if clusterVersionLessThan(vs) {
+		t.Skip(fmt.Sprintf("This test will only run on cluster versions %v and above", vs))
 	}
 }
 
@@ -325,6 +314,32 @@ func getFirstNode() (api.Node, error) {
 	return resp.Items[0], nil
 }
 
+func clusterVersionLessThan(vs string) bool {
+	cv, err := getClusterVersion()
+
+	if err != nil {
+		return false
+	}
+
+	v, err := gversion.NewVersion(vs)
+
+	if err != nil {
+		return false
+	}
+
+	return cv.LessThan(v)
+}
+
+func skipCheckIf(skip func() (bool, string), check resource.TestCheckFunc) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		if s, reason := skip(); s {
+			fmt.Println("Skipping check:", reason)
+			return nil
+		}
+		return check(s)
+	}
+}
+
 type currentEnv struct {
 	Config            string
 	Ctx               string

kubernetes/resource_kubernetes_job_test.go

@@ -2,6 +2,7 @@ package kubernetes
 
 import (
 	"fmt"
+	"os"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-sdk/helper/acctest"
@@ -11,6 +12,10 @@ import (
 	meta_v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
+func ttlAfterDisabled() (bool, string) {
+	return os.Getenv("FEATURE_GATE_TTL_AFTER_FINISHED") != "enabled", "TTLAfterFinished is not enabled"
+}
+
 func TestAccKubernetesJob_basic(t *testing.T) {
 	var conf api.Job
 	name := fmt.Sprintf("tf-acc-test-%s", acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum))
@@ -37,6 +42,9 @@ func TestAccKubernetesJob_basic(t *testing.T) {
 					resource.TestCheckResourceAttr("kubernetes_job.test", "spec.0.parallelism", "2"),
 					resource.TestCheckResourceAttr("kubernetes_job.test", "spec.0.template.0.spec.0.container.0.name", "hello"),
 					resource.TestCheckResourceAttr("kubernetes_job.test", "spec.0.template.0.spec.0.container.0.image", "alpine"),
+
+					skipCheckIf(ttlAfterDisabled,
+						resource.TestCheckResourceAttr("kubernetes_job.test", "spec.0.ttl_seconds_after_finished", "10")),
 				),
 			},
 			{
@@ -58,6 +66,9 @@ func TestAccKubernetesJob_basic(t *testing.T) {
 					resource.TestCheckResourceAttr("kubernetes_job.test", "spec.0.manual_selector", "true"),
 					resource.TestCheckResourceAttr("kubernetes_job.test", "spec.0.template.0.spec.0.container.0.name", "hello"),
 					resource.TestCheckResourceAttr("kubernetes_job.test", "spec.0.template.0.spec.0.container.0.image", "alpine"),
+
+					skipCheckIf(ttlAfterDisabled,
+						resource.TestCheckResourceAttr("kubernetes_job.test", "spec.0.ttl_seconds_after_finished", "0")),
 				),
 			},
 		},
@@ -126,6 +137,7 @@ resource "kubernetes_job" "test" {
 	}
 	spec {
 		active_deadline_seconds = 120
+		ttl_seconds_after_finished = 10
 		backoff_limit = 10
 		completions = 10
 		parallelism = 2

kubernetes/schema_job_spec.go

@@ -127,6 +127,13 @@ func jobSpecFields() map[string]*schema.Schema {
 				Schema: podTemplateFields,
 			},
 		},
+		"ttl_seconds_after_finished": {
+			Type:         schema.TypeInt,
+			Optional:     true,
+			ForceNew:     true,
+			ValidateFunc: validatePositiveInteger,
+			Description:  "ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes.",
+		},
 	}
 
 	return s

kubernetes/structure_job.go

@@ -48,6 +48,10 @@ func flattenJobSpec(in batchv1.JobSpec, d *schema.ResourceData, prefix ...string
 	}
 	att["template"] = podSpec
 
+	if in.TTLSecondsAfterFinished != nil {
+		att["ttl_seconds_after_finished"] = *in.TTLSecondsAfterFinished
+	}
+
 	return []interface{}{att}, nil
 }
 
@@ -90,6 +94,10 @@ func expandJobSpec(j []interface{}) (batchv1.JobSpec, error) {
 	}
 	obj.Template = *template
 
+	if v, ok := in["ttl_seconds_after_finished"].(int); ok && v > 0 {
+		obj.TTLSecondsAfterFinished = ptrToInt32(int32(v))
+	}
+
 	return obj, nil
 }
 

website/docs/r/cron_job.html.markdown

@@ -29,6 +29,7 @@ resource "kubernetes_cron_job" "demo" {
     starting_deadline_seconds     = 10
     successful_jobs_history_limit = 10
     suspend                       = true
+    ttl_seconds_after_finished    = 10
     job_template {
       metadata {}
       spec {
@@ -110,6 +111,7 @@ More info: http://kubernetes.io/docs/user-guide/labels
 * `parallelism` - (Optional) Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when `((.spec.completions - .status.successful) < .spec.parallelism)`, i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
 * `selector` - (Optional) A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
 * `template` - (Optional) Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
+* `ttl_seconds_after_finished` - (Optional) ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes.
 
 ### `selector`
 

website/docs/r/job.html.markdown

@@ -79,6 +79,7 @@ More info: http://kubernetes.io/docs/user-guide/labels
 * `parallelism` - (Optional) Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when `((.spec.completions - .status.successful) < .spec.parallelism)`, i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
 * `selector` - (Optional) A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
 * `template` - (Optional) Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
+* `ttl_seconds_after_finished` - (Optional) ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes.
 
 ### `selector`