Fix custom-headers annotation does not apply the configuration automatically

[jgoelen]

What this PR does / why we need it:

It fixes an open issue #11680.
The problem extends to the response headers not reflecting updates made to the ConfigMap's contents. This limitation stems from the fact that the Ingress object remains unmodified, making it impossible to address through code changes alone. However, a straightforward solution exists: adding a checksum annotation on the Ingress that includes a hash of the ConfigMap's content. This approach would effectively trigger the necessary updates.

kind: Ingress
metadata:
  name: podinfo-ingress
  annotations:
    nginx.ingress.kubernetes.io/custom-headers: custom-security-headers
    checksum/config: cfe9d9d1a364866309f498c8fd07a6208ac5c68aaefa15212e50585fca9cbebe
spec:
...

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 #11680

How Has This Been Tested?

Add extra config to test manifests used by types_equals_test.go.
Manual testing.

Checklist:

• My change requires a change to the documentation.
• 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.
• All new and existing tests passed.

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: jgoelen / name: Jurgen Goelen (4cbaa41, 67f4c98, 1280f56, c259b47, 261b26b, 6cfd223)

[k8s-ci-robot]

This issue is currently awaiting triage.

If Ingress contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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]

Welcome @jgoelen!

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 @jgoelen. 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.

[netlify]

✅ Deploy Preview for kubernetes-ingress-nginx canceled.

Name	Link
🔨 Latest commit	6cfd223
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-ingress-nginx/deploys/673d86e718bc3200082be978

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: jgoelen
Once this PR has been reviewed and has the lgtm label, please assign gacko for approval. 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:

• OWNERS

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

[PavelGloba]

@longwuyuan can it be reviewed by someone? Looks like a small change

[longwuyuan]

Maybe you can post complete detailed kubectl describe and curl outputs of before and after for readers. Use the make dev-env and FOCUS test from here https://kubernetes.github.io/ingress-nginx/developer-guide/getting-started/#testing

…

On Fri, 16 Aug, 2024, 18:56 PavelGloba, ***@***.***> wrote: @longwuyuan <https://github.com/longwuyuan> can it be reviewed by someone? Looks like a small change — Reply to this email directly, view it on GitHub <#11709 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABGZVWT4NINYZA4V7HV6NE3ZRX4Y7AVCNFSM6AAAAABLYKVJF6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEOJTGUYDSMJRHA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[PavelGloba]

Maybe you can post complete detailed kubectl describe and curl outputs of before and after for readers. Use the make dev-env and FOCUS test from here https://kubernetes.github.io/ingress-nginx/developer-guide/getting-started/#testing
…
On Fri, 16 Aug, 2024, 18:56 PavelGloba, @.> wrote: @longwuyuan https://github.com/longwuyuan can it be reviewed by someone? Looks like a small change — Reply to this email directly, view it on GitHub <#11709 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABGZVWT4NINYZA4V7HV6NE3ZRX4Y7AVCNFSM6AAAAABLYKVJF6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEOJTGUYDSMJRHA . You are receiving this because you were mentioned.Message ID: @.>

@jgoelen

[jgoelen]

@longwuyuan @PavelGloba

As requested, I've created a local test setup with detailed test scenarios, which you can find in this repository:

https://github.com/jgoelen/ingress-nginx-custom-headers-test

These should allow you to easily reproduce the tests in your local environment.

I hope this facilitates a quicker review of the PR.

[github-actions]

This is stale, but we won't close it automatically, just bare in mind the maintainers may be busy with other tasks and will reach your issue ASAP. If you have any question or request to prioritize this, please reach #ingress-nginx-dev on Kubernetes Slack.

[k8s-triage-robot]

The lifecycle/frozen label can not be applied to PRs.

This bot removes lifecycle/frozen from PRs because:

• Commenting /lifecycle frozen on a PR has not worked since March 2021
• PRs that remain open for >150 days are unlikely to be easily rebased

You can:

• Rebase this PR and attempt to get it merged
• Close this PR with /close

Please send feedback to sig-contributor-experience at kubernetes/community.

/remove-lifecycle frozen

[gavinkflam]

@jgoelen Why don't you implement an automated e2e tests? There are plenty of examples in the repository.