Skip to content

Commit

Permalink
Typo
Browse files Browse the repository at this point in the history
  • Loading branch information
Tratcher committed Jan 10, 2023
1 parent 193d823 commit 476c50e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/docfx/articles/session-affinity.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Once a request arrives and gets routed to a cluster with session affinity enable
If a new affinity was established for the request, the affinity key gets attached to a response where exact key representation and location depends on the implementation. Currently, there are two built-in policies storing the key on a cookie or custom header. Once the response gets delivered to the client, it's the client responsibility to attach the key to all following requests in the same session. Further, when the next request carrying the key arrives to the proxy, it resolves the existing affinity, but affinity key does not get again attached to the response. Thus, only the first response carries the affinity key.

There are three built-in affinity polices that format and store the key differently on requests and responses. The default policy is `HashCookie`.
- `HashCookie` and `Cookie` store the key as cookie, hashed or encrypted respectively, see [Key Protection](#key-protection) below. The request's key will be delivered as a cookie with configured name and sets the same cookie with `Set-Cookie` header on the first response in an affinitized sequence. The cookie name must be explicitly set via `SessionAffinityConfig.AffinityKeyName`. Other cookie properties can be configured via `SessionAffinityCookieConfig`.
- `HashCookie` and `Cookie` store the key as a cookie, hashed or encrypted respectively, see [Key Protection](#key-protection) below. The request's key will be delivered as a cookie with configured name and sets the same cookie with `Set-Cookie` header on the first response in an affinitized sequence. The cookie name must be explicitly set via `SessionAffinityConfig.AffinityKeyName`. Other cookie properties can be configured via `SessionAffinityCookieConfig`.
- `CustomHeader` - stores the key as an encrypted header. It expects the affinity key to be delivered in a custom header with configured name and sets the same header on the first response in an affinitized sequence. The header name must be set via `SessionAffinityConfig.AffinityKeyName`.

**Important**: `AffinityKeyName` must be unique across all clusters with enabled session affinity to avoid conflicts.
Expand Down

0 comments on commit 476c50e

Please sign in to comment.