Skip to content

Conversation

@salonichf5
Copy link
Contributor

@salonichf5 salonichf5 commented Dec 10, 2025

Proposed changes

  • Includes a user guide for session persistence
  • updated upstream settings policy document
  • updates gateway compatibility document
  • updates nginx plus features list

Checklist

Before sharing this pull request, I completed the following checklist:

Footnotes

  1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content.

@salonichf5 salonichf5 requested a review from a team as a code owner December 10, 2025 16:41
@github-actions github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels Dec 10, 2025
@salonichf5 salonichf5 requested a review from a team December 10, 2025 16:41
@salonichf5 salonichf5 requested a review from Copilot December 10, 2025 18:42
Copy link

Copilot AI left a 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 UpstreamSettingsPolicy documentation 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.

@salonichf5 salonichf5 force-pushed the docs/session-persistence branch from 5d35c64 to 946cf7f Compare December 10, 2025 21:27
Copy link
Member

@ADubhlaoich ADubhlaoich left a 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 branch for the docs repo: cutting a branch directly will give you the preview links, which are easier to review.

@salonichf5 salonichf5 requested a review from sjberman December 15, 2025 16:52
@salonichf5 salonichf5 requested a review from sjberman December 15, 2025 19:41
@salonichf5 salonichf5 force-pushed the docs/session-persistence branch from 7a2a191 to ccc2bf4 Compare December 15, 2025 19:49
Copy link
Contributor

@bjee19 bjee19 left a 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.

@salonichf5 salonichf5 force-pushed the docs/session-persistence branch from b587cac to 6a0fc73 Compare December 15, 2025 21:17
Copy link
Contributor

@bjee19 bjee19 left a 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!

@salonichf5 salonichf5 merged commit 8acac90 into nginx:ngf-release-2.4 Dec 15, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants