Skip to content

feat(chart): optional sidecar on webhook #5586

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

aceeric
Copy link

@aceeric aceeric commented Jun 29, 2025

What does it do ?

It's possible to run the webhook outside the cluster. See #5585.

Motivation

In my particular environment, I run the webhook outside the cluster and so the webhook sidecar is un-needed.

More

  • Yes, this PR title follows Conventional Commits
  • Yes, I added unit tests
  • Yes, I updated end user documentation accordingly

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign stevehipwell for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

Copy link

linux-foundation-easycla bot commented Jun 29, 2025

CLA Signed


The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jun 29, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @aceeric!

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
Copy link
Contributor

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

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. 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 Jun 29, 2025
@szuecs
Copy link
Contributor

szuecs commented Jun 29, 2025

/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 Jun 29, 2025
@mloiseleur
Copy link
Collaborator

At first glance, I do not see the interest to add an option for only one person in the world. But maybe I missed something.
I'm putting this PR on hold, waiting for the discussion on linked issue
/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 29, 2025
@stevehipwell
Copy link
Contributor

FYI this was discussed when the chart was first updated to support the sidecar and it was decided to to support this. I'll second the request to open an issue if you want to discuss this, for architectural changes we much prefer an issue over a PR for this. @mloiseleur correct me if I'm wrong but I think ExternalDNS does support this if you provide your own manifests?

@Raffo
Copy link
Contributor

Raffo commented Jun 30, 2025

I have no strong preferences here, will completely defer the decision on if we want to support his in helm.

@stevehipwell
Copy link
Contributor

@mloiseleur what do you think?

@mloiseleur
Copy link
Collaborator

@stevehipwell This is a valid and interesting use case. It seems there are now two known users with this needs.

/hold cancel
/retitle feat(chart): optional sidecar on webhook

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 14, 2025
@k8s-ci-robot k8s-ci-robot changed the title Allow the webhook sidecar to be optional in case the webhook is outside the cluster feat(chart): optional sidecar on webhook Jul 14, 2025
Copy link
Contributor

@stevehipwell stevehipwell left a comment

Choose a reason for hiding this comment

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

I'm not sure that provider.webhook.sidecar as a boolean is the best API design for this. Personally I think we should redesign the webhook API to look more like the following with the sidecar values moved under sidecar (and the old values deprecated).

provider:
  name:
  webhook:
    readTimeout:
    writeTimeout:
    url:
    sidecar:
      image:
        repository:
        tag:
        pullPolicy:

When in webhook mode, if the provider.webhook.url value is set then the --webhook-provider-url flag can be overridden otherwise the current sidecar logic can be applied.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chart cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. 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.

6 participants