Skip to content

Commit 11bbf00

Browse files
avifavif
committed
chore(docs): Cleanup doc change
1 parent a5ed474 commit 11bbf00

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

‎docs/examples/affinity/cookie/README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ This example demonstrates how to achieve session affinity using cookies.
66

77
Session affinity can be configured using the following annotations:
88

9-
| Name | Description |Value|
10-
|----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| --- |
11-
| nginx.ingress.kubernetes.io/affinity | Type of the affinity, set this to `cookie` to enable session affinity |string (NGINX only supports `cookie`)|
12-
| nginx.ingress.kubernetes.io/affinity-mode | The affinity mode defines how sticky a session is. Use `balanced` to redistribute some sessions when scaling pods or `persistent` for maximum stickiness. |`balanced` (default) or `persistent`|
13-
| nginx.ingress.kubernetes.io/affinity-canary-behavior | Defines session affinity behavior of canaries. By default the behavior is `sticky`, and canaries respect session affinity configuration. Set this to `legacy` to restore original canary behavior, when session affinity parameters were not respected. |`sticky` (default) or `legacy`|
14-
| nginx.ingress.kubernetes.io/session-cookie-name | Name of the cookie that will be created |string (defaults to `INGRESSCOOKIE`)|
15-
| nginx.ingress.kubernetes.io/session-cookie-secure | Set the cookie as secure regardless the protocol of the incoming request |`"true"` or `"false"`|
16-
| nginx.ingress.kubernetes.io/session-cookie-path | Path that will be set on the cookie (required if your [Ingress paths][ingress-paths] use regular expressions) |string (defaults to the currently [matched path][ingress-paths])|
17-
| nginx.ingress.kubernetes.io/session-cookie-domain | Domain that will be set on the cookie |string|
18-
| nginx.ingress.kubernetes.io/session-cookie-samesite | `SameSite` attribute to apply to the cookie |Browser accepted values are `None`, `Lax`, and `Strict`|
19-
| nginx.ingress.kubernetes.io/session-cookie-conditional-samesite-none | Will omit `SameSite=None` attribute for older browsers which reject the more-recently defined `SameSite=None` value |`"true"` or `"false"`|
20-
| nginx.ingress.kubernetes.io/session-cookie-partitioned | Will set `Partitioned` attribute on the cookie |`"true"` or `"false"` (defaults to false)|
21-
| nginx.ingress.kubernetes.io/session-cookie-max-age | Time until the cookie expires, corresponds to the `Max-Age` cookie directive |number of seconds|
22-
| nginx.ingress.kubernetes.io/session-cookie-expires | Legacy version of the previous annotation for compatibility with older browsers, generates an `Expires` cookie directive by adding the seconds to the current date |number of seconds|
23-
| nginx.ingress.kubernetes.io/session-cookie-change-on-failure | When set to `false` nginx ingress will send request to upstream pointed by sticky cookie even if previous attempt failed. When set to `true` and previous attempt failed, sticky cookie will be changed to point to another upstream. |`true` or `false` (defaults to `false`)|
9+
|Name|Description|Value|
10+
| --- | --- | --- |
11+
|nginx.ingress.kubernetes.io/affinity|Type of the affinity, set this to `cookie` to enable session affinity|string (NGINX only supports `cookie`)|
12+
|nginx.ingress.kubernetes.io/affinity-mode|The affinity mode defines how sticky a session is. Use `balanced` to redistribute some sessions when scaling pods or `persistent` for maximum stickiness.|`balanced` (default) or `persistent`|
13+
|nginx.ingress.kubernetes.io/affinity-canary-behavior|Defines session affinity behavior of canaries. By default the behavior is `sticky`, and canaries respect session affinity configuration. Set this to `legacy` to restore original canary behavior, when session affinity parameters were not respected.|`sticky` (default) or `legacy`|
14+
|nginx.ingress.kubernetes.io/session-cookie-name|Name of the cookie that will be created|string (defaults to `INGRESSCOOKIE`)|
15+
|nginx.ingress.kubernetes.io/session-cookie-secure|Set the cookie as secure regardless the protocol of the incoming request|`"true"` or `"false"`|
16+
|nginx.ingress.kubernetes.io/session-cookie-path|Path that will be set on the cookie (required if your [Ingress paths][ingress-paths] use regular expressions)|string (defaults to the currently [matched path][ingress-paths])|
17+
|nginx.ingress.kubernetes.io/session-cookie-domain|Domain that will be set on the cookie|string|
18+
|nginx.ingress.kubernetes.io/session-cookie-samesite|`SameSite` attribute to apply to the cookie|Browser accepted values are `None`, `Lax`, and `Strict`|
19+
|nginx.ingress.kubernetes.io/session-cookie-conditional-samesite-none|Will omit `SameSite=None` attribute for older browsers which reject the more-recently defined `SameSite=None` value|`"true"` or `"false"`
20+
| nginx.ingress.kubernetes.io/session-cookie-partitioned| Will set `Partitioned` attribute on the cookie|`"true"` or `"false"` (defaults to false)|
21+
|nginx.ingress.kubernetes.io/session-cookie-max-age|Time until the cookie expires, corresponds to the `Max-Age` cookie directive|number of seconds|
22+
|nginx.ingress.kubernetes.io/session-cookie-expires|Legacy version of the previous annotation for compatibility with older browsers, generates an `Expires` cookie directive by adding the seconds to the current date|number of seconds|
23+
|nginx.ingress.kubernetes.io/session-cookie-change-on-failure|When set to `false` nginx ingress will send request to upstream pointed by sticky cookie even if previous attempt failed. When set to `true` and previous attempt failed, sticky cookie will be changed to point to another upstream.|`true` or `false` (defaults to `false`)|
2424

2525
You can create the [session affinity example Ingress](ingress.yaml) to test this:
2626

0 commit comments

Comments
 (0)