HTTP Cache Filter

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

config/filter/http/cache/v2alpha/cache.proto

extensions.filters.http.cache.v3.CacheConfig

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

This extension may be referenced by 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:

  1. {
  2.   "typed_config": "{...}",
  3.   "allowed_vary_headers": []
  4. }

typed_config

(Any) Config specific to the cache storage implementation.

Tip

This extension category has the following known extensions:

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.