Merge pull request #18 from DWSR/add-pod-annotations

feat: add pod annotations

Author: coderanger

README.md

@@ -44,6 +44,7 @@ with these fields:
 - image: optional image to use for the upgrade Job.
 - container: optional name of a container from the selected template Pod. The selected container will be used to run the upgrader.
 - labels: optional map of labels to set on the Job's pod template, 
+- annotations: optional map of annotations to set on the Job's pod template,
 
 The migrator Job will contain only the single template container, initContainers will be included but sidecars will not. Any livenessProbes and readinessProbes in the template will be ignored.
 

api/v1beta1/migrator_types.go

@@ -30,6 +30,7 @@ type MigratorSpec struct {
 	Args             *[]string             `json:"args,omitempty"`
 	Container        string                `json:"container,omitempty"`
 	Labels           map[string]string     `json:"labels,omitempty"`
+	Annotations      map[string]string     `json:"annotations,omitempty"`
 }
 
 // MigratorStatus defines the observed state of Migrator

api/v1beta1/zz_generated.deepcopy.go

@@ -204,6 +204,16 @@ func (comp *migrationsComponent) Reconcile(ctx *cu.Context) (cu.Result, error) {
 		}
 	}
 
+	// add annotations to the job's pod template
+	jobTemplateAnnotations := map[string]string{
+		webhook.NOWAIT_MIGRATOR_ANNOTATION: "true",
+	}
+	if obj.Spec.Annotations != nil {
+		for k, v := range obj.Spec.Annotations {
+			jobTemplateAnnotations[k] = v
+		}
+	}
+
 	migrationJob := &batchv1.Job{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:        obj.Name + "-migrations",
@@ -215,7 +225,7 @@ func (comp *migrationsComponent) Reconcile(ctx *cu.Context) (cu.Result, error) {
 			Template: corev1.PodTemplateSpec{
 				ObjectMeta: metav1.ObjectMeta{
 					Labels:      jobTemplateLabels,
-					Annotations: map[string]string{webhook.NOWAIT_MIGRATOR_ANNOTATION: "true"},
+					Annotations: jobTemplateAnnotations,
 				},
 				Spec: *migrationPodSpec,
 			},

components/migrations.go

@@ -32,6 +32,7 @@ import (
 
 	migrationsv1beta1 "github.com/coderanger/migrations-operator/api/v1beta1"
 	argoprojstubsv1alpha1 "github.com/coderanger/migrations-operator/stubs/argoproj/v1alpha1"
+	"github.com/coderanger/migrations-operator/webhook"
 )
 
 var _ = Describe("Migrations component", func() {
@@ -260,6 +261,21 @@ var _ = Describe("Migrations component", func() {
 		Expect(job.Spec.Template.ObjectMeta.Labels).To(HaveKeyWithValue("migrations", "testing"))
 	})
 
+	It("applies nowait annotation to the migration pod", func() {
+		helper.TestClient.Create(pod)
+		helper.MustReconcile()
+		helper.TestClient.GetName("testing-migrations", job)
+		Expect(job.Spec.Template.ObjectMeta.Annotations).To(HaveKeyWithValue(webhook.NOWAIT_MIGRATOR_ANNOTATION, "true"))
+	})
+
+	It("applies specified annotations to the migration pod", func() {
+		obj.Spec.Annotations = map[string]string{"key2": "value2"}
+		helper.TestClient.Create(pod)
+		helper.MustReconcile()
+		helper.TestClient.GetName("testing-migrations", job)
+		Expect(job.Spec.Template.ObjectMeta.Annotations).To(HaveKeyWithValue("key2", "value2"))
+	})
+
 	It("follows owner references for an argoproj.io rollout", func() {
 		truep := true
 		rollout := &argoprojstubsv1alpha1.Rollout{

components/migrations_test.go

@@ -36,6 +36,10 @@ spec:
           spec:
             description: MigratorSpec defines the desired state of Migrator
             properties:
+              annotations:
+                additionalProperties:
+                  type: string
+                type: object
               args:
                 items:
                   type: string