Skip to content

Commit d24adc9

Browse files
committed
update goals and non goals for session persistence
1 parent 3bf26c7 commit d24adc9

File tree

1 file changed

+10
-16
lines changed

1 file changed

+10
-16
lines changed

docs/proposals/session-persistence.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,21 @@
55

66
## Summary
77

8-
This enhancement proposal extends the Upstream Settings Policy API to support session persistence for both NGINX Plus and NGINX OSS. It enables application developers to configure basic session persistence using `ip_hash` for OSS and cookie-based session persistence for NGINX Plus.
8+
Enable NGINX Gateway Fabric to support session persistence for both NGINX Plus and NGINX OSS, allowing application developers to configure basic session persistence using the `ip_hash` load balancing method in OSS and cookie-based session persistence in NGINX Plus.
99

1010
## Goals
1111

12-
- Extend Upstream Settings Policy API to support session persistence.
12+
- Extend the Upstream Settings Policy API to allow specifying a load balancing method to support basic session persistence.
13+
- Design the translation of the Gateway API `sessionPersistence` specification, which can be configured on both HTTPRoute and GRPCRoute, into NGINX Plus cookie-based session persistence directives with `secure` and `httpOnly` mode enforced by default.
1314

1415
## Non-Goals
1516

16-
- Provide implementation details for enabling session persistence.
17-
- Support session persistence for TLSRoute or other Layer 4 routes.
17+
- Describe or implement low-level configuration details for enabling session persistence.
18+
- Extend session persistence support to TLSRoutes or other Layer 4 route types.
19+
- Supporting the `sameSite` cookie directive for NGINX Plus session persistence, which may be considered in the future as the Gateway API `sessionPersistence` specification evolves.
1820

19-
## Introduction
20-
21-
### Extension of Upstream Settings Policy API
22-
23-
24-
- explain API
25-
- How it works for OSS and Plus
26-
- Describe directives
27-
- directive contraints
28-
- sample config
29-
30-
Apps using session persistence must account for aspects like load shedding, draining, and session migration as a part of their application design.
21+
## Useful Links
3122

23+
- Session Persistence [specification](https://gateway-api.sigs.k8s.io/reference/spec/#sessionpersistence).
24+
- Extended Session Persistence [GEP](https://gateway-api.sigs.k8s.io/geps/gep-1619).
25+
- RFC standard for [Set-Cookie](https://datatracker.ietf.org/doc/html/rfc6265#section-4.1) header.

0 commit comments

Comments
 (0)