-
Notifications
You must be signed in to change notification settings - Fork 125
NGF: User guide for session persistence #1560
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
NGF: User guide for session persistence #1560
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds comprehensive documentation for session persistence in NGINX Gateway Fabric, including a new user guide and updates to existing documentation. It explains both NGINX OSS session affinity using ip_hash and NGINX Plus cookie-based session persistence, while also documenting load balancing method configuration through the UpstreamSettingsPolicy resource.
- Adds a new session persistence user guide with practical examples for NGINX OSS and NGINX Plus
- Updates
UpstreamSettingsPolicydocumentation to include load balancing method configuration - Updates API reference to reflect new fields and removed obsolete sections
- Updates Gateway API compatibility and NGINX Plus features documentation
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| content/ngf/traffic-management/upstream-settings.md | Added documentation for configuring load balancing methods via UpstreamSettingsPolicy with examples for random two least_time=header and hash consistent methods |
| content/ngf/traffic-management/session-persistence.md | New comprehensive guide covering session persistence configuration for both NGINX OSS (ip_hash) and NGINX Plus (cookie-based), with working examples |
| content/ngf/reference/api.md | Updated API reference to include new load balancing fields, removed ObservabilityPolicy section, and updated Gateway API version references from v1alpha2 to v1 |
| content/ngf/overview/nginx-plus.md | Added session persistence and advanced load balancing methods to the list of NGINX Plus features |
| content/ngf/overview/gateway-api-compatibility.md | Updated to reflect that sessionPersistence is now supported for HTTPRoute and GRPCRoute |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
5d35c64 to
946cf7f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally LGTM.
Regarding the OSS/Plus split, this document is small enough that separately documenting the different methods on one page is permissible.
If further delineation is necessary due to increasingly divergent instructions as a result of use cases, I can refactor the structure then.
Aside from everything else, you don't need to fork for the docs repo: cutting a branch directly will give you the preview links, which are easier to review.
7a2a191 to
ccc2bf4
Compare
bjee19
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice work! just a couple of comments.
b587cac to
6a0fc73
Compare
bjee19
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks for making the change!
Proposed changes
Checklist
Before sharing this pull request, I completed the following checklist:
Footnotes
Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content. ↩