Chart: Make controller.config templatable.

[TheRealNoob]

What this PR does / why we need it:

Allows templating of controller.config

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• CVE Report (Scanner found CVE and adding report)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation only

Which issue/s this PR fixes

How Has This Been Tested?

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I've read the CONTRIBUTION guide
• I have added unit and/or e2e tests to cover my changes.
• All new and existing tests passed.

[k8s-ci-robot]

Welcome @TheRealNoob!

It looks like this is your first PR to kubernetes/ingress-nginx 🎉. 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/ingress-nginx 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 @TheRealNoob. Thanks for your PR.

I'm waiting for a kubernetes 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-ingress-nginx canceled.

Name	Link
🔨 Latest commit	3d30894
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-ingress-nginx/deploys/660ae6dda42d6c0008b2789d

[longwuyuan]

@TheRealNoob , any chance you can create a issue first and describe the current problem with the chart ?

• Improvements are always welcome but there is ambiguity here as to what problem is currently faced by users
• Please link the issue you create to this PR
• I request that you kindly post the complete detailed deug info like
  • your kind cluster where you test this details of creation and config
  • your complete and exact install prcess along with the values file and the resulting resources created like the configMap shown as outputs of commands like kubectl describe
  • How you used the templated config to host your app in K8S showing how it was not possible before this change

[TheRealNoob]

I can create an issue describing the value add of this PR. As for the testing I added a unittest for it. To be honest I felt it was a little unnecessary as it's a simple tpl, but I could go either way. Do you still want me to detail how I did my testing locally?

[longwuyuan]

@TheRealNoob thank you for the contribution, really helps

For a normal user reader, the difference between a template for the config and a manually contructed typed content in the values file (indents and all etc), is elaborate with a issue describing what is not possible without a template or what becomes better with a template.

We may have to add explaining/docs text the values file for improved experience. So I asked. Please dont feel I insisted.

Also wait for other comments as others may also opine that this is enough to move forward.

Thank you

[Gacko]

/retitle Chart: Make controller.config templatable.
/hold

[Gacko]

/kind feature
/priority backlog

[Gacko]

Added some suggestions. In general I'm not sure if this changes brings more risks than it improves the way users can customize Ingress NGINX to their needs.

You in your case seem to request this change because you're deploying Ingress NGINX in many different namespaces, maybe even as a sub chart.

We should take care not to implement logic that should be handled by users' CI instead, especially if it could weaken type safety like this proposal.

[TheRealNoob]

@Gacko

Added some suggestions. In general I'm not sure if this changes brings more risks than it improves the way users can customize Ingress NGINX to their needs.

I considered that this might be interpreted as a security risk but dismissed it after realizing that this would only be possible if someone added something to the values file and re-deployed. The act of deploying would require the same level of permissions as editing the object directly, so it's not a security risk from a nefarious actor point of view. The only thing that leaves is the possibility that an administrator intends to deploy one thing, but mistakenly deploys another enabled by this change. Ultimately I concluded that it's a low risk that they'd use double brackets without knowing their special meaning in Helm.

We should take care not to implement logic that should be handled by users' CI instead

Sorry I don't quote follow your train of thought here, perhaps you could elaborate?

especially if it could weaken type safety like this proposal.

I also considered this but also dismissed this concern since it's already going through the quote function. I went through several iterations of this response adding additional light and elaborating on edge cases, also considering removing the quote function as it causes issues in some cases whereas toString does not, but figured others here would prefer keeping it for the users that define unquoted lines with spaces.

[Gacko]

The risks I am talking of are mainly about maintaining the chart and supporting users. Some changes might make that harder as they are making the behavior of the chart unpredictable while users are still expecting us to support them in case they are having issues with using what we deliver.

So in the end we always consider if a change is really required by more than just one user and still easy to understand and maintain in the future.

[Gacko]

Anyways, I'll give that PR another look by tomorrow (hopefully) and LGTM it asap.

[Gacko]

/label tide/merge-method-squash

[Gacko]

/assign

[Gacko]

/ok-to-test
/triage accepted
/unhold
/lgtm

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Gacko, TheRealNoob

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/ingress-nginx/OWNERS [Gacko]

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