add: custom annotations on service and deployment

[tozastation]

What type of PR is this?

/kind feature

What this PR does / why we need it:

I have changed to be able to set Custom Annotations on Service resources and Deployment's Pod resources via Helm Chart.

Which issue(s) this PR fixes:

Fixes #1619

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Helm: Allow configuration of custom annotations on Service and Deployment's Pod

[k8s-ci-robot]

Welcome @tozastation!

It looks like this is your first PR to kubernetes-sigs/kueue 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kueue has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @tozastation. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[netlify]

✅ Deploy Preview for kubernetes-sigs-kueue ready!

Name	Link
🔨 Latest commit	cdaebed
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/662665708800ae0008b60690
😎 Deploy Preview	https://deploy-preview-2030--kubernetes-sigs-kueue.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[tenzen-y]

/ok-to-test

[tozastation]

/assign @denkensk
/assign @trasc

[trasc]

Overall LGTM.

@tozastation do you have a specific use-case for this? Maybe we can document it.

[tozastation]

@trasc
thanks for reviewing!

In Prometheus, we can use Relabel Config to define the scraping target without using the Service Monitor (Prometheus Operator CRD).
For this configuration, we can use the metadata.annotations of the Service or Pod.

The following annotations are available by default in Prometheus' Helm Chart.
https://github.com/prometheus-community/helm-charts/blob/main/charts/prometheus/values.yaml#L918

prometheus.io/path: /metrics
prometheus.io/port: '8080'
prometheus.io/scrape: 'true'
etc...

---

Implementing this with the proposed changes will result in the following

example (values.yaml): Pod Annotations

controllerManager:
  manager:
    podAnnotations:
      prometheus.io/path: /metrics
      prometheus.io/port: '8080'
      prometheus.io/scrape: 'true'

example (values.yaml): Service Annotations

metricsService:
  annotations:
    prometheus.io/path: /metrics
    prometheus.io/port: '8443'
    prometheus.io/scrape: 'true'
    prometheus.io/scheme: https

※ Service Scaraping requires the following additions to the Prometheus configuration.
Follows the Service Monitor configuration: https://github.com/kubernetes-sigs/kueue/blob/main/charts/kueue/templates/prometheus/monitor.yaml

scrape_configs:
  - tls_config:
        insecure_skip_verify: true
    authorization:
        credentials_file: /var/run/secrets/kubernetes.io/serviceaccount/token

[trasc]

Thanks,

/lgtm

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: c660d9fe8776db46159f37c7a89ce2b89ee8d47e

[tozastation]

/assign @tenzen-y

[tenzen-y]

I'm wondering if we need to update https://github.com/kubernetes-sigs/kueue/blob/a0290b3f67770b34b6169bcd10e74e07ad831945/hack/update-helm.sh as well.

@tozastation What happens if you perform make update-helm?

[tozastation]

@tenzen-y

thanks

The following is the result of the execution.
I checked that there are no git diffs or newly generated files.

❯ make update-helm
/Users/tozastation/ghq/github.com/tozastation/kueue/bin/controller-gen \
                crd:generateEmbeddedObjectMeta=true output:crd:artifacts:config=config/components/crd/bases\
                paths="./apis/..."
/Users/tozastation/ghq/github.com/tozastation/kueue/bin/controller-gen \
                rbac:roleName=manager-role output:rbac:artifacts:config=config/components/rbac\
                webhook output:webhook:artifacts:config=config/components/webhook\
                paths="./pkg/controller/...;./pkg/webhooks/...;./pkg/util/cert/...;./pkg/visibility/..."
go: downloading github.com/mikefarah/yq/v4 v4.34.1
go: downloading gopkg.in/op/go-logging.v1 v1.0.0-20160211212156-b2cb9fa56473
go: downloading github.com/elliotchance/orderedmap v1.5.0
go: downloading github.com/a8m/envsubst v1.4.2
go: downloading github.com/alecthomas/participle/v2 v2.0.0
go: downloading github.com/goccy/go-yaml v1.11.0
go: downloading github.com/pelletier/go-toml/v2 v2.0.7
SED=/opt/homebrew/opt/gnu-sed/libexec/gnubin/sed ./hack/update-helm.sh

[tenzen-y]

@tenzen-y

thanks

The following is the result of the execution.

I checked that there are no git diffs or newly generated files.

❯ make update-helm

/Users/tozastation/ghq/github.com/tozastation/kueue/bin/controller-gen \

                crd:generateEmbeddedObjectMeta=true output:crd:artifacts:config=config/components/crd/bases\

                paths="./apis/..."

/Users/tozastation/ghq/github.com/tozastation/kueue/bin/controller-gen \

                rbac:roleName=manager-role output:rbac:artifacts:config=config/components/rbac\

                webhook output:webhook:artifacts:config=config/components/webhook\

                paths="./pkg/controller/...;./pkg/webhooks/...;./pkg/util/cert/...;./pkg/visibility/..."

go: downloading github.com/mikefarah/yq/v4 v4.34.1

go: downloading gopkg.in/op/go-logging.v1 v1.0.0-20160211212156-b2cb9fa56473

go: downloading github.com/elliotchance/orderedmap v1.5.0

go: downloading github.com/a8m/envsubst v1.4.2

go: downloading github.com/alecthomas/participle/v2 v2.0.0

go: downloading github.com/goccy/go-yaml v1.11.0

go: downloading github.com/pelletier/go-toml/v2 v2.0.7

SED=/opt/homebrew/opt/gnu-sed/libexec/gnubin/sed ./hack/update-helm.sh

Oh, I see. Thank you for checking!
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tenzen-y, tozastation

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [tenzen-y]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[alculquicondor]

/release-note-edit

Helm: Allow configuration of custom annotations on Service and Deployment's Pod