Add annotations to Deployment #2477

beastob · 2021-12-15T13:19:15Z

Description
Allow adding annotations to Deployment via Helm values.

This enables using some third-party tools which rely on adding annotations on Deployment, Statefulset, Daemonset. For example, adding annotations to external-secrets Deployment allow stakater-reloader to restart(thus reload configs) deployment upon ConfigMap or Secret modifications.

Example use case
For situations when external-dns reads from config or secret, which in my case it's the Azure configuration Secret. If I wish to restart external-dns deployment upon config change in order for that config change to be applied, I can utilize the ability of stakater-reloader to do it by adding annotations to external-dns' Deployment.

Fixes #ISSUE(none)

Checklist

End user documentation updated

linux-foundation-easycla · 2021-12-15T13:19:17Z

❌ The commit (cfe8c8b) is missing the User's ID, preventing the EasyCLA check. Consult GitHub Help to resolve.For further assistance with EasyCLA, please submit a support request ticket.

k8s-ci-robot · 2021-12-15T13:19:17Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: login-issues@jira.linuxfoundation.org

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. I understand the commands that are listed here.

k8s-ci-robot · 2021-12-15T13:19:22Z

Welcome @beastob!

It looks like this is your first PR to kubernetes-sigs/external-dns 🎉. 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/external-dns 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. 😃

linux-foundation-easycla · 2021-12-15T13:31:36Z

The committers are authorized under a signed CLA.

✅ beastob (9edf404)

beastob · 2021-12-15T13:40:54Z

I signed it

stevehipwell

Thanks for the PR @beastob, you'll need to sign the CLA before this can move forward and I've added some comments on the code.

But before we look too much into the implementation could you add some documentation links to the description showing systems that require deployment level annotations over pod annotations?

stevehipwell · 2021-12-15T13:39:40Z

charts/external-dns/values.yaml

@@ -26,8 +26,12 @@ rbac:
  create: true
  additionalPermissions: {}

+# Annotations to add to the Deployment
+annotations: {}


I think this might be better named as deploymentAnnotations unless you've got a strong idiomatic precedent?

I have added an example use case in my PR description above. And unfortunately, some tools only look for deploymentAnnotations and not PodAnnotations.

@beastob have you looked at adding a kiwigrid/k8s-sidecar? This is how Grafana handles configmap reloads and it seems to be a better architecture with a single responsibility container in a pod rather than a central service? If this worked it'd be easy to add configuration to enable extra containers in the pod and documentation to show how it could be used.

Suppose https://github.com/kiwigrid/k8s-sidecar works in a way that's similar to Spring-boot's ConfigMap/Secret watcher. My answer would be yes and no. It's because watchers like kiwigrid/k8s-sidecar would restart(I supposed?) the application container upon config changes, and if the deployment has replica>1, all pods/containers will all restart at the same time and causes short period of down time. However, for this project's I think adding an extraContainers field is a good idea, for those who would like to add sidecars.

staketer-reloader on the other hand can allow a RollingUpgrade effect to restart all deployment pods. Nevertheless, I believe allowing a common field annotations for Deployment shouldn't be a bad idea?

The preferred use of kiwigrid/k8s-sidecar is to hit a webhook to trigger a config reload but I think it can manually re-start a pod if a webhook isn't available.

Does ExternalDNS support running multiple replicas? I'm pretty sure you should only have a single "active" replica and I don't think having a non-leader replica would add a benefit to the ExternalDNS workflow even if possible? Even then assuming multiple pods, if configuration has changed I doubt you'd want some using old config? Finally I can't see ExternalDNS as a tier 1 service, I can't see any use case where unavailable for a restart cycle is a problem?

Nevertheless, I believe allowing a common field annotations for Deployment shouldn't be a bad idea?

It's not very idiomatic and promotes the tight coupling of controller to pod which should be avoided as much as possible.

Does ExternalDNS support running multiple replicas? I'm pretty sure you should only have a single "active" replica and I don't think having a non-leader replica would add a benefit to the ExternalDNS workflow even if possible? Even then assuming multiple pods, if configuration has changed I doubt you'd want some using old config? Finally I can't see ExternalDNS as a tier 1 service, I can't see any use case where unavailable for a restart cycle is a problem?

I agree that ExternalDNS in particular does not need RollingUpgrade. It's just that using a centralised service like stakater-reloader we don't have to worry if a particular application out of dozens can support hot config reload or not, and we don't need config extra sidecar individually to achieve config reload. Only annotations would be needed.

And in GitOps approach of managing the kubernates cluster, we would want as little manual operations as possible. For example, changing some config in Git and then pushing it. Then the applications should reload the configs without further human interactions.

I can agree to disagree on this approach.

So just the CLA error to fix and then someone can enable the CI to run, the code itself looks good to me.

I do see your concerns, but it's the lesser of two evils in our case. I will try to figure out the CLA problem later, and thanks for the discussion.

stevehipwell · 2021-12-15T13:40:27Z

charts/external-dns/templates/deployment.yaml

@@ -4,6 +4,10 @@ metadata:
  name: {{ include "external-dns.fullname" . }}
  labels:
    {{- include "external-dns.labels" . | nindent 4 }}
+{{- with .Values.annotations }}
+  annotations:
+{{ toYaml . | indent 4 }}


Suggested change

{{ toYaml . | indent 4 }}

{{- toYaml . | nindent 4 }}

This chart favours nindent for this pattern.

Thanks for your suggestions. I have changed to deploymentAnnotations and now using nindent

stevehipwell · 2021-12-15T14:15:58Z

@beastob you need to amend your git commit(s) with the -s flag to get the CLA to pass. I'd suggest squashing your commits into a single commit first.

Signed-off-by: beastob <beastob.mark1@gmail.com>

beastob · 2021-12-15T14:26:12Z

I signed it

beastob · 2021-12-15T14:35:32Z

@beastob you need to amend your git commit(s) with the -s flag to get the CLA to pass. I'd suggest squashing your commits into a single commit first.

Thanks alot for the help. This is my first PR to a linuxfoundation project and needs some getting use to.

beastob · 2021-12-17T15:46:19Z

I signed it

stevehipwell · 2021-12-17T15:54:29Z

@Raffo could you enable the workflows?

rgrebski · 2021-12-28T20:00:01Z

Hi, do you guys have any updates on this PR ? I would appreciate having deployment annotations as well.

njuettner

/lgtm

Raffo · 2022-01-05T09:01:49Z

@stevehipwell we'll leave this to you to /approve if you are fine with the change.

stevehipwell · 2022-01-05T09:21:23Z

/approve

k8s-ci-robot · 2022-01-05T09:21:36Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: beastob, stevehipwell

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:

~~charts/OWNERS~~ [stevehipwell]

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

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Dec 15, 2021

k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Dec 15, 2021

k8s-ci-robot requested review from seanmalloy and stevehipwell December 15, 2021 13:19

beastob force-pushed the working branch from cfe8c8b to 0364b9a Compare December 15, 2021 13:31

stevehipwell suggested changes Dec 15, 2021

View reviewed changes

Add annotations to Deployment

9edf404

Signed-off-by: beastob <beastob.mark1@gmail.com>

beastob force-pushed the working branch from a84852d to 9edf404 Compare December 15, 2021 14:24

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Dec 17, 2021

njuettner reviewed Jan 5, 2022

View reviewed changes

k8s-ci-robot assigned njuettner Jan 5, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 5, 2022

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 5, 2022

k8s-ci-robot merged commit 7109fa8 into kubernetes-sigs:master Jan 5, 2022

stevehipwell mentioned this pull request Feb 3, 2022

Release new chart version #2570

Closed

stevehipwell mentioned this pull request Feb 3, 2022

feat[chart]: Release v1.8.0 #2571

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add annotations to Deployment #2477

Add annotations to Deployment #2477

beastob commented Dec 15, 2021 •

edited

Loading

linux-foundation-easycla bot commented Dec 15, 2021

k8s-ci-robot commented Dec 15, 2021

k8s-ci-robot commented Dec 15, 2021

linux-foundation-easycla bot commented Dec 15, 2021 •

edited

Loading

beastob commented Dec 15, 2021

stevehipwell left a comment

stevehipwell Dec 15, 2021

beastob Dec 15, 2021

stevehipwell Dec 15, 2021

beastob Dec 15, 2021

stevehipwell Dec 15, 2021

beastob Dec 15, 2021

stevehipwell Dec 15, 2021

beastob Dec 15, 2021

stevehipwell Dec 15, 2021

beastob Dec 15, 2021

stevehipwell commented Dec 15, 2021

beastob commented Dec 15, 2021

beastob commented Dec 15, 2021

beastob commented Dec 17, 2021

stevehipwell commented Dec 17, 2021

rgrebski commented Dec 28, 2021 •

edited

Loading

njuettner left a comment

Raffo commented Jan 5, 2022

stevehipwell commented Jan 5, 2022

k8s-ci-robot commented Jan 5, 2022

Add annotations to Deployment #2477

Add annotations to Deployment #2477

Conversation

beastob commented Dec 15, 2021 • edited Loading

linux-foundation-easycla bot commented Dec 15, 2021

k8s-ci-robot commented Dec 15, 2021

k8s-ci-robot commented Dec 15, 2021

linux-foundation-easycla bot commented Dec 15, 2021 • edited Loading

beastob commented Dec 15, 2021

stevehipwell left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stevehipwell commented Dec 15, 2021

beastob commented Dec 15, 2021

beastob commented Dec 15, 2021

beastob commented Dec 17, 2021

stevehipwell commented Dec 17, 2021

rgrebski commented Dec 28, 2021 • edited Loading

njuettner left a comment

Choose a reason for hiding this comment

Raffo commented Jan 5, 2022

stevehipwell commented Jan 5, 2022

k8s-ci-robot commented Jan 5, 2022

beastob commented Dec 15, 2021 •

edited

Loading

linux-foundation-easycla bot commented Dec 15, 2021 •

edited

Loading

rgrebski commented Dec 28, 2021 •

edited

Loading