Merge pull request #8 from zswanson/specify-labels-migrations-pod

allow optional labels on generated Job template

Author: coderanger

README.md

@@ -43,6 +43,7 @@ with these fields:
 - args: optional string array to be used as the upgrade Job's `args`.
 - 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, 
 
 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

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

api/v1beta1/zz_generated.deepcopy.go

@@ -194,6 +194,14 @@ func (comp *migrationsComponent) Reconcile(ctx *cu.Context) (cu.Result, error) {
 	}
 	migrationPodSpec.InitContainers = initContainers
 
+	// add labels to the job's pod template
+	jobTemplateLabels := map[string]string{"migrations": obj.Name}
+	if obj.Spec.Labels != nil {
+		for k, v := range obj.Spec.Labels {
+			jobTemplateLabels[k] = v
+		}
+	}
+
 	migrationJob := &batchv1.Job{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:        obj.Name + "-migrations",
@@ -204,7 +212,7 @@ func (comp *migrationsComponent) Reconcile(ctx *cu.Context) (cu.Result, error) {
 		Spec: batchv1.JobSpec{
 			Template: corev1.PodTemplateSpec{
 				ObjectMeta: metav1.ObjectMeta{
-					Labels:      map[string]string{"migrations": obj.Name},
+					Labels:      jobTemplateLabels,
 					Annotations: map[string]string{webhook.NOWAIT_MIGRATOR_ANNOTATION: "true"},
 				},
 				Spec: *migrationPodSpec,
@@ -220,7 +228,7 @@ func (comp *migrationsComponent) Reconcile(ctx *cu.Context) (cu.Result, error) {
 	uncachedObj := &migrationsv1beta1.Migrator{}
 	err = ctx.UncachedClient.Get(ctx, types.NamespacedName{Name: obj.Name, Namespace: obj.Namespace}, uncachedObj)
 	if err != nil {
-		return cu.Result{}, errors.Wrap(err, "erro getting latest migrator for status")
+		return cu.Result{}, errors.Wrap(err, "error getting latest migrator for status")
 	}
 	if uncachedObj.Status.LastSuccessfulMigration == migrationContainer.Image {
 		ctx.Conditions.SetfTrue(comp.GetReadyCondition(), "MigrationsUpToDate", "Migration %s already run", migrationContainer.Image)

components/migrations.go

@@ -249,4 +249,13 @@ var _ = Describe("Migrations component", func() {
 		helper.TestClient.GetName("testing-migrations", job)
 		Expect(job.Spec.Template.Spec.Containers[0].Image).To(Equal("myapp:v1"))
 	})
+
+	It("applies specified labels to the migration pod", func() {
+		obj.Spec.Labels = map[string]string{"key1": "value1"}
+		helper.TestClient.Create(pod)
+		helper.MustReconcile()
+		helper.TestClient.GetName("testing-migrations", job)
+		Expect(job.Spec.Template.ObjectMeta.Labels).To(HaveKeyWithValue("key1", "value1"))
+		Expect(job.Spec.Template.ObjectMeta.Labels).To(HaveKeyWithValue("migrations", "testing"))
+	})
 })

components/migrations_test.go

@@ -48,6 +48,10 @@ spec:
                 type: string
               image:
                 type: string
+              labels:
+                additionalProperties:
+                  type: string
+                type: object
               selector:
                 description: A label selector is a label query over a set of resources.
                   The result of matchLabels and matchExpressions are ANDed. An empty

config/crd/bases/migrations.coderanger.net_migrators.yaml

@@ -9,18 +9,18 @@ rules:
 - apiGroups:
   - ""
   resources:
-  - pods
+  - events
   verbs:
-  - get
-  - list
-  - watch
+  - create
+  - patch
 - apiGroups:
   - ""
   resources:
-  - events
+  - pods
   verbs:
-  - create
-  - patch
+  - get
+  - list
+  - watch
 - apiGroups:
   - apps
   resources: