feat(chart): allow to run tpl on `ServiceAccount` annotations #4958

fcrespofastly · 2024-12-17T23:06:06Z

Description

The basic use-case is to add dynamic environmental metadata to external-dns KSA so we can take advantage of advanced cloud IAM features such as IRSA or Workload Identity. We already provide the necessary metadata through values so we could DRY those values and render them in values files. For instance:

serviceAccount:
  annotations:
    iam.gke.io/gcp-service-account: "external-dns@{{ .Values.metadata.gcpProject }}.iam.gserviceaccount"

This change doesn't break any previous behavior.

linux-foundation-easycla · 2024-12-17T23:06:11Z

The committers listed above are authorized under a signed CLA.

✅ login: fcrespofastly / name: Fernando Crespo Grávalos (5126e3a, 8114c5c, 6754d80, a336198, 85eaee9, c88c6dc, 0a3cbfd)

k8s-ci-robot · 2024-12-17T23:06:16Z

Welcome @fcrespofastly!

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. 😃

k8s-ci-robot · 2024-12-17T23:06:16Z

Hi @fcrespofastly. 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-sigs/prow repository.

fcrespofastly · 2024-12-18T10:25:20Z

Hey @szuecs @stevehipwell 👋🏻 !

How do you feel about this change? it should be basically noop, can we launch the tests?

fcrespofastly · 2024-12-19T06:17:16Z

I also updated the CHANGELOG adding an entry under UNRELEASED.

@szuecs @stevehipwell ☝🏻 I think that's correct right?

mloiseleur · 2024-12-22T18:30:08Z

/ok-to-test
/lgtm
/retitle feat(chart): allow to run tpl on ServiceAccount annotations

mloiseleur · 2024-12-22T18:30:40Z

/assign @stevehipwell
/unassign @szuecs

ivankatliarchuk · 2024-12-31T10:05:07Z

Is it not safer to create a helper function in _helpers.tpl, and reference it in template?

{{- define "external-dns.serviceAccountAnnotations" -}}
...

Then for example if someone deploy external-dns with umbrella chart can override behaviour in local _helpers.tpl?

Example

apiVersion: v2
name: external-dns-umbrella
dependencies:
- name: external-dns
  version: 1.15.0
  repository: https://kubernetes-sigs.github.io/external-dns/

and in my local _helper.tpl

{{- define "external-dns.serviceAccountAnnotations" -}}
.. behaviour override

fcrespofastly · 2025-01-07T06:47:25Z

Hey @ivankatliarchuk 👋🏻 !

Thanks for suggesting this, that's an interesting approach as well! I don't mind iterating on this towards your suggested approach, but I want to make sure we're all on the same page:

By running tpl() we're not changing the behaviour, right? We're just allowing to treat a string as a template. Is there any use case where this change breaks template rendering that I'm missing?
If we do this with service account annotations, then should we do it with podAnnotations too just to be consistent? If the answer is yes, then the scope of this PR will be bigger I guess.
What would be the default template when the local helper is not defined?

@stevehipwell thoughts?

Thanks folks!

stevehipwell

Thanks for the PR @fcrespofastly but the implementation isn't correct due to the way helm works with YAML blobs. This can be solved with a loop as the annotations are a fixed simple type.

Please could you also update the comment in values.yaml so the ability to template is added to the docs (you need to run helm-docs after making this change to update README.md).

stevehipwell · 2025-01-07T09:42:37Z

charts/external-dns/templates/serviceaccount.yaml

@@ -11,7 +11,7 @@ metadata:
  {{- end }}
  {{- with .Values.serviceAccount.annotations }}
  annotations:
-    {{- toYaml . | nindent 4 }}
+    {{- tpl (toYaml .) $ | nindent 4 }}


Suggested change

{{- tpl (toYaml .) $ | nindent 4 }}

{{- range $k, $v := . }}

{{- printf "%s: %s" (tpl $k $) (tpl $v $) }}

{{- end }}

stevehipwell · 2025-01-07T09:46:26Z

charts/external-dns/CHANGELOG.md

@@ -27,6 +27,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

 - Fixed automatic addition of pod selector labels to `affinity` and `topologySpreadConstraints` if not defined. _@pvickery-ParamountCommerce_

+### Changed
+
+- Allow templatizing `serviceaccount.annotations` in values, by rendering them using `tpl` built-in function: [#4958](https://github.com/kubernetes-sigs/external-dns/pull/4958) @fcrespofastly


Suggested change

- Allow templatizing `serviceaccount.annotations` in values, by rendering them using `tpl` built-in function: [#4958](https://github.com/kubernetes-sigs/external-dns/pull/4958) @fcrespofastly

- Allow templating `serviceaccount.annotations` keys and values, by rendering them using the `tpl` built-in function. ([#4958](https://github.com/kubernetes-sigs/external-dns/pull/4958)) _@fcrespofastly_

fcrespofastly · 2025-01-07T10:46:22Z

@stevehipwell thanks for the feedback!! I implemented the suggested changes, plus a minor nit (nindent).

Out of curiosity now, why the initial implementation doesn't work exactly? You mentioned due to the way Helm handles YAML blobs but I was wondering if you could provide with an example (again, just curiosity)

Thanks again!

stevehipwell · 2025-01-07T10:53:55Z

charts/external-dns/values.yaml

+  # -- Annotations to add to the service account. Templates are allowed here. Example:
+  # annotations:
+  #   example.com/annotation: {{ .Values.nameOverride }}


Suggested change

# -- Annotations to add to the service account. Templates are allowed here. Example:

# annotations:

# example.com/annotation: {{ .Values.nameOverride }}

# -- Annotations to add to the service account. Templates are allowed in both the key and value; for example `example.com/annotation/{{ .Values.nameOverride }}: {{ .Values.nameOverride }}`.

Helm docs doesn't support multi-line strings.

Done! thanks!

stevehipwell

Thanks @fcrespofastly. Could you add a templated annotation to the charts/external-dns/ci/ci-values.yaml file so this pattern is validated?

fcrespofastly · 2025-01-07T14:44:14Z

@stevehipwell done! 🚀

stevehipwell · 2025-01-07T18:04:44Z

/label tide/merge-method-squash
/lgtm
/approve

k8s-ci-robot · 2025-01-07T18:04:52Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 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

…etes-sigs#4958) * Allow run tpl on serviceaccount annotations * updated the CHANGELOG * iterate over kv and tpl and update docs * fix multiline-string docs * add CI values * add more CI values * fix ci values

Allow run tpl on serviceaccount annotations

0a3cbfd

k8s-ci-robot requested review from stevehipwell and szuecs December 17, 2024 23:06

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

updated the CHANGELOG

8114c5c

k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Dec 22, 2024

k8s-ci-robot changed the title ~~Allow run tpl on serviceaccount annotations~~ feat(chart): allow to run tpl on ServiceAccount annotations Dec 22, 2024

k8s-ci-robot removed the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Dec 22, 2024

k8s-ci-robot assigned mloiseleur Dec 22, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 22, 2024

k8s-ci-robot assigned stevehipwell Dec 22, 2024

mloiseleur removed their assignment Dec 22, 2024

stevehipwell suggested changes Jan 7, 2025

View reviewed changes

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 7, 2025

stevehipwell mentioned this pull request Jan 7, 2025

Update Helm chart to v0.15.1 #4967

Open

iterate over kv and tpl and update docs

5126e3a

k8s-ci-robot removed the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jan 7, 2025

k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jan 7, 2025

stevehipwell suggested changes Jan 7, 2025

View reviewed changes

fix multiline-string docs

a336198

fcrespofastly requested a review from stevehipwell January 7, 2025 12:01

stevehipwell suggested changes Jan 7, 2025

View reviewed changes

add CI values

6754d80

add more CI values

c88c6dc

fcrespofastly requested a review from stevehipwell January 7, 2025 15:02

fcrespofastly mentioned this pull request Jan 7, 2025

allow render templates on serviceaccount annotations values cert-manager/cert-manager#7501

Open

fix ci values

85eaee9

k8s-ci-robot added tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Jan 7, 2025

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

k8s-ci-robot merged commit f8057a7 into kubernetes-sigs:master Jan 7, 2025
15 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(chart): allow to run tpl on `ServiceAccount` annotations #4958

feat(chart): allow to run tpl on `ServiceAccount` annotations #4958

fcrespofastly commented Dec 17, 2024 •

edited

Loading

linux-foundation-easycla bot commented Dec 17, 2024 •

edited

Loading

k8s-ci-robot commented Dec 17, 2024

k8s-ci-robot commented Dec 17, 2024

fcrespofastly commented Dec 18, 2024

fcrespofastly commented Dec 19, 2024

mloiseleur commented Dec 22, 2024

mloiseleur commented Dec 22, 2024

ivankatliarchuk commented Dec 31, 2024

fcrespofastly commented Jan 7, 2025 •

edited

Loading

stevehipwell left a comment

stevehipwell Jan 7, 2025

stevehipwell Jan 7, 2025

fcrespofastly commented Jan 7, 2025

stevehipwell Jan 7, 2025

fcrespofastly Jan 7, 2025

stevehipwell left a comment

fcrespofastly commented Jan 7, 2025

stevehipwell commented Jan 7, 2025

k8s-ci-robot commented Jan 7, 2025

	- Allow templatizing `serviceaccount.annotations` in values, by rendering them using `tpl` built-in function: [#4958](https://github.com/kubernetes-sigs/external-dns/pull/4958) @fcrespofastly
	- Allow templating `serviceaccount.annotations` keys and values, by rendering them using the `tpl` built-in function. ([#4958](https://github.com/kubernetes-sigs/external-dns/pull/4958)) _@fcrespofastly_

feat(chart): allow to run tpl on ServiceAccount annotations #4958

feat(chart): allow to run tpl on ServiceAccount annotations #4958

Conversation

fcrespofastly commented Dec 17, 2024 • edited Loading

linux-foundation-easycla bot commented Dec 17, 2024 • edited Loading

k8s-ci-robot commented Dec 17, 2024

k8s-ci-robot commented Dec 17, 2024

fcrespofastly commented Dec 18, 2024

fcrespofastly commented Dec 19, 2024

mloiseleur commented Dec 22, 2024

mloiseleur commented Dec 22, 2024

ivankatliarchuk commented Dec 31, 2024

fcrespofastly commented Jan 7, 2025 • edited Loading

stevehipwell left a comment

Choose a reason for hiding this comment

stevehipwell Jan 7, 2025

Choose a reason for hiding this comment

stevehipwell Jan 7, 2025

Choose a reason for hiding this comment

fcrespofastly commented Jan 7, 2025

stevehipwell Jan 7, 2025

Choose a reason for hiding this comment

fcrespofastly Jan 7, 2025

Choose a reason for hiding this comment

stevehipwell left a comment

Choose a reason for hiding this comment

fcrespofastly commented Jan 7, 2025

stevehipwell commented Jan 7, 2025

k8s-ci-robot commented Jan 7, 2025

feat(chart): allow to run tpl on `ServiceAccount` annotations #4958

feat(chart): allow to run tpl on `ServiceAccount` annotations #4958

fcrespofastly commented Dec 17, 2024 •

edited

Loading

linux-foundation-easycla bot commented Dec 17, 2024 •

edited

Loading

fcrespofastly commented Jan 7, 2025 •

edited

Loading