ingress-nginx
ingress-nginx copied to clipboard
fix(docs - Multiple Ingress controllers): HELM needs ingressClass
What this PR does / why we need it:
For correct handling, ingressClass needs to be mentioned as well. Because https://github.com/kubernetes/ingress-nginx/blob/5784be2784210534c460e8118bde47ec8b865ed0/charts/ingress-nginx/templates/_params.tpl#L19 is set based on .Values.controller.ingressClass, not based on .Values.controller.ingressClassResource.name
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)
- [x] Documentation only
Which issue/s this PR fixes
Not mentioned in any issue
How Has This Been Tested?
Only documentation
Checklist:
- [x] My change requires a change to the documentation.
- [x] I have updated the documentation accordingly.
- [x] I've read the CONTRIBUTION guide
- [ ] I have added unit and/or e2e tests to cover my changes.
- [x] All new and existing tests passed.
Welcome @kiblik!
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. :smiley:
Hi @kiblik. 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-sigs/prow repository.
Deploy Preview for kubernetes-ingress-nginx ready!
| Name | Link |
|---|---|
| Latest commit | 62504795b00e9f36d5913240d0ed0b8a096b24da |
| Latest deploy log | https://app.netlify.com/sites/kubernetes-ingress-nginx/deploys/6675a41c685e6a000877a969 |
| Deploy Preview | https://deploy-preview-11493--kubernetes-ingress-nginx.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
@kiblik thanks for your contribution.
The md file you are changing, actually needs many more fixes.
Please look at this https://kubernetes.github.io/ingress-nginx/faq/#how-can-i-easily-install-multiple-instances-of-the-ingress-nginx-controller-in-the-same-cluster
Is it possible for you to fix your MD file as per the info in this FAQ section link
Thanks
Also please take care that this argument is for the old way of assigning Ingress resources via an annotation and not via the IngressClass resource. Not sure if we should still support it and tell users to configure it as this might lead to the assumption that this way is still fully supported and ok.
@longwuyuan pinged me and we had a quick talk about my comment. Could you please add a small note about this flag / the annotation way of assigning Ingresses is still supported but not the preferred way? That would be awesome!
@kiblik annotation for ingressClass is not preferred but supported
/triage accepted
/kind documentation
/priority backlog
/retitle Docs: Specify ingressClass for multi-controller setup.
/lgtm
[APPROVALNOTIFIER] This PR is APPROVED
This pull-request has been approved by: Gacko, kiblik
The full list of commands accepted by this bot can be found here.
The pull request process is described here
- ~~docs/OWNERS~~ [Gacko]
Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment
/cherry-pick release-1.10
@Gacko: once the present PR merges, I will cherry-pick it on top of release-1.10 in a new PR and assign it to you.
In response to this:
/cherry-pick release-1.10
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.
@Gacko: new pull request created: #11520
In response to this:
/cherry-pick release-1.10
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.