Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

helm: support initContainers #3838

Merged
merged 4 commits into from
Aug 10, 2023
Merged

Conversation

calvinbui
Copy link
Contributor

Description

Support initContainers on Helm chart

Fixes #3830

Checklist

  • Unit tests updated
  • End user documentation updated

Signed-off-by: Calvin Bui <3604363+calvinbui@users.noreply.github.com>
@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Aug 2, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @calvinbui!

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 k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 2, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @calvinbui. 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.

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Aug 2, 2023
Signed-off-by: Calvin Bui <3604363+calvinbui@users.noreply.github.com>
@calvinbui calvinbui marked this pull request as ready for review August 2, 2023 01:15
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 2, 2023
Copy link
Contributor

@mloiseleur mloiseleur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this PR.
At first, I was thinking about asking to add tests but ... there is no tests in external-dns chart FTM.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 2, 2023
@stevehipwell
Copy link
Contributor

@calvinbui thanks for the PR, could you update the README to add the new initContainers value? Also have you tested this locally?

Signed-off-by: Calvin Bui <3604363+calvinbui@users.noreply.github.com>
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 2, 2023
@calvinbui
Copy link
Contributor Author

@calvinbui thanks for the PR, could you update the README to add the new initContainers value? Also have you tested this locally?

Forgot about that! Added.

Yes, I have tested templating with the initContainers value.

@@ -54,6 +54,10 @@ spec:
{{- with .Values.dnsPolicy }}
dnsPolicy: {{ . }}
{{- end }}
{{- with .Values.initContainers }}
initContainers:
{{- toYaml . | nindent 8 }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{- toYaml . | nindent 8 }}
{{- tpl (toYaml .) . | nindent 8 }}

By using tpl, it will allow to use {{ include "external-dns.image" . }} in the values

Copy link
Contributor Author

@calvinbui calvinbui Aug 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i've never seen any templating possible through values?

it doesn't work for me:

initContainers:
  - name: init-jitter
    image: {{ include "external-dns.image" . }}
    command:
      - /bin/sh
      - -c
      - 'FOR=$((RANDOM % 10))s;echo "Sleeping for $FOR";sleep $FOR'
Error: cannot load values.yaml: error converting YAML to JSON: yaml: invalid map key: map[interface {}]interface {}{"include \"external-dns.image\" .":interface {}(nil)}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mloiseleur that would be incorrect, tpl shouldn't be used like this. If you want tpl support you'd need to support init containers as either a string or an array and only template when it's been provided as a string. I'd prefer this to stay as it is.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@calvinbui It has been done on Traefik Helm Chart, see this PR for instance.
@stevehipwell I understand. It's ok for me.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mloiseleur this is a well known anti-pattern that looks like it should work, works in very simple scenarios but fails hard for anything more complex. To prove this attempt to use the selector labels template for traefik affinity match labels and you will see what I mean.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, you're right.

@stevehipwell
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 2, 2023
@mloiseleur
Copy link
Contributor

@calvinbui The CI has been fixed with #3829. If you rebase this PR, CI should be able to pass as expected.

@mloiseleur
Copy link
Contributor

/test pull-external-dns-lint

@stevehipwell
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

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

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 k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 7, 2023
@mloiseleur
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 10, 2023
@k8s-ci-robot k8s-ci-robot merged commit cf1b30f into kubernetes-sigs:master Aug 10, 2023
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Helm Chart: Allow specifying init containers to Deployment spec.
4 participants