☰
Navigation :

StatefulSession

Package: stateful_session.options.gloo.solo.io

Types:

Source File: github.com/solo-io/gloo/projects/gloo/api/v1/enterprise/options/stateful_session/stateful_session.proto

StatefulSession

This configures the Envoy Stateful Session filter for a listener

"cookieBased": .stateful_session.options.gloo.solo.io.CookieBasedSessionState
"headerBased": .stateful_session.options.gloo.solo.io.HeaderBasedSessionState
"strict": bool
Field Type Description
cookieBased .stateful_session.options.gloo.solo.io.CookieBasedSessionState Configure a cookie based session state - https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/http/stateful_session/cookie/v3/cookie.proto#envoy-v3-api-msg-extensions-http-stateful-session-cookie-v3-cookiebasedsessionstate Exactly one of cookie_based or header_based must be set. Only one of cookieBased or headerBased can be set.
headerBased .stateful_session.options.gloo.solo.io.HeaderBasedSessionState Configure a header based session state - https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/http/stateful_session/cookie/v3/cookie.proto#envoy-v3-api-msg-extensions-http-stateful-session-cookie-v3-cookiebasedsessionstate Exactly one of cookie_based or header_based must be set. Only one of headerBased or cookieBased can be set.
strict bool If set to True, the HTTP request must be routed to the requested destination. If the requested destination is not available, Envoy returns 503. Defaults to False.

CookieBasedSessionState

Configuration for the cookie-based session state filter

"cookie": .stateful_session.options.gloo.solo.io.CookieBasedSessionState.Cookie
Field Type Description
cookie .stateful_session.options.gloo.solo.io.CookieBasedSessionState.Cookie Required, the cookie configuration used to track session state. 
"name": string
"path": string
"ttl": .google.protobuf.Duration
Field Type Description
name string Required, the name that will be used to obtain cookie value from downstream HTTP request or generate new cookie for downstream.
path string Path of cookie. This will be used to set the path of a new cookie when it is generated. If no path is specified here, no path will be set for the cookie.
ttl .google.protobuf.Duration Duration of cookie. This will be used to set the expiry time of a new cookie when it is generated. Set this to 0s to use a session cookie and disable cookie expiration.

HeaderBasedSessionState

Configuration for the header-based session state filter

"headerName": string
Field Type Description
headerName string Required, the header used to track session state.