Skip to content

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.

Sign up for GitHub

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

Open
salonichf5 wants to merge 4 commits into
base: ngf-release-2.4
Choose a base branch
from
Open

NGF: User guide for session persistence #1560

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a595e2e
add documentation for session persistence
salonichf5 Dec 10, 2025
946cf7f
update based on reviews
salonichf5 Dec 10, 2025
c4e40e9
remove api.md changes
salonichf5 Dec 11, 2025
763bd63
update the code snippets to shell type
salonichf5 Dec 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/ngf/overview/gateway-api-compatibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
- `name`: Not supported.
- `timeouts`: Not supported.
- `retry`: Not supported.
- `sessionPersistence`: Not supported.
- `sessionPersistence`: Supported (NGINX Plus).
- `status`
- `parents`
- `parentRef`: Supported.
Expand Down Expand Up @@ -226,7 +226,7 @@ See the [controller]({{< ref "/ngf/reference/cli-help.md#controller">}}) command
- `extensionRef`: Supported for SnippetsFilters.
- `backendRefs`: Partially supported. Backend ref `filters` are not supported.
- `name`: Not supported.
- `sessionPersistence`: Not supported.
- `sessionPersistence`: Supported (NGINX Plus).
- `status`
- `parents`
- `parentRef`: Supported.
Expand Down
2 changes: 2 additions & 0 deletions content/ngf/overview/nginx-plus.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,6 @@ NGINX Gateway Fabric can use NGINX Open Source or NGINX Plus as its data plane.
- **Robust metrics**: A plethora of [additional Prometheus metrics]({{< ref "/ngf/monitoring/prometheus.md" >}}) are available.
- **Live activity monitoring**: The [NGINX Plus dashboard]({{< ref "/ngf/monitoring/dashboard.md" >}}) shows real-time metrics and information about your server infrastructure.
- **Dynamic upstream configuration**: NGINX Plus can dynamically reconfigure upstream servers when applications in Kubernetes scale up and down, preventing the need for an NGINX reload.
- **Session persistence**: NGINX Plus provides support for cookie-based session persistence, allowing client requests to be consistently routed to the same upstream pod.
- **Load balancing methods**: NGINX Plus provides advanced, latency-aware load balancing methods (such as `least_time` and `least_time last_byte inflight`) that route traffic based on time to first byte or full response, optionally factoring in in-flight requests for smarter upstream selection.
- **Support**: With an NGINX Plus license, you can take advantage of full [support](https://my.f5.com/manage/s/article/K000140156/) from NGINX, Inc.
2 changes: 1 addition & 1 deletion content/ngf/reference/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4216,4 +4216,4 @@ Examples of invalid names: some-$value, quoted-&ldquo;value&rdquo;-name, unescap
<hr/>
<p><em>
Generated with <code>gen-crd-api-reference-docs</code>
</em></p>
</em></p>
Loading