Merge pull request #14 from weaveworks/ttl-seconds-after-finished

TLseconds after finished.

This adds support for the configuring the Job TTL for bootstrap Jobs.

This allows them to be removed after a user-configurable period.

Author: bigkevmcd

Makefile

@@ -38,8 +38,7 @@ BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:v$(VERSION)
 IMAGE_TAG := $(shell tools/image-tag)
 # Image URL to use all building/pushing image targets
 IMG ?= $(IMAGE_TAG_BASE):$(IMAGE_TAG)
-# Produce CRDs that work back to Kubernetes 1.11 (no version conversion)
-CRD_OPTIONS ?= "crd:trivialVersions=true,preserveUnknownFields=false"
+CRD_OPTIONS ?= "crd"
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
 ENVTEST_K8S_VERSION = 1.21
 
@@ -127,11 +126,11 @@ undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/confi
 
 CONTROLLER_GEN = $(shell pwd)/bin/controller-gen
 controller-gen: ## Download controller-gen locally if necessary.
-	$(call go-get-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen@v0.6.1)
+	$(call go-get-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen@v0.9.2)
 
 KUSTOMIZE = $(shell pwd)/bin/kustomize
 kustomize: ## Download kustomize locally if necessary.
-	$(call go-get-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/v3@v3.8.7)
+	$(call go-get-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/v3@v4.5.7)
 
 ENVTEST = $(shell pwd)/bin/setup-envtest
 envtest: ## Download envtest-setup locally if necessary.
@@ -146,7 +145,7 @@ TMP_DIR=$$(mktemp -d) ;\
 cd $$TMP_DIR ;\
 go mod init tmp ;\
 echo "Downloading $(2)" ;\
-GOBIN=$(PROJECT_DIR)/bin go get $(2) ;\
+GOBIN=$(PROJECT_DIR)/bin go install $(2) ;\
 rm -rf $$TMP_DIR ;\
 }
 endef

api/v1alpha1/clusterbootstrapconfig_types.go

@@ -37,6 +37,17 @@ type JobTemplate struct {
 	//+kubebuilder:validation:Optional
 	//+kubebuilder:default:=6
 	BackoffLimit *int32 `json:"backoffLimit,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.
+	// +optional
+	TTLSecondsAfterFinished *int32 `json:"ttlSecondsAfterFinished,omitempty"`
+
 	// A batch/v1 Job is created with the Spec as the PodSpec.
 	Spec corev1.PodSpec `json:"spec"`
 }

api/v1alpha1/zz_generated.deepcopy.go

@@ -1,4 +1,3 @@
-
 ---
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole

config/crd/bases/capi.weave.works_clusterbootstrapconfigs.yaml

@@ -41,7 +41,8 @@ func jobFromTemplate(cl *gitopsv1alpha1.GitopsCluster, jt capiv1alpha1.JobTempla
 			Template: corev1.PodTemplateSpec{
 				Spec: jt.Spec,
 			},
-			BackoffLimit: jt.BackoffLimit,
+			BackoffLimit:            jt.BackoffLimit,
+			TTLSecondsAfterFinished: jt.TTLSecondsAfterFinished,
 		},
 	}
 }

config/rbac/role.yaml

@@ -120,6 +120,27 @@ func makeTestPodSpecWithVolumes(volumes ...corev1.Volume) corev1.PodSpec {
 	}
 }
 
+func Test_bootstrapClusterWithConfig_sets_job_ttl(t *testing.T) {
+	bc := makeTestClusterBootstrapConfig(func(cfg *capiv1alpha1.ClusterBootstrapConfig) {
+		cfg.Spec.Template.TTLSecondsAfterFinished = ptrutils.Int32Ptr(66)
+	})
+	cl := makeTestCluster()
+	tc := makeTestClient(t)
+
+	if err := bootstrapClusterWithConfig(context.TODO(), logr.Discard(), tc, cl, bc); err != nil {
+		t.Fatal(err)
+	}
+
+	var jobList batchv1.JobList
+	if err := tc.List(context.TODO(), &jobList, client.InNamespace(testNamespace)); err != nil {
+		t.Fatal(err)
+	}
+
+	if ttl := *jobList.Items[0].Spec.TTLSecondsAfterFinished; ttl != 66 {
+		t.Fatalf("got TTLSecondsAfterFinished %v, want %v", ttl, 66)
+	}
+}
+
 func makeTestCluster(opts ...func(*gitopsv1alpha1.GitopsCluster)) *gitopsv1alpha1.GitopsCluster {
 	c := &gitopsv1alpha1.GitopsCluster{
 		ObjectMeta: metav1.ObjectMeta{