HTTP Cache Filter (proto)

extensions.filters.http.cache.v3.CacheConfig

[extensions.filters.http.cache.v3.CacheConfig proto]

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

Note

This extension is work-in-progress. Functionality is incomplete and it is not intended for production use.

This extension is intended to be robust against both untrusted downstream and upstream traffic.

Tip

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

• envoy.filters.http

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

• type.googleapis.com/envoy.extensions.filters.http.cache.v3.CacheConfig

{
  "typed_config": {...},
  "disabled": {...},
  "allowed_vary_headers": []
}

typed_config

(Any) Config specific to the cache storage implementation. Required unless disabled is true.

Tip

This extension category has the following known extensions:

• envoy.extensions.http.cache.file_system_http_cache

• envoy.extensions.http.cache.simple

disabled

(BoolValue) When true, the cache filter is a no-op filter.

Possible use-cases for this include: - Turning a filter on and off with ECDS.

allowed_vary_headers

(repeated type.matcher.v3.StringMatcher) List of matching rules that defines allowed Vary headers.

The vary response header holds a list of header names that affect the contents of a response, as described by https://httpwg.org/specs/rfc7234.html#caching.negotiated.responses.

During insertion, allowed_vary_headers acts as a allowlist: if a response’s vary header mentions any header names that aren’t matched by any rules in allowed_vary_headers, that response will not be cached.

During lookup, allowed_vary_headers controls what request headers will be sent to the cache storage implementation.