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

Fix duplicate location in NGINX config (#10090) #10091

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

Conversation

ailurarctos
Copy link

@ailurarctos ailurarctos commented Jun 16, 2023

When creating ingresses that use the same path with a mix of Exact and Prefix path types nginx-ingress-controller can generate an NGINX config with a duplicate location:

nginx: [emerg] duplicate location "/a/" in /tmp/nginx/nginx-cfg2287376726:693
nginx: configuration file /tmp/nginx/nginx-cfg2287376726 test failed

The issue is that nginx-ingress-controller stops looking for duplicates once it sees the same path with a different path type.

What this PR does / why we need it:

This is a PR to fix #10090.

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

fixes #10090

How Has This Been Tested?

I added a test for the change. I also ran all tests in https://github.com/kubernetes/ingress-nginx/blob/main/docs/developer-guide/getting-started.md#testing.

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.

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jun 16, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: ailurarctos / name: Gordon Honda (4f2950f)

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jun 16, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @ailurarctos!

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 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 Jun 16, 2023
@k8s-ci-robot
Copy link
Contributor

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

@k8s-ci-robot k8s-ci-robot added the needs-kind Indicates a PR lacks a `kind/foo` label and requires one. label Jun 16, 2023
@k8s-ci-robot k8s-ci-robot added needs-priority size/L Denotes a PR that changes 100-499 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 16, 2023
@longwuyuan
Copy link
Contributor

@ailurarctos thanks for the contribution.

I see this in the related issue

Note that the admission webhook is disabled as it does not allow for identical paths. Identical paths can be useful when doing a migration from one ingress to another.

Can you clarify ,if this protection from duplication PR, is assuming that the admission webhook is deleted.

@ailurarctos
Copy link
Author

Can you clarify ,if this protection from duplication PR, is assuming that the admission webhook is deleted.

Yes. I put more details in #10090 (comment).

@strongjz
Copy link
Member

/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 27, 2023
@tao12345666333
Copy link
Member

/assign

@tao12345666333
Copy link
Member

Sorry for the delay.
I will add this to my list, and finish the review on Friday. Thanks

@DemIG
Copy link

DemIG commented Oct 30, 2023

@tao12345666333 sorry, did you have a chance to review this pr?

When creating ingresses that use the same path with a mix of
Exact and Prefix path types nginx-ingress-controller can
generate an NGINX config with a duplicate location:

    nginx: [emerg] duplicate location "/a/" in /tmp/nginx/nginx-cfg2287376726:693
    nginx: configuration file /tmp/nginx/nginx-cfg2287376726 test failed

The issue is that nginx-ingress-controller stops looking for
duplicates once it sees the same path with a different path type.
Copy link

netlify bot commented Feb 23, 2024

Deploy Preview for kubernetes-ingress-nginx canceled.

Name Link
🔨 Latest commit 4f2950f
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-ingress-nginx/deploys/65d7fd8e07d88800085de082

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: ailurarctos
Once this PR has been reviewed and has the lgtm label, please ask for approval from tao12345666333. For more information see the Kubernetes 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

Spec: networking.IngressSpec{
Rules: []networking.IngressRule{
{
Host: "example.com",
Copy link
Author

Choose a reason for hiding this comment

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

Should I make a const for this as the linter suggests? It doesn't seem to match the way the existing tests are written.

Copy link
Contributor

Choose a reason for hiding this comment

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

yes please, let's make linter happy

@tao12345666333 tao12345666333 added the triage/accepted Indicates an issue or PR is ready to be actively worked on. label Mar 30, 2024
@k8s-ci-robot k8s-ci-robot removed the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Mar 30, 2024
Copy link
Contributor

@rikatz rikatz left a comment

Choose a reason for hiding this comment

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

Also please add an e2e test case for this one
I will approve it after that, just ping me on slack

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-priority ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

support disabling admission-webhook for creating duplicates
7 participants