ingress-nginx icon indicating copy to clipboard operation
ingress-nginx copied to clipboard

Add partitioned cookie support for cookie-affinity

Open avif opened this issue 10 months ago • 12 comments

What this PR does / why we need it:

This adds the option of making the session cookie "partitioned" via an annotation nginx.ingress.kubernetes.io/session-cookie-partitioned, this is needed to support Cookies Having Independent Partitioned State (CHIPS) (See #10428).

Types of changes

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [x] 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 #10428

How Has This Been Tested?

  • Unit tests

Checklist:

  • [x] My change requires a change to the documentation.
  • [x] I have updated the documentation accordingly.
  • [x] I've read the CONTRIBUTION guide
  • [x] I have added unit and/or e2e tests to cover my changes.
  • [ ] All new and existing tests passed. - (Could not run all unit tests successfully before the changes [something about storing a fake SSL cert], so they still failed after the changes)

avif avatar Apr 09 '24 22:04 avif

CLA Signed

The committers listed above are authorized under a signed CLA.

  • :white_check_mark: login: avif (c1d3a92fe9fa0e45846406ba36aba7d8bdfa3ffa, 04942ab69608551dded96638a1a16e6598cc2b3d, 33b96d1e73b285d6c42464e080606bbd03e7ac73, 03c5ce57add53dd5c3230e8e38ff3f2fbcccdee8, 7e5e2348ea49288fd365f28f679eb34a6a2c0565, 6cd998f03190849931f6e7e5ad665ed51c7c1c71, a68f2a67bbf3b2aed97f1c17d5a0a1d484339f4b, 8777f34ec7dc955f7b7777791f97640fae68725a)

Welcome @avif!

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:

k8s-ci-robot avatar Apr 09 '24 22:04 k8s-ci-robot

Hi @avif. 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 avatar Apr 09 '24 22:04 k8s-ci-robot

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: avif Once this PR has been reviewed and has the lgtm label, please assign puerco 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:

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

k8s-ci-robot avatar Apr 09 '24 22:04 k8s-ci-robot

Deploy Preview for kubernetes-ingress-nginx ready!

Name Link
Latest commit 03c5ce57add53dd5c3230e8e38ff3f2fbcccdee8
Latest deploy log https://app.netlify.com/sites/kubernetes-ingress-nginx/deploys/6703d0643ae0b30008336335
Deploy Preview https://deploy-preview-11242--kubernetes-ingress-nginx.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Apr 09 '24 22:04 netlify[bot]

/ok-to-test

From go side lgtm, I'm wondering if there's no release on lua cookies module yet, instead of tracking a commit.

Thanks

rikatz avatar Apr 15 '24 21:04 rikatz

/ok-to-test

From go side lgtm, I'm wondering if there's no release on lua cookies module yet, instead of tracking a commit.

Thanks

Switched to tags instead of commits.

avif avatar Apr 16 '24 12:04 avif

Any chance to get a review? :) @tao12345666333 @rikatz

avif avatar May 08 '24 08:05 avif

/triage accepted /kind feature

longwuyuan avatar May 08 '24 08:05 longwuyuan

Hey, is there any chance someone can resurrect this PR?

miskr-instructure avatar Sep 13 '24 18:09 miskr-instructure

CC @Gacko @rikatz @tao12345666333 if/when possible, please review.

@avif @miskr-instructure this needs rebase

longwuyuan avatar Sep 13 '24 19:09 longwuyuan

@Gacko

I cannot give a lot of review regarding the actual change, but I definitely have serious doubts about changing the Lua Resty Cookie module.

Actually it was already changed from cloudflare/[email protected] to utix/lua-resty-cookie#9533f47 by this change and was reverted (possibly by mistake) by this change, I just bumped the version.

Could you please elaborate on why this is needed? Normally we discourage such bumps and changes to the modules being built into NGINX in PRs and would prefer having a discussion first.

Sure, the cloudflare repo is archived and so has no newer versions. As for the bump in version, Partitioned is new cookie semantics and did not exist in the currently used package (pre or post revert).

Sorry to say, but I can remember serious issues in the past and therefore we're just a bit more cautious when it comes to such changes.

No need to apologize, I for one appreciate the cautious approach.

avif avatar Oct 07 '24 12:10 avif