Support Custom labels and annotations to be added to Pod template of a Gatling runner job

[S-mishina]

Description

Support Custom labels and annotations to be added to Pod template of a Gatling runner job

Relevant Issue: https://github.com/st-tech/gatling-operator/issues/62

What's been changed / added?

• get ObjectMeta

  • https://github.com/st-tech/gatling-operator/blob/af23dc14ce75c00183b0adbc041b4bed0032f30e/controllers/gatling_controller.go#L941-L947

• Add type to Gatling Job Pod label (Runner or Reporter)

  • https://github.com/st-tech/gatling-operator/blob/35a33df51d841354089b90dafd62aa7dd549a8fe/pkg/utils/utils.go#L27-L38

• Labels and annotations set for gatling job runer pods

  • https://github.com/st-tech/gatling-operator/blob/35a33df51d841354089b90dafd62aa7dd549a8fe/controllers/gatling_controller.go#L460-L465
  • https://github.com/st-tech/gatling-operator/blob/35a33df51d841354089b90dafd62aa7dd549a8fe/controllers/gatling_controller.go#L526-L531

• Labels and annotations set for gatling job reporter pods

  • https://github.com/st-tech/gatling-operator/blob/35a33df51d841354089b90dafd62aa7dd549a8fe/controllers/gatling_controller.go#L600-L605

How to add label and annotation to a Gatling runner job

To add labels or annotations to the Gatling runner job, put them under metadata.

apiVersion: gatling-operator.tech.zozo.com/v1alpha1
kind: Gatling
metadata:
  name: gatling-sample01
  labels:
    app: my-sample-app
  annotations:
    gatling-operator.tech.zozo.com/hello: "true"

Testing

We checked the operation with and without label and annotation respectively.

• runner pods

  • when adding a label and annotation

    ➜ kubectl describe pods gatling-sample01-runner-5mt4k
    Name:         gatling-sample01-runner-5mt4k 
    Namespace:    default
    Priority:     0
    Node:         gatling-cluster-worker/172.18.0.2
    Start Time:   Wed, 02 Nov 2022 11:29:49 +0900
    Labels:       controller-uid=ded0c1ac-3ae2-4526-af9c-8182210feeb0
                  gatling-waiter=initialized
                  job-name=gatling-sample01-runner
                  app=my-sample-app
                  type=runner
    Annotations:  gatling-operator.tech.zozo.com/hello: true

  • when not adding a label and annotation

    ➜ kubectl describe pods gatling-sample01-runner-5hcz2
    Name:         gatling-sample01-runner-5hcz2
    Namespace:    default
    Priority:     0
    Node:         gatling-cluster-worker/172.18.0.2
    Start Time:   Wed, 02 Nov 2022 11:45:05 +0900
    Labels:       controller-uid=a8786766-aa2f-4dc9-9e89-20d70429a816
                   gatling-waiter=initialized
                   job-name=gatling-sample01-runner
                   type=runner

• reporter pods

  • when adding a label and annotation

    ➜ kubectl describe pods gatling-sample01-reporter-p5w29
    Name:         gatling-sample01-reporter-p5w29
    Namespace:    default
    Priority:     0
    Node:         gatling-cluster-worker/172.18.0.2
    Start Time:   Wed, 02 Nov 2022 12:30:59 +0900
    Labels:       app=my-sample-app
                  controller-uid=5ddcbc7c-f6e8-4f02-830f-3ca080411a24
                  job-name=gatling-sample01-reporter
                  type=reporter

  • when not adding a label and annotation

    ➜ kubectl describe pods gatling-sample01-reporter-szdng
    Name:         gatling-sample01-reporter-szdng
    Namespace:    default
    Priority:     0
    Node:         gatling-cluster-worker/172.18.0.2
    Start Time:   Wed, 02 Nov 2022 12:27:12 +0900
    Labels:       controller-uid=395508b2-13b9-4121-ab83-31a393f7adfb
                   job-name=gatling-sample01-reporter
                   type=reporter

Checklist

Please check if applicable

• [x] Tests have been added (if applicable, ie. when operator codes are added or modified)
• [x] Relevant docs have been added or modified (if applicable, ie. when new features are added or current features are modified)

Relevant issue https://github.com/st-tech/gatling-operator/issues/62

[yokawasa]

Adding @akitok @ksudate to reviewers

[yokawasa]

Add @ikuwow for reviewers