Skip to content

Commit c295cd1

Browse files
authored
docs: update annotations docs with missing session-cookie section (#10917)
1 parent 4e97379 commit c295cd1

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

docs/user-guide/nginx-configuration/annotations.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,12 +97,15 @@ You can add these Kubernetes annotations to specific Ingress objects to customiz
9797
|[nginx.ingress.kubernetes.io/server-alias](#server-alias)|string|
9898
|[nginx.ingress.kubernetes.io/server-snippet](#server-snippet)|string|
9999
|[nginx.ingress.kubernetes.io/service-upstream](#service-upstream)|"true" or "false"|
100-
|[nginx.ingress.kubernetes.io/session-cookie-name](#cookie-affinity)|string|
101-
|[nginx.ingress.kubernetes.io/session-cookie-path](#cookie-affinity)|string|
102-
|[nginx.ingress.kubernetes.io/session-cookie-domain](#cookie-affinity)|string|
103100
|[nginx.ingress.kubernetes.io/session-cookie-change-on-failure](#cookie-affinity)|"true" or "false"|
104-
|[nginx.ingress.kubernetes.io/session-cookie-samesite](#cookie-affinity)|string|
105101
|[nginx.ingress.kubernetes.io/session-cookie-conditional-samesite-none](#cookie-affinity)|"true" or "false"|
102+
|[nginx.ingress.kubernetes.io/session-cookie-domain](#cookie-affinity)|string|
103+
|[nginx.ingress.kubernetes.io/session-cookie-expires](#cookie-affinity)|string|
104+
|[nginx.ingress.kubernetes.io/session-cookie-max-age](#cookie-affinity)|string|
105+
|[nginx.ingress.kubernetes.io/session-cookie-name](#cookie-affinity)|string|default "INGRESSCOOKIE"|
106+
|[nginx.ingress.kubernetes.io/session-cookie-path](#cookie-affinity)|string|
107+
|[nginx.ingress.kubernetes.io/session-cookie-samesite](#cookie-affinity)|string|"None", "Lax" or "Strict"|
108+
|[nginx.ingress.kubernetes.io/session-cookie-secure](#cookie-affinity)|string|
106109
|[nginx.ingress.kubernetes.io/ssl-redirect](#server-side-https-enforcement-through-redirect)|"true" or "false"|
107110
|[nginx.ingress.kubernetes.io/ssl-passthrough](#ssl-passthrough)|"true" or "false"|
108111
|[nginx.ingress.kubernetes.io/stream-snippet](#stream-snippet)|string|
@@ -193,6 +196,12 @@ Use `nginx.ingress.kubernetes.io/session-cookie-domain` to set the `Domain` attr
193196

194197
Use `nginx.ingress.kubernetes.io/session-cookie-samesite` to apply a `SameSite` attribute to the sticky cookie. Browser accepted values are `None`, `Lax`, and `Strict`. Some browsers reject cookies with `SameSite=None`, including those created before the `SameSite=None` specification (e.g. Chrome 5X). Other browsers mistakenly treat `SameSite=None` cookies as `SameSite=Strict` (e.g. Safari running on OSX 14). To omit `SameSite=None` from browsers with these incompatibilities, add the annotation `nginx.ingress.kubernetes.io/session-cookie-conditional-samesite-none: "true"`.
195198

199+
Use `nginx.ingress.kubernetes.io/session-cookie-expires` to control the cookie expires, its value is a number of seconds until the cookie expires.
200+
201+
Use `nginx.ingress.kubernetes.io/session-cookie-path` to control the cookie path when use-regex is set to true.
202+
203+
Use `nginx.ingress.kubernetes.io/session-cookie-change-on-failure` to control the cookie change after request failure.
204+
196205
### Authentication
197206

198207
It is possible to add authentication by adding additional annotations in the Ingress rule. The source of the authentication is a secret that contains usernames and passwords.

0 commit comments

Comments
 (0)