Stateful session filter (proto)

This extension has the qualified name envoy.filters.http.stateful_session

Note

This extension is functional but has not had substantial production burn time, use only with this caveat.

This extension has an unknown security posture and should only be used in deployments where both the downstream and upstream are trusted.

Tip

This extension extends and can be used with the following extension category:

This extension must be configured with one of the following type URLs:

Stateful session configuration overview.

extensions.filters.http.stateful_session.v3.StatefulSession

[extensions.filters.http.stateful_session.v3.StatefulSession proto]

{
  "session_state": {...},
  "strict": ...
}
session_state

(config.core.v3.TypedExtensionConfig) Specifies the implementation of session state. This session state is used to store and retrieve the address of the upstream host assigned to the session.

strict

(bool) Determines whether the HTTP request must be strictly routed to the requested destination. When set to true, if the requested destination is unavailable, Envoy will return a 503 status code. The default value is false, which allows Envoy to fall back to its load balancing mechanism. In this case, if the requested destination is not found, the request will be routed according to the load balancing algorithm.

extensions.filters.http.stateful_session.v3.StatefulSessionPerRoute

[extensions.filters.http.stateful_session.v3.StatefulSessionPerRoute proto]

{
  "disabled": ...,
  "stateful_session": {...}
}
disabled

(bool) Disable the stateful session filter for this particular vhost or route. If disabled is specified in multiple per-filter-configs, the most specific one will be used.

Precisely one of disabled, stateful_session must be set.

stateful_session

(extensions.filters.http.stateful_session.v3.StatefulSession) Per-route stateful session configuration that can be served by RDS or static route table.

Precisely one of disabled, stateful_session must be set.