Skip to content

docs: document UPSTREAM_METADATA header variable #335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattklein123 merged 3 commits into from
Dec 11, 2017
Merged

docs: document UPSTREAM_METADATA header variable #335

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
010a2eb
docs: document UPSTREAM_METADATA
zuercher Dec 9, 2017
77d9d77
switch format to JSON
zuercher Dec 11, 2017
f8b9498
fix inadvertent change
zuercher Dec 11, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/root/configuration/http_conn_man/headers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ documentation.
**Note:** Headers are appended to requests/responses in the following order: route level headers, virtual host
level headers and finally global level headers.

Envoy additionally supports adding dynamic values to **request** and **response** headers.
Envoy additionally supports adding dynamic values to request and response headers.
Supported dynamic values are:

%CLIENT_IP%
Expand All @@ -299,3 +299,12 @@ Supported dynamic values are:
%PROTOCOL%
The original protocol which is already added by Envoy as a
:ref:`x-forwarded-proto <config_http_conn_man_headers_x-forwarded-proto>` request header.

%UPSTREAM_METADATA(["namespace", "key", ...])%
Populates the header with ref:`EDS endpoint metadata <envoy_api_file_api/eds.proto>` from the
upstream host selected by the router. Metadata may be selected from any namespace. In general,
metadata values may be strings, numbers, booleans, lists, nested structures, or null. Upstream
metadata values may be selected from nested structs by specifying multiple keys. Otherwise,
only string, boolean, and numeric values are supported. If the namespace or key(s) are not
found, or if the selected value is not a supported type, then no header is emitted. The
namespace and key(s) are specified as a JSON array of strings.