.. _envoy_v3_api_file_envoy/config/route/v3/route_components.proto:
HTTP route components
=====================
* Routing :ref:`architecture overview <arch_overview_http_routing>`
* HTTP :ref:`router filter <config_http_filters_router>`
.. _envoy_v3_api_msg_config.route.v3.VirtualHost:
config.route.v3.VirtualHost
---------------------------
`[config.route.v3.VirtualHost proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L36>`_
The top level element in the routing configuration is a virtual host. Each virtual host has
a logical name as well as a set of domains that get routed to it based on the incoming request's
host header. This allows a single listener to service multiple top level domain path trees. Once
a virtual host is selected based on the domain, the routes are processed in order to see which
upstream cluster to route to or whether to perform a redirect.
.. code-block:: json
{
"name": "...",
"domains": [],
"routes": [],
"require_tls": "...",
"virtual_clusters": [],
"rate_limits": [],
"request_headers_to_add": [],
"request_headers_to_remove": [],
"response_headers_to_add": [],
"response_headers_to_remove": [],
"cors": "{...}",
"typed_per_filter_config": "{...}",
"include_request_attempt_count": "...",
"include_attempt_count_in_response": "...",
"retry_policy": "{...}",
"hedge_policy": "{...}",
"per_request_buffer_limit_bytes": "{...}"
}
.. _envoy_v3_api_field_config.route.v3.VirtualHost.name:
name
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) The logical name of the virtual host. This is used when emitting certain
statistics but is not relevant for routing.
.. _envoy_v3_api_field_config.route.v3.VirtualHost.domains:
domains
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) A list of domains (host/authority header) that will be matched to this
virtual host. Wildcard hosts are supported in the suffix or prefix form.
Domain search order:
1. Exact domain names: ``www.foo.com``.
2. Suffix domain wildcards: ``*.foo.com`` or ``*-bar.foo.com``.
3. Prefix domain wildcards: ``foo.*`` or ``foo-*``.
4. Special wildcard ``*`` matching any domain.
.. note::
The wildcard will not match the empty string.
e.g. ``*-bar.foo.com`` will match ``baz-bar.foo.com`` but not ``-bar.foo.com``.
The longest wildcards match first.
Only a single virtual host in the entire route configuration can match on ``*``. A domain
must be unique across all virtual hosts or the config will fail to load.
Domains cannot contain control characters. This is validated by the well_known_regex HTTP_HEADER_VALUE.
.. _envoy_v3_api_field_config.route.v3.VirtualHost.routes:
routes
(:ref:`config.route.v3.Route <envoy_v3_api_msg_config.route.v3.Route>`) The list of routes that will be matched, in order, for incoming requests.
The first route that matches will be used.
.. _envoy_v3_api_field_config.route.v3.VirtualHost.require_tls:
require_tls
(:ref:`config.route.v3.VirtualHost.TlsRequirementType <envoy_v3_api_enum_config.route.v3.VirtualHost.TlsRequirementType>`) Specifies the type of TLS enforcement the virtual host expects. If this option is not
specified, there is no TLS requirement for the virtual host.
.. _envoy_v3_api_field_config.route.v3.VirtualHost.virtual_clusters:
virtual_clusters
(:ref:`config.route.v3.VirtualCluster <envoy_v3_api_msg_config.route.v3.VirtualCluster>`) A list of virtual clusters defined for this virtual host. Virtual clusters
are used for additional statistics gathering.
.. _envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits:
rate_limits
(:ref:`config.route.v3.RateLimit <envoy_v3_api_msg_config.route.v3.RateLimit>`) Specifies a set of rate limit configurations that will be applied to the
virtual host.
.. _envoy_v3_api_field_config.route.v3.VirtualHost.request_headers_to_add:
request_headers_to_add
(:ref:`config.core.v3.HeaderValueOption <envoy_v3_api_msg_config.core.v3.HeaderValueOption>`) Specifies a list of HTTP headers that should be added to each request
handled by this virtual host. Headers specified at this level are applied
after headers from enclosed :ref:`envoy_v3_api_msg_config.route.v3.Route` and before headers from the
enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including
details on header value syntax, see the documentation on :ref:`custom request headers
<config_http_conn_man_headers_custom_request_headers>`.
.. _envoy_v3_api_field_config.route.v3.VirtualHost.request_headers_to_remove:
request_headers_to_remove
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Specifies a list of HTTP headers that should be removed from each request
handled by this virtual host.
.. _envoy_v3_api_field_config.route.v3.VirtualHost.response_headers_to_add:
response_headers_to_add
(:ref:`config.core.v3.HeaderValueOption <envoy_v3_api_msg_config.core.v3.HeaderValueOption>`) Specifies a list of HTTP headers that should be added to each response
handled by this virtual host. Headers specified at this level are applied
after headers from enclosed :ref:`envoy_v3_api_msg_config.route.v3.Route` and before headers from the
enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including
details on header value syntax, see the documentation on :ref:`custom request headers
<config_http_conn_man_headers_custom_request_headers>`.
.. _envoy_v3_api_field_config.route.v3.VirtualHost.response_headers_to_remove:
response_headers_to_remove
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Specifies a list of HTTP headers that should be removed from each response
handled by this virtual host.
.. _envoy_v3_api_field_config.route.v3.VirtualHost.cors:
cors
(:ref:`config.route.v3.CorsPolicy <envoy_v3_api_msg_config.route.v3.CorsPolicy>`) Indicates that the virtual host has a CORS policy.
.. _envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config:
typed_per_filter_config
(map<`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, `Any <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#any>`_>) The per_filter_config field can be used to provide virtual host-specific
configurations for filters. The key should match the filter name, such as
*envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter
specific; see the :ref:`HTTP filter documentation <config_http_filters>`
for if and how it is utilized.
.. _envoy_v3_api_field_config.route.v3.VirtualHost.include_request_attempt_count:
include_request_attempt_count
(`bool <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Decides whether the :ref:`x-envoy-attempt-count
<config_http_filters_router_x-envoy-attempt-count>` header should be included
in the upstream request. Setting this option will cause it to override any existing header
value, so in the case of two Envoys on the request path with this option enabled, the upstream
will see the attempt count as perceived by the second Envoy. Defaults to false.
This header is unaffected by the
:ref:`suppress_envoy_headers
<envoy_v3_api_field_extensions.filters.http.router.v3.Router.suppress_envoy_headers>` flag.
.. _envoy_v3_api_field_config.route.v3.VirtualHost.include_attempt_count_in_response:
include_attempt_count_in_response
(`bool <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Decides whether the :ref:`x-envoy-attempt-count
<config_http_filters_router_x-envoy-attempt-count>` header should be included
in the downstream response. Setting this option will cause the router to override any existing header
value, so in the case of two Envoys on the request path with this option enabled, the downstream
will see the attempt count as perceived by the Envoy closest upstream from itself. Defaults to false.
This header is unaffected by the
:ref:`suppress_envoy_headers
<envoy_v3_api_field_extensions.filters.http.router.v3.Router.suppress_envoy_headers>` flag.
.. _envoy_v3_api_field_config.route.v3.VirtualHost.retry_policy:
retry_policy
(:ref:`config.route.v3.RetryPolicy <envoy_v3_api_msg_config.route.v3.RetryPolicy>`) Indicates the retry policy for all routes in this virtual host. Note that setting a
route level entry will take precedence over this config and it'll be treated
independently (e.g.: values are not inherited).
.. _envoy_v3_api_field_config.route.v3.VirtualHost.hedge_policy:
hedge_policy
(:ref:`config.route.v3.HedgePolicy <envoy_v3_api_msg_config.route.v3.HedgePolicy>`) Indicates the hedge policy for all routes in this virtual host. Note that setting a
route level entry will take precedence over this config and it'll be treated
independently (e.g.: values are not inherited).
.. _envoy_v3_api_field_config.route.v3.VirtualHost.per_request_buffer_limit_bytes:
per_request_buffer_limit_bytes
(`UInt32Value <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#uint32value>`_) The maximum bytes which will be buffered for retries and shadowing.
If set and a route-specific limit is not set, the bytes actually buffered will be the minimum
value of this and the listener per_connection_buffer_limit_bytes.
.. _envoy_v3_api_enum_config.route.v3.VirtualHost.TlsRequirementType:
Enum config.route.v3.VirtualHost.TlsRequirementType
---------------------------------------------------
`[config.route.v3.VirtualHost.TlsRequirementType proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L39>`_
.. _envoy_v3_api_enum_value_config.route.v3.VirtualHost.TlsRequirementType.NONE:
NONE
*(DEFAULT)* No TLS requirement for the virtual host.
.. _envoy_v3_api_enum_value_config.route.v3.VirtualHost.TlsRequirementType.EXTERNAL_ONLY:
EXTERNAL_ONLY
External requests must use TLS. If a request is external and it is not
using TLS, a 301 redirect will be sent telling the client to use HTTPS.
.. _envoy_v3_api_enum_value_config.route.v3.VirtualHost.TlsRequirementType.ALL:
ALL
All requests must use TLS. If a request is not using TLS, a 301 redirect
will be sent telling the client to use HTTPS.
.. _envoy_v3_api_msg_config.route.v3.FilterAction:
config.route.v3.FilterAction
----------------------------
`[config.route.v3.FilterAction proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L181>`_
A filter-defined action type.
.. code-block:: json
{
"action": "{...}"
}
.. _envoy_v3_api_field_config.route.v3.FilterAction.action:
action
(`Any <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#any>`_)
.. _envoy_v3_api_msg_config.route.v3.Route:
config.route.v3.Route
---------------------
`[config.route.v3.Route proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L195>`_
A route is both a specification of how to match a request as well as an indication of what to do
next (e.g., redirect, forward, rewrite, etc.).
.. attention::
Envoy supports routing on HTTP method via :ref:`header matching
<envoy_v3_api_msg_config.route.v3.HeaderMatcher>`.
.. code-block:: json
{
"name": "...",
"match": "{...}",
"route": "{...}",
"redirect": "{...}",
"direct_response": "{...}",
"metadata": "{...}",
"decorator": "{...}",
"typed_per_filter_config": "{...}",
"request_headers_to_add": [],
"request_headers_to_remove": [],
"response_headers_to_add": [],
"response_headers_to_remove": [],
"tracing": "{...}",
"per_request_buffer_limit_bytes": "{...}"
}
.. _envoy_v3_api_field_config.route.v3.Route.name:
name
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Name for the route.
.. _envoy_v3_api_field_config.route.v3.Route.match:
match
(:ref:`config.route.v3.RouteMatch <envoy_v3_api_msg_config.route.v3.RouteMatch>`, *REQUIRED*) Route matching parameters.
.. _envoy_v3_api_field_config.route.v3.Route.route:
route
(:ref:`config.route.v3.RouteAction <envoy_v3_api_msg_config.route.v3.RouteAction>`) Route request to some upstream cluster.
Precisely one of :ref:`route <envoy_v3_api_field_config.route.v3.Route.route>`, :ref:`redirect <envoy_v3_api_field_config.route.v3.Route.redirect>`, :ref:`direct_response <envoy_v3_api_field_config.route.v3.Route.direct_response>` must be set.
.. _envoy_v3_api_field_config.route.v3.Route.redirect:
redirect
(:ref:`config.route.v3.RedirectAction <envoy_v3_api_msg_config.route.v3.RedirectAction>`) Return a redirect.
Precisely one of :ref:`route <envoy_v3_api_field_config.route.v3.Route.route>`, :ref:`redirect <envoy_v3_api_field_config.route.v3.Route.redirect>`, :ref:`direct_response <envoy_v3_api_field_config.route.v3.Route.direct_response>` must be set.
.. _envoy_v3_api_field_config.route.v3.Route.direct_response:
direct_response
(:ref:`config.route.v3.DirectResponseAction <envoy_v3_api_msg_config.route.v3.DirectResponseAction>`) Return an arbitrary HTTP response directly, without proxying.
Precisely one of :ref:`route <envoy_v3_api_field_config.route.v3.Route.route>`, :ref:`redirect <envoy_v3_api_field_config.route.v3.Route.redirect>`, :ref:`direct_response <envoy_v3_api_field_config.route.v3.Route.direct_response>` must be set.
.. _envoy_v3_api_field_config.route.v3.Route.metadata:
metadata
(:ref:`config.core.v3.Metadata <envoy_v3_api_msg_config.core.v3.Metadata>`) The Metadata field can be used to provide additional information
about the route. It can be used for configuration, stats, and logging.
The metadata should go under the filter namespace that will need it.
For instance, if the metadata is intended for the Router filter,
the filter name should be specified as *envoy.filters.http.router*.
.. _envoy_v3_api_field_config.route.v3.Route.decorator:
decorator
(:ref:`config.route.v3.Decorator <envoy_v3_api_msg_config.route.v3.Decorator>`) Decorator for the matched route.
.. _envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config:
typed_per_filter_config
(map<`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, `Any <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#any>`_>) The typed_per_filter_config field can be used to provide route-specific
configurations for filters. The key should match the filter name, such as
*envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter
specific; see the :ref:`HTTP filter documentation <config_http_filters>` for
if and how it is utilized.
.. _envoy_v3_api_field_config.route.v3.Route.request_headers_to_add:
request_headers_to_add
(:ref:`config.core.v3.HeaderValueOption <envoy_v3_api_msg_config.core.v3.HeaderValueOption>`) Specifies a set of headers that will be added to requests matching this
route. Headers specified at this level are applied before headers from the
enclosing :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` and
:ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including details on
header value syntax, see the documentation on :ref:`custom request headers
<config_http_conn_man_headers_custom_request_headers>`.
.. _envoy_v3_api_field_config.route.v3.Route.request_headers_to_remove:
request_headers_to_remove
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Specifies a list of HTTP headers that should be removed from each request
matching this route.
.. _envoy_v3_api_field_config.route.v3.Route.response_headers_to_add:
response_headers_to_add
(:ref:`config.core.v3.HeaderValueOption <envoy_v3_api_msg_config.core.v3.HeaderValueOption>`) Specifies a set of headers that will be added to responses to requests
matching this route. Headers specified at this level are applied before
headers from the enclosing :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost` and
:ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including
details on header value syntax, see the documentation on
:ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
.. _envoy_v3_api_field_config.route.v3.Route.response_headers_to_remove:
response_headers_to_remove
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Specifies a list of HTTP headers that should be removed from each response
to requests matching this route.
.. _envoy_v3_api_field_config.route.v3.Route.tracing:
tracing
(:ref:`config.route.v3.Tracing <envoy_v3_api_msg_config.route.v3.Tracing>`) Presence of the object defines whether the connection manager's tracing configuration
is overridden by this route specific instance.
.. _envoy_v3_api_field_config.route.v3.Route.per_request_buffer_limit_bytes:
per_request_buffer_limit_bytes
(`UInt32Value <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#uint32value>`_) The maximum bytes which will be buffered for retries and shadowing.
If set, the bytes actually buffered will be the minimum value of this and the
listener per_connection_buffer_limit_bytes.
.. _envoy_v3_api_msg_config.route.v3.WeightedCluster:
config.route.v3.WeightedCluster
-------------------------------
`[config.route.v3.WeightedCluster proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L285>`_
Compared to the :ref:`cluster <envoy_v3_api_field_config.route.v3.RouteAction.cluster>` field that specifies a
single upstream cluster as the target of a request, the :ref:`weighted_clusters
<envoy_v3_api_field_config.route.v3.RouteAction.weighted_clusters>` option allows for specification of
multiple upstream clusters along with weights that indicate the percentage of
traffic to be forwarded to each cluster. The router selects an upstream cluster based on the
weights.
.. code-block:: json
{
"clusters": [],
"total_weight": "{...}",
"runtime_key_prefix": "..."
}
.. _envoy_v3_api_field_config.route.v3.WeightedCluster.clusters:
clusters
(:ref:`config.route.v3.WeightedCluster.ClusterWeight <envoy_v3_api_msg_config.route.v3.WeightedCluster.ClusterWeight>`, *REQUIRED*) Specifies one or more upstream clusters associated with the route.
.. _envoy_v3_api_field_config.route.v3.WeightedCluster.total_weight:
total_weight
(`UInt32Value <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#uint32value>`_) Specifies the total weight across all clusters. The sum of all cluster weights must equal this
value, which must be greater than 0. Defaults to 100.
.. _envoy_v3_api_field_config.route.v3.WeightedCluster.runtime_key_prefix:
runtime_key_prefix
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Specifies the runtime key prefix that should be used to construct the
runtime keys associated with each cluster. When the *runtime_key_prefix* is
specified, the router will look for weights associated with each upstream
cluster under the key *runtime_key_prefix* + "." + *cluster[i].name* where
*cluster[i]* denotes an entry in the clusters array field. If the runtime
key for the cluster does not exist, the value specified in the
configuration file will be used as the default weight. See the :ref:`runtime documentation
<operations_runtime>` for how key names map to the underlying implementation.
.. _envoy_v3_api_msg_config.route.v3.WeightedCluster.ClusterWeight:
config.route.v3.WeightedCluster.ClusterWeight
---------------------------------------------
`[config.route.v3.WeightedCluster.ClusterWeight proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L289>`_
.. code-block:: json
{
"name": "...",
"weight": "{...}",
"metadata_match": "{...}",
"request_headers_to_add": [],
"request_headers_to_remove": [],
"response_headers_to_add": [],
"response_headers_to_remove": [],
"typed_per_filter_config": "{...}"
}
.. _envoy_v3_api_field_config.route.v3.WeightedCluster.ClusterWeight.name:
name
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) Name of the upstream cluster. The cluster must exist in the
:ref:`cluster manager configuration <config_cluster_manager>`.
.. _envoy_v3_api_field_config.route.v3.WeightedCluster.ClusterWeight.weight:
weight
(`UInt32Value <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#uint32value>`_) An integer between 0 and :ref:`total_weight
<envoy_v3_api_field_config.route.v3.WeightedCluster.total_weight>`. When a request matches the route,
the choice of an upstream cluster is determined by its weight. The sum of weights across all
entries in the clusters array must add up to the total_weight, which defaults to 100.
.. _envoy_v3_api_field_config.route.v3.WeightedCluster.ClusterWeight.metadata_match:
metadata_match
(:ref:`config.core.v3.Metadata <envoy_v3_api_msg_config.core.v3.Metadata>`) Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints in
the upstream cluster with metadata matching what is set in this field will be considered for
load balancing. Note that this will be merged with what's provided in
:ref:`RouteAction.metadata_match <envoy_v3_api_field_config.route.v3.RouteAction.metadata_match>`, with
values here taking precedence. The filter name should be specified as *envoy.lb*.
.. _envoy_v3_api_field_config.route.v3.WeightedCluster.ClusterWeight.request_headers_to_add:
request_headers_to_add
(:ref:`config.core.v3.HeaderValueOption <envoy_v3_api_msg_config.core.v3.HeaderValueOption>`) Specifies a list of headers to be added to requests when this cluster is selected
through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
Headers specified at this level are applied before headers from the enclosing
:ref:`envoy_v3_api_msg_config.route.v3.Route`, :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost`, and
:ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including details on
header value syntax, see the documentation on :ref:`custom request headers
<config_http_conn_man_headers_custom_request_headers>`.
.. _envoy_v3_api_field_config.route.v3.WeightedCluster.ClusterWeight.request_headers_to_remove:
request_headers_to_remove
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Specifies a list of HTTP headers that should be removed from each request when
this cluster is selected through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
.. _envoy_v3_api_field_config.route.v3.WeightedCluster.ClusterWeight.response_headers_to_add:
response_headers_to_add
(:ref:`config.core.v3.HeaderValueOption <envoy_v3_api_msg_config.core.v3.HeaderValueOption>`) Specifies a list of headers to be added to responses when this cluster is selected
through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
Headers specified at this level are applied before headers from the enclosing
:ref:`envoy_v3_api_msg_config.route.v3.Route`, :ref:`envoy_v3_api_msg_config.route.v3.VirtualHost`, and
:ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration`. For more information, including details on
header value syntax, see the documentation on :ref:`custom request headers
<config_http_conn_man_headers_custom_request_headers>`.
.. _envoy_v3_api_field_config.route.v3.WeightedCluster.ClusterWeight.response_headers_to_remove:
response_headers_to_remove
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Specifies a list of headers to be removed from responses when this cluster is selected
through the enclosing :ref:`envoy_v3_api_msg_config.route.v3.RouteAction`.
.. _envoy_v3_api_field_config.route.v3.WeightedCluster.ClusterWeight.typed_per_filter_config:
typed_per_filter_config
(map<`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, `Any <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#any>`_>) The per_filter_config field can be used to provide weighted cluster-specific
configurations for filters. The key should match the filter name, such as
*envoy.filters.http.buffer* for the HTTP buffer filter. Use of this field is filter
specific; see the :ref:`HTTP filter documentation <config_http_filters>`
for if and how it is utilized.
.. _envoy_v3_api_msg_config.route.v3.RouteMatch:
config.route.v3.RouteMatch
--------------------------
`[config.route.v3.RouteMatch proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L369>`_
.. code-block:: json
{
"prefix": "...",
"path": "...",
"safe_regex": "{...}",
"case_sensitive": "{...}",
"runtime_fraction": "{...}",
"headers": [],
"query_parameters": [],
"grpc": "{...}",
"tls_context": "{...}"
}
.. _envoy_v3_api_field_config.route.v3.RouteMatch.prefix:
prefix
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) If specified, the route is a prefix rule meaning that the prefix must
match the beginning of the *:path* header.
Precisely one of :ref:`prefix <envoy_v3_api_field_config.route.v3.RouteMatch.prefix>`, :ref:`path <envoy_v3_api_field_config.route.v3.RouteMatch.path>`, :ref:`safe_regex <envoy_v3_api_field_config.route.v3.RouteMatch.safe_regex>` must be set.
.. _envoy_v3_api_field_config.route.v3.RouteMatch.path:
path
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) If specified, the route is an exact path rule meaning that the path must
exactly match the *:path* header once the query string is removed.
Precisely one of :ref:`prefix <envoy_v3_api_field_config.route.v3.RouteMatch.prefix>`, :ref:`path <envoy_v3_api_field_config.route.v3.RouteMatch.path>`, :ref:`safe_regex <envoy_v3_api_field_config.route.v3.RouteMatch.safe_regex>` must be set.
.. _envoy_v3_api_field_config.route.v3.RouteMatch.safe_regex:
safe_regex
(:ref:`type.matcher.v3.RegexMatcher <envoy_v3_api_msg_type.matcher.v3.RegexMatcher>`) If specified, the route is a regular expression rule meaning that the
regex must match the *:path* header once the query string is removed. The entire path
(without the query string) must match the regex. The rule will not match if only a
subsequence of the *:path* header matches the regex.
Precisely one of :ref:`prefix <envoy_v3_api_field_config.route.v3.RouteMatch.prefix>`, :ref:`path <envoy_v3_api_field_config.route.v3.RouteMatch.path>`, :ref:`safe_regex <envoy_v3_api_field_config.route.v3.RouteMatch.safe_regex>` must be set.
.. _envoy_v3_api_field_config.route.v3.RouteMatch.case_sensitive:
case_sensitive
(`BoolValue <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue>`_) Indicates that prefix/path matching should be case insensitive. The default
is true.
.. _envoy_v3_api_field_config.route.v3.RouteMatch.runtime_fraction:
runtime_fraction
(:ref:`config.core.v3.RuntimeFractionalPercent <envoy_v3_api_msg_config.core.v3.RuntimeFractionalPercent>`) Indicates that the route should additionally match on a runtime key. Every time the route
is considered for a match, it must also fall under the percentage of matches indicated by
this field. For some fraction N/D, a random number in the range [0,D) is selected. If the
number is <= the value of the numerator N, or if the key is not present, the default
value, the router continues to evaluate the remaining match criteria. A runtime_fraction
route configuration can be used to roll out route changes in a gradual manner without full
code/config deploys. Refer to the :ref:`traffic shifting
<config_http_conn_man_route_table_traffic_splitting_shift>` docs for additional documentation.
.. note::
Parsing this field is implemented such that the runtime key's data may be represented
as a FractionalPercent proto represented as JSON/YAML and may also be represented as an
integer with the assumption that the value is an integral percentage out of 100. For
instance, a runtime key lookup returning the value "42" would parse as a FractionalPercent
whose numerator is 42 and denominator is HUNDRED. This preserves legacy semantics.
.. _envoy_v3_api_field_config.route.v3.RouteMatch.headers:
headers
(:ref:`config.route.v3.HeaderMatcher <envoy_v3_api_msg_config.route.v3.HeaderMatcher>`) Specifies a set of headers that the route should match on. The router will
check the request’s headers against all the specified headers in the route
config. A match will happen if all the headers in the route are present in
the request with the same values (or based on presence if the value field
is not in the config).
.. _envoy_v3_api_field_config.route.v3.RouteMatch.query_parameters:
query_parameters
(:ref:`config.route.v3.QueryParameterMatcher <envoy_v3_api_msg_config.route.v3.QueryParameterMatcher>`) Specifies a set of URL query parameters on which the route should
match. The router will check the query string from the *path* header
against all the specified query parameters. If the number of specified
query parameters is nonzero, they all must match the *path* header's
query string for a match to occur.
.. _envoy_v3_api_field_config.route.v3.RouteMatch.grpc:
grpc
(:ref:`config.route.v3.RouteMatch.GrpcRouteMatchOptions <envoy_v3_api_msg_config.route.v3.RouteMatch.GrpcRouteMatchOptions>`) If specified, only gRPC requests will be matched. The router will check
that the content-type header has a application/grpc or one of the various
application/grpc+ values.
.. _envoy_v3_api_field_config.route.v3.RouteMatch.tls_context:
tls_context
(:ref:`config.route.v3.RouteMatch.TlsContextMatchOptions <envoy_v3_api_msg_config.route.v3.RouteMatch.TlsContextMatchOptions>`) If specified, the client tls context will be matched against the defined
match options.
.. _envoy_v3_api_msg_config.route.v3.RouteMatch.GrpcRouteMatchOptions:
config.route.v3.RouteMatch.GrpcRouteMatchOptions
------------------------------------------------
`[config.route.v3.RouteMatch.GrpcRouteMatchOptions proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L372>`_
.. code-block:: json
{}
.. _envoy_v3_api_msg_config.route.v3.RouteMatch.TlsContextMatchOptions:
config.route.v3.RouteMatch.TlsContextMatchOptions
-------------------------------------------------
`[config.route.v3.RouteMatch.TlsContextMatchOptions proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L377>`_
.. code-block:: json
{
"presented": "{...}",
"validated": "{...}"
}
.. _envoy_v3_api_field_config.route.v3.RouteMatch.TlsContextMatchOptions.presented:
presented
(`BoolValue <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue>`_) If specified, the route will match against whether or not a certificate is presented.
If not specified, certificate presentation status (true or false) will not be considered when route matching.
.. _envoy_v3_api_field_config.route.v3.RouteMatch.TlsContextMatchOptions.validated:
validated
(`BoolValue <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue>`_) If specified, the route will match against whether or not a certificate is validated.
If not specified, certificate validation status (true or false) will not be considered when route matching.
.. _envoy_v3_api_msg_config.route.v3.CorsPolicy:
config.route.v3.CorsPolicy
--------------------------
`[config.route.v3.CorsPolicy proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L469>`_
.. code-block:: json
{
"allow_origin_string_match": [],
"allow_methods": "...",
"allow_headers": "...",
"expose_headers": "...",
"max_age": "...",
"allow_credentials": "{...}",
"filter_enabled": "{...}",
"shadow_enabled": "{...}"
}
.. _envoy_v3_api_field_config.route.v3.CorsPolicy.allow_origin_string_match:
allow_origin_string_match
(:ref:`type.matcher.v3.StringMatcher <envoy_v3_api_msg_type.matcher.v3.StringMatcher>`) Specifies string patterns that match allowed origins. An origin is allowed if any of the
string matchers match.
.. _envoy_v3_api_field_config.route.v3.CorsPolicy.allow_methods:
allow_methods
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Specifies the content for the *access-control-allow-methods* header.
.. _envoy_v3_api_field_config.route.v3.CorsPolicy.allow_headers:
allow_headers
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Specifies the content for the *access-control-allow-headers* header.
.. _envoy_v3_api_field_config.route.v3.CorsPolicy.expose_headers:
expose_headers
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Specifies the content for the *access-control-expose-headers* header.
.. _envoy_v3_api_field_config.route.v3.CorsPolicy.max_age:
max_age
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Specifies the content for the *access-control-max-age* header.
.. _envoy_v3_api_field_config.route.v3.CorsPolicy.allow_credentials:
allow_credentials
(`BoolValue <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue>`_) Specifies whether the resource allows credentials.
.. _envoy_v3_api_field_config.route.v3.CorsPolicy.filter_enabled:
filter_enabled
(:ref:`config.core.v3.RuntimeFractionalPercent <envoy_v3_api_msg_config.core.v3.RuntimeFractionalPercent>`) Specifies the % of requests for which the CORS filter is enabled.
If neither ``enabled``, ``filter_enabled``, nor ``shadow_enabled`` are specified, the CORS
filter will be enabled for 100% of the requests.
If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.runtime_key>` is
specified, Envoy will lookup the runtime key to get the percentage of requests to filter.
.. _envoy_v3_api_field_config.route.v3.CorsPolicy.shadow_enabled:
shadow_enabled
(:ref:`config.core.v3.RuntimeFractionalPercent <envoy_v3_api_msg_config.core.v3.RuntimeFractionalPercent>`) Specifies the % of requests for which the CORS policies will be evaluated and tracked, but not
enforced.
This field is intended to be used when ``filter_enabled`` and ``enabled`` are off. One of those
fields have to explicitly disable the filter in order for this setting to take effect.
If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.runtime_key>` is specified,
Envoy will lookup the runtime key to get the percentage of requests for which it will evaluate
and track the request's *Origin* to determine if it's valid but will not enforce any policies.
.. _envoy_v3_api_msg_config.route.v3.RouteAction:
config.route.v3.RouteAction
---------------------------
`[config.route.v3.RouteAction proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L519>`_
.. code-block:: json
{
"cluster": "...",
"cluster_header": "...",
"weighted_clusters": "{...}",
"cluster_not_found_response_code": "...",
"metadata_match": "{...}",
"prefix_rewrite": "...",
"regex_rewrite": "{...}",
"host_rewrite_literal": "...",
"auto_host_rewrite": "{...}",
"host_rewrite_header": "...",
"timeout": "{...}",
"idle_timeout": "{...}",
"retry_policy": "{...}",
"request_mirror_policies": [],
"priority": "...",
"rate_limits": [],
"include_vh_rate_limits": "{...}",
"hash_policy": [],
"cors": "{...}",
"max_grpc_timeout": "{...}",
"grpc_timeout_offset": "{...}",
"upgrade_configs": [],
"internal_redirect_action": "...",
"max_internal_redirects": "{...}",
"hedge_policy": "{...}"
}
.. _envoy_v3_api_field_config.route.v3.RouteAction.cluster:
cluster
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Indicates the upstream cluster to which the request should be routed
to.
Precisely one of :ref:`cluster <envoy_v3_api_field_config.route.v3.RouteAction.cluster>`, :ref:`cluster_header <envoy_v3_api_field_config.route.v3.RouteAction.cluster_header>`, :ref:`weighted_clusters <envoy_v3_api_field_config.route.v3.RouteAction.weighted_clusters>` must be set.
.. _envoy_v3_api_field_config.route.v3.RouteAction.cluster_header:
cluster_header
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Envoy will determine the cluster to route to by reading the value of the
HTTP header named by cluster_header from the request headers. If the
header is not found or the referenced cluster does not exist, Envoy will
return a 404 response.
.. attention::
Internally, Envoy always uses the HTTP/2 *:authority* header to represent the HTTP/1
*Host* header. Thus, if attempting to match on *Host*, match on *:authority* instead.
Precisely one of :ref:`cluster <envoy_v3_api_field_config.route.v3.RouteAction.cluster>`, :ref:`cluster_header <envoy_v3_api_field_config.route.v3.RouteAction.cluster_header>`, :ref:`weighted_clusters <envoy_v3_api_field_config.route.v3.RouteAction.weighted_clusters>` must be set.
.. _envoy_v3_api_field_config.route.v3.RouteAction.weighted_clusters:
weighted_clusters
(:ref:`config.route.v3.WeightedCluster <envoy_v3_api_msg_config.route.v3.WeightedCluster>`) Multiple upstream clusters can be specified for a given route. The
request is routed to one of the upstream clusters based on weights
assigned to each cluster. See
:ref:`traffic splitting <config_http_conn_man_route_table_traffic_splitting_split>`
for additional documentation.
Precisely one of :ref:`cluster <envoy_v3_api_field_config.route.v3.RouteAction.cluster>`, :ref:`cluster_header <envoy_v3_api_field_config.route.v3.RouteAction.cluster_header>`, :ref:`weighted_clusters <envoy_v3_api_field_config.route.v3.RouteAction.weighted_clusters>` must be set.
.. _envoy_v3_api_field_config.route.v3.RouteAction.cluster_not_found_response_code:
cluster_not_found_response_code
(:ref:`config.route.v3.RouteAction.ClusterNotFoundResponseCode <envoy_v3_api_enum_config.route.v3.RouteAction.ClusterNotFoundResponseCode>`) The HTTP status code to use when configured cluster is not found.
The default response code is 503 Service Unavailable.
.. _envoy_v3_api_field_config.route.v3.RouteAction.metadata_match:
metadata_match
(:ref:`config.core.v3.Metadata <envoy_v3_api_msg_config.core.v3.Metadata>`) Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints
in the upstream cluster with metadata matching what's set in this field will be considered
for load balancing. If using :ref:`weighted_clusters
<envoy_v3_api_field_config.route.v3.RouteAction.weighted_clusters>`, metadata will be merged, with values
provided there taking precedence. The filter name should be specified as *envoy.lb*.
.. _envoy_v3_api_field_config.route.v3.RouteAction.prefix_rewrite:
prefix_rewrite
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Indicates that during forwarding, the matched prefix (or path) should be
swapped with this value. This option allows application URLs to be rooted
at a different path from those exposed at the reverse proxy layer. The router filter will
place the original path before rewrite into the :ref:`x-envoy-original-path
<config_http_filters_router_x-envoy-original-path>` header.
Only one of *prefix_rewrite* or
:ref:`regex_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.regex_rewrite>`
may be specified.
.. attention::
Pay careful attention to the use of trailing slashes in the
:ref:`route's match <envoy_v3_api_field_config.route.v3.Route.match>` prefix value.
Stripping a prefix from a path requires multiple Routes to handle all cases. For example,
rewriting */prefix* to */* and */prefix/etc* to */etc* cannot be done in a single
:ref:`Route <envoy_v3_api_msg_config.route.v3.Route>`, as shown by the below config entries:
.. code-block:: yaml
- match:
prefix: "/prefix/"
route:
prefix_rewrite: "/"
- match:
prefix: "/prefix"
route:
prefix_rewrite: "/"
Having above entries in the config, requests to */prefix* will be stripped to */*, while
requests to */prefix/etc* will be stripped to */etc*.
.. _envoy_v3_api_field_config.route.v3.RouteAction.regex_rewrite:
regex_rewrite
(:ref:`type.matcher.v3.RegexMatchAndSubstitute <envoy_v3_api_msg_type.matcher.v3.RegexMatchAndSubstitute>`) Indicates that during forwarding, portions of the path that match the
pattern should be rewritten, even allowing the substitution of capture
groups from the pattern into the new path as specified by the rewrite
substitution string. This is useful to allow application paths to be
rewritten in a way that is aware of segments with variable content like
identifiers. The router filter will place the original path as it was
before the rewrite into the :ref:`x-envoy-original-path
<config_http_filters_router_x-envoy-original-path>` header.
Only one of :ref:`prefix_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>`
or *regex_rewrite* may be specified.
Examples using Google's `RE2 <https://github.com/google/re2>`_ engine:
* The path pattern ``^/service/([^/]+)(/.*)$`` paired with a substitution
string of ``\2/instance/\1`` would transform ``/service/foo/v1/api``
into ``/v1/api/instance/foo``.
* The pattern ``one`` paired with a substitution string of ``two`` would
transform ``/xxx/one/yyy/one/zzz`` into ``/xxx/two/yyy/two/zzz``.
* The pattern ``^(.*?)one(.*)$`` paired with a substitution string of
``\1two\2`` would replace only the first occurrence of ``one``,
transforming path ``/xxx/one/yyy/one/zzz`` into ``/xxx/two/yyy/one/zzz``.
* The pattern ``(?i)/xxx/`` paired with a substitution string of ``/yyy/``
would do a case-insensitive match and transform path ``/aaa/XxX/bbb`` to
``/aaa/yyy/bbb``.
.. _envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_literal:
host_rewrite_literal
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Indicates that during forwarding, the host header will be swapped with
this value.
Only one of :ref:`host_rewrite_literal <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_literal>`, :ref:`auto_host_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.auto_host_rewrite>`, :ref:`host_rewrite_header <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_header>` may be set.
.. _envoy_v3_api_field_config.route.v3.RouteAction.auto_host_rewrite:
auto_host_rewrite
(`BoolValue <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue>`_) Indicates that during forwarding, the host header will be swapped with
the hostname of the upstream host chosen by the cluster manager. This
option is applicable only when the destination cluster for a route is of
type *strict_dns* or *logical_dns*. Setting this to true with other cluster
types has no effect.
Only one of :ref:`host_rewrite_literal <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_literal>`, :ref:`auto_host_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.auto_host_rewrite>`, :ref:`host_rewrite_header <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_header>` may be set.
.. _envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_header:
host_rewrite_header
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Indicates that during forwarding, the host header will be swapped with the content of given
downstream or :ref:`custom <config_http_conn_man_headers_custom_request_headers>` header.
If header value is empty, host header is left intact.
.. attention::
Pay attention to the potential security implications of using this option. Provided header
must come from trusted source.
Only one of :ref:`host_rewrite_literal <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_literal>`, :ref:`auto_host_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.auto_host_rewrite>`, :ref:`host_rewrite_header <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_header>` may be set.
.. _envoy_v3_api_field_config.route.v3.RouteAction.timeout:
timeout
(`Duration <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration>`_) Specifies the upstream timeout for the route. If not specified, the default is 15s. This
spans between the point at which the entire downstream request (i.e. end-of-stream) has been
processed and when the upstream response has been completely processed. A value of 0 will
disable the route's timeout.
.. note::
This timeout includes all retries. See also
:ref:`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`,
:ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms`, and the
:ref:`retry overview <arch_overview_http_routing_retry>`.
.. _envoy_v3_api_field_config.route.v3.RouteAction.idle_timeout:
idle_timeout
(`Duration <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration>`_) Specifies the idle timeout for the route. If not specified, there is no per-route idle timeout,
although the connection manager wide :ref:`stream_idle_timeout
<envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.stream_idle_timeout>`
will still apply. A value of 0 will completely disable the route's idle timeout, even if a
connection manager stream idle timeout is configured.
The idle timeout is distinct to :ref:`timeout
<envoy_v3_api_field_config.route.v3.RouteAction.timeout>`, which provides an upper bound
on the upstream response time; :ref:`idle_timeout
<envoy_v3_api_field_config.route.v3.RouteAction.idle_timeout>` instead bounds the amount
of time the request's stream may be idle.
After header decoding, the idle timeout will apply on downstream and
upstream request events. Each time an encode/decode event for headers or
data is processed for the stream, the timer will be reset. If the timeout
fires, the stream is terminated with a 408 Request Timeout error code if no
upstream response header has been received, otherwise a stream reset
occurs.
.. _envoy_v3_api_field_config.route.v3.RouteAction.retry_policy:
retry_policy
(:ref:`config.route.v3.RetryPolicy <envoy_v3_api_msg_config.route.v3.RetryPolicy>`) Indicates that the route has a retry policy. Note that if this is set,
it'll take precedence over the virtual host level retry policy entirely
(e.g.: policies are not merged, most internal one becomes the enforced policy).
.. _envoy_v3_api_field_config.route.v3.RouteAction.request_mirror_policies:
request_mirror_policies
(:ref:`config.route.v3.RouteAction.RequestMirrorPolicy <envoy_v3_api_msg_config.route.v3.RouteAction.RequestMirrorPolicy>`) Indicates that the route has request mirroring policies.
.. _envoy_v3_api_field_config.route.v3.RouteAction.priority:
priority
(:ref:`config.core.v3.RoutingPriority <envoy_v3_api_enum_config.core.v3.RoutingPriority>`) Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
.. _envoy_v3_api_field_config.route.v3.RouteAction.rate_limits:
rate_limits
(:ref:`config.route.v3.RateLimit <envoy_v3_api_msg_config.route.v3.RateLimit>`) Specifies a set of rate limit configurations that could be applied to the
route.
.. _envoy_v3_api_field_config.route.v3.RouteAction.include_vh_rate_limits:
include_vh_rate_limits
(`BoolValue <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue>`_) Specifies if the rate limit filter should include the virtual host rate
limits. By default, if the route configured rate limits, the virtual host
:ref:`rate_limits <envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>` are not applied to the
request.
.. _envoy_v3_api_field_config.route.v3.RouteAction.hash_policy:
hash_policy
(:ref:`config.route.v3.RouteAction.HashPolicy <envoy_v3_api_msg_config.route.v3.RouteAction.HashPolicy>`) Specifies a list of hash policies to use for ring hash load balancing. Each
hash policy is evaluated individually and the combined result is used to
route the request. The method of combination is deterministic such that
identical lists of hash policies will produce the same hash. Since a hash
policy examines specific parts of a request, it can fail to produce a hash
(i.e. if the hashed header is not present). If (and only if) all configured
hash policies fail to generate a hash, no hash will be produced for
the route. In this case, the behavior is the same as if no hash policies
were specified (i.e. the ring hash load balancer will choose a random
backend). If a hash policy has the "terminal" attribute set to true, and
there is already a hash generated, the hash is returned immediately,
ignoring the rest of the hash policy list.
.. _envoy_v3_api_field_config.route.v3.RouteAction.cors:
cors
(:ref:`config.route.v3.CorsPolicy <envoy_v3_api_msg_config.route.v3.CorsPolicy>`) Indicates that the route has a CORS policy.
.. _envoy_v3_api_field_config.route.v3.RouteAction.max_grpc_timeout:
max_grpc_timeout
(`Duration <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration>`_) If present, and the request is a gRPC request, use the
`grpc-timeout header <https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md>`_,
or its default value (infinity) instead of
:ref:`timeout <envoy_v3_api_field_config.route.v3.RouteAction.timeout>`, but limit the applied timeout
to the maximum value specified here. If configured as 0, the maximum allowed timeout for
gRPC requests is infinity. If not configured at all, the `grpc-timeout` header is not used
and gRPC requests time out like any other requests using
:ref:`timeout <envoy_v3_api_field_config.route.v3.RouteAction.timeout>` or its default.
This can be used to prevent unexpected upstream request timeouts due to potentially long
time gaps between gRPC request and response in gRPC streaming mode.
.. note::
If a timeout is specified using :ref:`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`, it takes
precedence over `grpc-timeout header <https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md>`_, when
both are present. See also
:ref:`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`,
:ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms`, and the
:ref:`retry overview <arch_overview_http_routing_retry>`.
.. _envoy_v3_api_field_config.route.v3.RouteAction.grpc_timeout_offset:
grpc_timeout_offset
(`Duration <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration>`_) If present, Envoy will adjust the timeout provided by the `grpc-timeout` header by subtracting
the provided duration from the header. This is useful in allowing Envoy to set its global
timeout to be less than that of the deadline imposed by the calling client, which makes it more
likely that Envoy will handle the timeout instead of having the call canceled by the client.
The offset will only be applied if the provided grpc_timeout is greater than the offset. This
ensures that the offset will only ever decrease the timeout and never set it to 0 (meaning
infinity).
.. _envoy_v3_api_field_config.route.v3.RouteAction.upgrade_configs:
upgrade_configs
(:ref:`config.route.v3.RouteAction.UpgradeConfig <envoy_v3_api_msg_config.route.v3.RouteAction.UpgradeConfig>`)
.. _envoy_v3_api_field_config.route.v3.RouteAction.internal_redirect_action:
internal_redirect_action
(:ref:`config.route.v3.RouteAction.InternalRedirectAction <envoy_v3_api_enum_config.route.v3.RouteAction.InternalRedirectAction>`)
.. _envoy_v3_api_field_config.route.v3.RouteAction.max_internal_redirects:
max_internal_redirects
(`UInt32Value <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#uint32value>`_) An internal redirect is handled, iff the number of previous internal redirects that a
downstream request has encountered is lower than this value, and
:ref:`internal_redirect_action <envoy_v3_api_field_config.route.v3.RouteAction.internal_redirect_action>`
is set to :ref:`HANDLE_INTERNAL_REDIRECT
<envoy_v3_api_enum_value_config.route.v3.RouteAction.InternalRedirectAction.HANDLE_INTERNAL_REDIRECT>`
In the case where a downstream request is bounced among multiple routes by internal redirect,
the first route that hits this threshold, or has
:ref:`internal_redirect_action <envoy_v3_api_field_config.route.v3.RouteAction.internal_redirect_action>`
set to
:ref:`PASS_THROUGH_INTERNAL_REDIRECT
<envoy_v3_api_enum_value_config.route.v3.RouteAction.InternalRedirectAction.PASS_THROUGH_INTERNAL_REDIRECT>`
will pass the redirect back to downstream.
If not specified, at most one redirect will be followed.
.. _envoy_v3_api_field_config.route.v3.RouteAction.hedge_policy:
hedge_policy
(:ref:`config.route.v3.HedgePolicy <envoy_v3_api_msg_config.route.v3.HedgePolicy>`) Indicates that the route has a hedge policy. Note that if this is set,
it'll take precedence over the virtual host level hedge policy entirely
(e.g.: policies are not merged, most internal one becomes the enforced policy).
.. _envoy_v3_api_msg_config.route.v3.RouteAction.RequestMirrorPolicy:
config.route.v3.RouteAction.RequestMirrorPolicy
-----------------------------------------------
`[config.route.v3.RouteAction.RequestMirrorPolicy proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L547>`_
The router is capable of shadowing traffic from one cluster to another. The current
implementation is "fire and forget," meaning Envoy will not wait for the shadow cluster to
respond before returning the response from the primary cluster. All normal statistics are
collected for the shadow cluster making this feature useful for testing.
During shadowing, the host/authority header is altered such that *-shadow* is appended. This is
useful for logging. For example, *cluster1* becomes *cluster1-shadow*.
.. note::
Shadowing will not be triggered if the primary cluster does not exist.
.. code-block:: json
{
"cluster": "...",
"runtime_fraction": "{...}",
"trace_sampled": "{...}"
}
.. _envoy_v3_api_field_config.route.v3.RouteAction.RequestMirrorPolicy.cluster:
cluster
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) Specifies the cluster that requests will be mirrored to. The cluster must
exist in the cluster manager configuration.
.. _envoy_v3_api_field_config.route.v3.RouteAction.RequestMirrorPolicy.runtime_fraction:
runtime_fraction
(:ref:`config.core.v3.RuntimeFractionalPercent <envoy_v3_api_msg_config.core.v3.RuntimeFractionalPercent>`) If not specified, all requests to the target cluster will be mirrored.
If specified, this field takes precedence over the `runtime_key` field and requests must also
fall under the percentage of matches indicated by this field.
For some fraction N/D, a random number in the range [0,D) is selected. If the
number is <= the value of the numerator N, or if the key is not present, the default
value, the request will be mirrored.
.. _envoy_v3_api_field_config.route.v3.RouteAction.RequestMirrorPolicy.trace_sampled:
trace_sampled
(`BoolValue <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue>`_) Determines if the trace span should be sampled. Defaults to true.
.. _envoy_v3_api_msg_config.route.v3.RouteAction.HashPolicy:
config.route.v3.RouteAction.HashPolicy
--------------------------------------
`[config.route.v3.RouteAction.HashPolicy proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L576>`_
Specifies the route's hashing policy if the upstream cluster uses a hashing :ref:`load balancer
<arch_overview_load_balancing_types>`.
.. code-block:: json
{
"header": "{...}",
"cookie": "{...}",
"connection_properties": "{...}",
"query_parameter": "{...}",
"filter_state": "{...}",
"terminal": "..."
}
.. _envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.header:
header
(:ref:`config.route.v3.RouteAction.HashPolicy.Header <envoy_v3_api_msg_config.route.v3.RouteAction.HashPolicy.Header>`) Header hash policy.
Precisely one of :ref:`header <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.header>`, :ref:`cookie <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.cookie>`, :ref:`connection_properties <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.connection_properties>`, :ref:`query_parameter <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.query_parameter>`, :ref:`filter_state <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.filter_state>` must be set.
.. _envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.cookie:
cookie
(:ref:`config.route.v3.RouteAction.HashPolicy.Cookie <envoy_v3_api_msg_config.route.v3.RouteAction.HashPolicy.Cookie>`) Cookie hash policy.
Precisely one of :ref:`header <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.header>`, :ref:`cookie <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.cookie>`, :ref:`connection_properties <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.connection_properties>`, :ref:`query_parameter <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.query_parameter>`, :ref:`filter_state <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.filter_state>` must be set.
.. _envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.connection_properties:
connection_properties
(:ref:`config.route.v3.RouteAction.HashPolicy.ConnectionProperties <envoy_v3_api_msg_config.route.v3.RouteAction.HashPolicy.ConnectionProperties>`) Connection properties hash policy.
Precisely one of :ref:`header <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.header>`, :ref:`cookie <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.cookie>`, :ref:`connection_properties <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.connection_properties>`, :ref:`query_parameter <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.query_parameter>`, :ref:`filter_state <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.filter_state>` must be set.
.. _envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.query_parameter:
query_parameter
(:ref:`config.route.v3.RouteAction.HashPolicy.QueryParameter <envoy_v3_api_msg_config.route.v3.RouteAction.HashPolicy.QueryParameter>`) Query parameter hash policy.
Precisely one of :ref:`header <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.header>`, :ref:`cookie <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.cookie>`, :ref:`connection_properties <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.connection_properties>`, :ref:`query_parameter <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.query_parameter>`, :ref:`filter_state <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.filter_state>` must be set.
.. _envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.filter_state:
filter_state
(:ref:`config.route.v3.RouteAction.HashPolicy.FilterState <envoy_v3_api_msg_config.route.v3.RouteAction.HashPolicy.FilterState>`) Filter state hash policy.
Precisely one of :ref:`header <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.header>`, :ref:`cookie <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.cookie>`, :ref:`connection_properties <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.connection_properties>`, :ref:`query_parameter <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.query_parameter>`, :ref:`filter_state <envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.filter_state>` must be set.
.. _envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.terminal:
terminal
(`bool <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) The flag that short-circuits the hash computing. This field provides a
'fallback' style of configuration: "if a terminal policy doesn't work,
fallback to rest of the policy list", it saves time when the terminal
policy works.
If true, and there is already a hash computed, ignore rest of the
list of hash polices.
For example, if the following hash methods are configured:
========= ========
specifier terminal
========= ========
Header A true
Header B false
Header C false
========= ========
The generateHash process ends if policy "header A" generates a hash, as
it's a terminal policy.
.. _envoy_v3_api_msg_config.route.v3.RouteAction.HashPolicy.Header:
config.route.v3.RouteAction.HashPolicy.Header
---------------------------------------------
`[config.route.v3.RouteAction.HashPolicy.Header proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L580>`_
.. code-block:: json
{
"header_name": "..."
}
.. _envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.Header.header_name:
header_name
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) The name of the request header that will be used to obtain the hash
key. If the request header is not present, no hash will be produced.
.. _envoy_v3_api_msg_config.route.v3.RouteAction.HashPolicy.Cookie:
config.route.v3.RouteAction.HashPolicy.Cookie
---------------------------------------------
`[config.route.v3.RouteAction.HashPolicy.Cookie proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L605>`_
Envoy supports two types of cookie affinity:
1. Passive. Envoy takes a cookie that's present in the cookies header and
hashes on its value.
2. Generated. Envoy generates and sets a cookie with an expiration (TTL)
on the first request from the client in its response to the client,
based on the endpoint the request gets sent to. The client then
presents this on the next and all subsequent requests. The hash of
this is sufficient to ensure these requests get sent to the same
endpoint. The cookie is generated by hashing the source and
destination ports and addresses so that multiple independent HTTP2
streams on the same connection will independently receive the same
cookie, even if they arrive at the Envoy simultaneously.
.. code-block:: json
{
"name": "...",
"ttl": "{...}",
"path": "..."
}
.. _envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.Cookie.name:
name
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) The name of the cookie that will be used to obtain the hash key. If the
cookie is not present and ttl below is not set, no hash will be
produced.
.. _envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.Cookie.ttl:
ttl
(`Duration <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration>`_) If specified, a cookie with the TTL will be generated if the cookie is
not present. If the TTL is present and zero, the generated cookie will
be a session cookie.
.. _envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.Cookie.path:
path
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) The name of the path for the cookie. If no path is specified here, no path
will be set for the cookie.
.. _envoy_v3_api_msg_config.route.v3.RouteAction.HashPolicy.ConnectionProperties:
config.route.v3.RouteAction.HashPolicy.ConnectionProperties
-----------------------------------------------------------
`[config.route.v3.RouteAction.HashPolicy.ConnectionProperties proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L624>`_
.. code-block:: json
{
"source_ip": "..."
}
.. _envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.ConnectionProperties.source_ip:
source_ip
(`bool <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Hash on source IP address.
.. _envoy_v3_api_msg_config.route.v3.RouteAction.HashPolicy.QueryParameter:
config.route.v3.RouteAction.HashPolicy.QueryParameter
-----------------------------------------------------
`[config.route.v3.RouteAction.HashPolicy.QueryParameter proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L632>`_
.. code-block:: json
{
"name": "..."
}
.. _envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.QueryParameter.name:
name
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) The name of the URL query parameter that will be used to obtain the hash
key. If the parameter is not present, no hash will be produced. Query
parameter names are case-sensitive.
.. _envoy_v3_api_msg_config.route.v3.RouteAction.HashPolicy.FilterState:
config.route.v3.RouteAction.HashPolicy.FilterState
--------------------------------------------------
`[config.route.v3.RouteAction.HashPolicy.FilterState proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L642>`_
.. code-block:: json
{
"key": "..."
}
.. _envoy_v3_api_field_config.route.v3.RouteAction.HashPolicy.FilterState.key:
key
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) The name of the Object in the per-request filterState, which is an
Envoy::Http::Hashable object. If there is no data associated with the key,
or the stored object is not Envoy::Http::Hashable, no hash will be produced.
.. _envoy_v3_api_msg_config.route.v3.RouteAction.UpgradeConfig:
config.route.v3.RouteAction.UpgradeConfig
-----------------------------------------
`[config.route.v3.RouteAction.UpgradeConfig proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L699>`_
Allows enabling and disabling upgrades on a per-route basis.
This overrides any enabled/disabled upgrade filter chain specified in the
HttpConnectionManager
:ref:`upgrade_configs
<envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.upgrade_configs>`
but does not affect any custom filter chain specified there.
.. code-block:: json
{
"upgrade_type": "...",
"enabled": "{...}"
}
.. _envoy_v3_api_field_config.route.v3.RouteAction.UpgradeConfig.upgrade_type:
upgrade_type
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) The case-insensitive name of this upgrade, e.g. "websocket".
For each upgrade type present in upgrade_configs, requests with
Upgrade: [upgrade_type] will be proxied upstream.
.. _envoy_v3_api_field_config.route.v3.RouteAction.UpgradeConfig.enabled:
enabled
(`BoolValue <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue>`_) Determines if upgrades are available on this route. Defaults to true.
.. _envoy_v3_api_enum_config.route.v3.RouteAction.ClusterNotFoundResponseCode:
Enum config.route.v3.RouteAction.ClusterNotFoundResponseCode
------------------------------------------------------------
`[config.route.v3.RouteAction.ClusterNotFoundResponseCode proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L522>`_
.. _envoy_v3_api_enum_value_config.route.v3.RouteAction.ClusterNotFoundResponseCode.SERVICE_UNAVAILABLE:
SERVICE_UNAVAILABLE
*(DEFAULT)* HTTP status code - 503 Service Unavailable.
.. _envoy_v3_api_enum_value_config.route.v3.RouteAction.ClusterNotFoundResponseCode.NOT_FOUND:
NOT_FOUND
HTTP status code - 404 Not Found.
.. _envoy_v3_api_enum_config.route.v3.RouteAction.InternalRedirectAction:
Enum config.route.v3.RouteAction.InternalRedirectAction
-------------------------------------------------------
`[config.route.v3.RouteAction.InternalRedirectAction proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L531>`_
Configures :ref:`internal redirect <arch_overview_internal_redirects>` behavior.
.. _envoy_v3_api_enum_value_config.route.v3.RouteAction.InternalRedirectAction.PASS_THROUGH_INTERNAL_REDIRECT:
PASS_THROUGH_INTERNAL_REDIRECT
*(DEFAULT)*
.. _envoy_v3_api_enum_value_config.route.v3.RouteAction.InternalRedirectAction.HANDLE_INTERNAL_REDIRECT:
HANDLE_INTERNAL_REDIRECT
.. _envoy_v3_api_msg_config.route.v3.RetryPolicy:
config.route.v3.RetryPolicy
---------------------------
`[config.route.v3.RetryPolicy proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L981>`_
HTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`.
.. code-block:: json
{
"retry_on": "...",
"num_retries": "{...}",
"per_try_timeout": "{...}",
"retry_priority": "{...}",
"retry_host_predicate": [],
"host_selection_retry_max_attempts": "...",
"retriable_status_codes": [],
"retry_back_off": "{...}",
"retriable_headers": [],
"retriable_request_headers": []
}
.. _envoy_v3_api_field_config.route.v3.RetryPolicy.retry_on:
retry_on
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Specifies the conditions under which retry takes place. These are the same
conditions documented for :ref:`config_http_filters_router_x-envoy-retry-on` and
:ref:`config_http_filters_router_x-envoy-retry-grpc-on`.
.. _envoy_v3_api_field_config.route.v3.RetryPolicy.num_retries:
num_retries
(`UInt32Value <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#uint32value>`_) Specifies the allowed number of retries. This parameter is optional and
defaults to 1. These are the same conditions documented for
:ref:`config_http_filters_router_x-envoy-max-retries`.
.. _envoy_v3_api_field_config.route.v3.RetryPolicy.per_try_timeout:
per_try_timeout
(`Duration <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration>`_) Specifies a non-zero upstream timeout per retry attempt. This parameter is optional. The
same conditions documented for
:ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms` apply.
.. note::
If left unspecified, Envoy will use the global
:ref:`route timeout <envoy_v3_api_field_config.route.v3.RouteAction.timeout>` for the request.
Consequently, when using a :ref:`5xx <config_http_filters_router_x-envoy-retry-on>` based
retry policy, a request that times out will not be retried as the total timeout budget
would have been exhausted.
.. _envoy_v3_api_field_config.route.v3.RetryPolicy.retry_priority:
retry_priority
(:ref:`config.route.v3.RetryPolicy.RetryPriority <envoy_v3_api_msg_config.route.v3.RetryPolicy.RetryPriority>`) Specifies an implementation of a RetryPriority which is used to determine the
distribution of load across priorities used for retries. Refer to
:ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more details.
.. _envoy_v3_api_field_config.route.v3.RetryPolicy.retry_host_predicate:
retry_host_predicate
(:ref:`config.route.v3.RetryPolicy.RetryHostPredicate <envoy_v3_api_msg_config.route.v3.RetryPolicy.RetryHostPredicate>`) Specifies a collection of RetryHostPredicates that will be consulted when selecting a host
for retries. If any of the predicates reject the host, host selection will be reattempted.
Refer to :ref:`retry plugin configuration <arch_overview_http_retry_plugins>` for more
details.
.. _envoy_v3_api_field_config.route.v3.RetryPolicy.host_selection_retry_max_attempts:
host_selection_retry_max_attempts
(`int64 <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) The maximum number of times host selection will be reattempted before giving up, at which
point the host that was last selected will be routed to. If unspecified, this will default to
retrying once.
.. _envoy_v3_api_field_config.route.v3.RetryPolicy.retriable_status_codes:
retriable_status_codes
(`uint32 <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) HTTP status codes that should trigger a retry in addition to those specified by retry_on.
.. _envoy_v3_api_field_config.route.v3.RetryPolicy.retry_back_off:
retry_back_off
(:ref:`config.route.v3.RetryPolicy.RetryBackOff <envoy_v3_api_msg_config.route.v3.RetryPolicy.RetryBackOff>`) Specifies parameters that control retry back off. This parameter is optional, in which case the
default base interval is 25 milliseconds or, if set, the current value of the
`upstream.base_retry_backoff_ms` runtime parameter. The default maximum interval is 10 times
the base interval. The documentation for :ref:`config_http_filters_router_x-envoy-max-retries`
describes Envoy's back-off algorithm.
.. _envoy_v3_api_field_config.route.v3.RetryPolicy.retriable_headers:
retriable_headers
(:ref:`config.route.v3.HeaderMatcher <envoy_v3_api_msg_config.route.v3.HeaderMatcher>`) HTTP response headers that trigger a retry if present in the response. A retry will be
triggered if any of the header matches match the upstream response headers.
The field is only consulted if 'retriable-headers' retry policy is active.
.. _envoy_v3_api_field_config.route.v3.RetryPolicy.retriable_request_headers:
retriable_request_headers
(:ref:`config.route.v3.HeaderMatcher <envoy_v3_api_msg_config.route.v3.HeaderMatcher>`) HTTP headers which must be present in the request for retries to be attempted.
.. _envoy_v3_api_msg_config.route.v3.RetryPolicy.RetryPriority:
config.route.v3.RetryPolicy.RetryPriority
-----------------------------------------
`[config.route.v3.RetryPolicy.RetryPriority proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L984>`_
.. code-block:: json
{
"name": "...",
"typed_config": "{...}"
}
.. _envoy_v3_api_field_config.route.v3.RetryPolicy.RetryPriority.name:
name
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*)
.. _envoy_v3_api_field_config.route.v3.RetryPolicy.RetryPriority.typed_config:
typed_config
(`Any <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#any>`_)
.. _envoy_v3_api_msg_config.route.v3.RetryPolicy.RetryHostPredicate:
config.route.v3.RetryPolicy.RetryHostPredicate
----------------------------------------------
`[config.route.v3.RetryPolicy.RetryHostPredicate proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L999>`_
.. code-block:: json
{
"name": "...",
"typed_config": "{...}"
}
.. _envoy_v3_api_field_config.route.v3.RetryPolicy.RetryHostPredicate.name:
name
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*)
.. _envoy_v3_api_field_config.route.v3.RetryPolicy.RetryHostPredicate.typed_config:
typed_config
(`Any <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#any>`_)
.. _envoy_v3_api_msg_config.route.v3.RetryPolicy.RetryBackOff:
config.route.v3.RetryPolicy.RetryBackOff
----------------------------------------
`[config.route.v3.RetryPolicy.RetryBackOff proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1014>`_
.. code-block:: json
{
"base_interval": "{...}",
"max_interval": "{...}"
}
.. _envoy_v3_api_field_config.route.v3.RetryPolicy.RetryBackOff.base_interval:
base_interval
(`Duration <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration>`_, *REQUIRED*) Specifies the base interval between retries. This parameter is required and must be greater
than zero. Values less than 1 ms are rounded up to 1 ms.
See :ref:`config_http_filters_router_x-envoy-max-retries` for a discussion of Envoy's
back-off algorithm.
.. _envoy_v3_api_field_config.route.v3.RetryPolicy.RetryBackOff.max_interval:
max_interval
(`Duration <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration>`_) Specifies the maximum interval between retries. This parameter is optional, but must be
greater than or equal to the `base_interval` if set. The default is 10 times the
`base_interval`. See :ref:`config_http_filters_router_x-envoy-max-retries` for a discussion
of Envoy's back-off algorithm.
.. _envoy_v3_api_msg_config.route.v3.HedgePolicy:
config.route.v3.HedgePolicy
---------------------------
`[config.route.v3.HedgePolicy proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1093>`_
HTTP request hedging :ref:`architecture overview <arch_overview_http_routing_hedging>`.
.. code-block:: json
{
"hedge_on_per_try_timeout": "..."
}
.. _envoy_v3_api_field_config.route.v3.HedgePolicy.hedge_on_per_try_timeout:
hedge_on_per_try_timeout
(`bool <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Indicates that a hedged request should be sent when the per-try timeout
is hit. This will only occur if the retry policy also indicates that a
timed out request should be retried.
Once a timed out request is retried due to per try timeout, the router
filter will ensure that it is not retried again even if the returned
response headers would otherwise be retried according the specified
:ref:`RetryPolicy <envoy_v3_api_msg_config.route.v3.RetryPolicy>`.
Defaults to false.
.. _envoy_v3_api_msg_config.route.v3.RedirectAction:
config.route.v3.RedirectAction
------------------------------
`[config.route.v3.RedirectAction proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1120>`_
.. code-block:: json
{
"https_redirect": "...",
"scheme_redirect": "...",
"host_redirect": "...",
"port_redirect": "...",
"path_redirect": "...",
"prefix_rewrite": "...",
"response_code": "...",
"strip_query": "..."
}
.. _envoy_v3_api_field_config.route.v3.RedirectAction.https_redirect:
https_redirect
(`bool <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) The scheme portion of the URL will be swapped with "https".
When the scheme redirection take place, the following rules apply:
1. If the source URI scheme is `http` and the port is explicitly
set to `:80`, the port will be removed after the redirection
2. If the source URI scheme is `https` and the port is explicitly
set to `:443`, the port will be removed after the redirection
Only one of :ref:`https_redirect <envoy_v3_api_field_config.route.v3.RedirectAction.https_redirect>`, :ref:`scheme_redirect <envoy_v3_api_field_config.route.v3.RedirectAction.scheme_redirect>` may be set.
.. _envoy_v3_api_field_config.route.v3.RedirectAction.scheme_redirect:
scheme_redirect
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) The scheme portion of the URL will be swapped with this value.
When the scheme redirection take place, the following rules apply:
1. If the source URI scheme is `http` and the port is explicitly
set to `:80`, the port will be removed after the redirection
2. If the source URI scheme is `https` and the port is explicitly
set to `:443`, the port will be removed after the redirection
Only one of :ref:`https_redirect <envoy_v3_api_field_config.route.v3.RedirectAction.https_redirect>`, :ref:`scheme_redirect <envoy_v3_api_field_config.route.v3.RedirectAction.scheme_redirect>` may be set.
.. _envoy_v3_api_field_config.route.v3.RedirectAction.host_redirect:
host_redirect
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) The host portion of the URL will be swapped with this value.
.. _envoy_v3_api_field_config.route.v3.RedirectAction.port_redirect:
port_redirect
(`uint32 <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) The port value of the URL will be swapped with this value.
.. _envoy_v3_api_field_config.route.v3.RedirectAction.path_redirect:
path_redirect
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) The path portion of the URL will be swapped with this value.
Only one of :ref:`path_redirect <envoy_v3_api_field_config.route.v3.RedirectAction.path_redirect>`, :ref:`prefix_rewrite <envoy_v3_api_field_config.route.v3.RedirectAction.prefix_rewrite>` may be set.
.. _envoy_v3_api_field_config.route.v3.RedirectAction.prefix_rewrite:
prefix_rewrite
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Indicates that during redirection, the matched prefix (or path)
should be swapped with this value. This option allows redirect URLs be dynamically created
based on the request.
.. attention::
Pay attention to the use of trailing slashes as mentioned in
:ref:`RouteAction's prefix_rewrite <envoy_v3_api_field_config.route.v3.RouteAction.prefix_rewrite>`.
Only one of :ref:`path_redirect <envoy_v3_api_field_config.route.v3.RedirectAction.path_redirect>`, :ref:`prefix_rewrite <envoy_v3_api_field_config.route.v3.RedirectAction.prefix_rewrite>` may be set.
.. _envoy_v3_api_field_config.route.v3.RedirectAction.response_code:
response_code
(:ref:`config.route.v3.RedirectAction.RedirectResponseCode <envoy_v3_api_enum_config.route.v3.RedirectAction.RedirectResponseCode>`) The HTTP status code to use in the redirect response. The default response
code is MOVED_PERMANENTLY (301).
.. _envoy_v3_api_field_config.route.v3.RedirectAction.strip_query:
strip_query
(`bool <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Indicates that during redirection, the query portion of the URL will
be removed. Default value is false.
.. _envoy_v3_api_enum_config.route.v3.RedirectAction.RedirectResponseCode:
Enum config.route.v3.RedirectAction.RedirectResponseCode
--------------------------------------------------------
`[config.route.v3.RedirectAction.RedirectResponseCode proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1123>`_
.. _envoy_v3_api_enum_value_config.route.v3.RedirectAction.RedirectResponseCode.MOVED_PERMANENTLY:
MOVED_PERMANENTLY
*(DEFAULT)* Moved Permanently HTTP Status Code - 301.
.. _envoy_v3_api_enum_value_config.route.v3.RedirectAction.RedirectResponseCode.FOUND:
FOUND
Found HTTP Status Code - 302.
.. _envoy_v3_api_enum_value_config.route.v3.RedirectAction.RedirectResponseCode.SEE_OTHER:
SEE_OTHER
See Other HTTP Status Code - 303.
.. _envoy_v3_api_enum_value_config.route.v3.RedirectAction.RedirectResponseCode.TEMPORARY_REDIRECT:
TEMPORARY_REDIRECT
Temporary Redirect HTTP Status Code - 307.
.. _envoy_v3_api_enum_value_config.route.v3.RedirectAction.RedirectResponseCode.PERMANENT_REDIRECT:
PERMANENT_REDIRECT
Permanent Redirect HTTP Status Code - 308.
.. _envoy_v3_api_msg_config.route.v3.DirectResponseAction:
config.route.v3.DirectResponseAction
------------------------------------
`[config.route.v3.DirectResponseAction proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1186>`_
.. code-block:: json
{
"status": "...",
"body": "{...}"
}
.. _envoy_v3_api_field_config.route.v3.DirectResponseAction.status:
status
(`uint32 <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Specifies the HTTP response status to be returned.
.. _envoy_v3_api_field_config.route.v3.DirectResponseAction.body:
body
(:ref:`config.core.v3.DataSource <envoy_v3_api_msg_config.core.v3.DataSource>`) Specifies the content of the response body. If this setting is omitted,
no body is included in the generated response.
.. note::
Headers can be specified using *response_headers_to_add* in the enclosing
:ref:`envoy_v3_api_msg_config.route.v3.Route`, :ref:`envoy_v3_api_msg_config.route.v3.RouteConfiguration` or
:ref:`envoy_v3_api_msg_config.route.v3.VirtualHost`.
.. _envoy_v3_api_msg_config.route.v3.Decorator:
config.route.v3.Decorator
-------------------------
`[config.route.v3.Decorator proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1204>`_
.. code-block:: json
{
"operation": "...",
"propagate": "{...}"
}
.. _envoy_v3_api_field_config.route.v3.Decorator.operation:
operation
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) The operation name associated with the request matched to this route. If tracing is
enabled, this information will be used as the span name reported for this request.
.. note::
For ingress (inbound) requests, or egress (outbound) responses, this value may be overridden
by the :ref:`x-envoy-decorator-operation
<config_http_filters_router_x-envoy-decorator-operation>` header.
.. _envoy_v3_api_field_config.route.v3.Decorator.propagate:
propagate
(`BoolValue <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue>`_) Whether the decorated details should be propagated to the other party. The default is true.
.. _envoy_v3_api_msg_config.route.v3.Tracing:
config.route.v3.Tracing
-----------------------
`[config.route.v3.Tracing proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1221>`_
.. code-block:: json
{
"client_sampling": "{...}",
"random_sampling": "{...}",
"overall_sampling": "{...}",
"custom_tags": []
}
.. _envoy_v3_api_field_config.route.v3.Tracing.client_sampling:
client_sampling
(:ref:`type.v3.FractionalPercent <envoy_v3_api_msg_type.v3.FractionalPercent>`) Target percentage of requests managed by this HTTP connection manager that will be force
traced if the :ref:`x-client-trace-id <config_http_conn_man_headers_x-client-trace-id>`
header is set. This field is a direct analog for the runtime variable
'tracing.client_sampling' in the :ref:`HTTP Connection Manager
<config_http_conn_man_runtime>`.
Default: 100%
.. _envoy_v3_api_field_config.route.v3.Tracing.random_sampling:
random_sampling
(:ref:`type.v3.FractionalPercent <envoy_v3_api_msg_type.v3.FractionalPercent>`) Target percentage of requests managed by this HTTP connection manager that will be randomly
selected for trace generation, if not requested by the client or not forced. This field is
a direct analog for the runtime variable 'tracing.random_sampling' in the
:ref:`HTTP Connection Manager <config_http_conn_man_runtime>`.
Default: 100%
.. _envoy_v3_api_field_config.route.v3.Tracing.overall_sampling:
overall_sampling
(:ref:`type.v3.FractionalPercent <envoy_v3_api_msg_type.v3.FractionalPercent>`) Target percentage of requests managed by this HTTP connection manager that will be traced
after all other sampling checks have been applied (client-directed, force tracing, random
sampling). This field functions as an upper limit on the total configured sampling rate. For
instance, setting client_sampling to 100% but overall_sampling to 1% will result in only 1%
of client requests with the appropriate headers to be force traced. This field is a direct
analog for the runtime variable 'tracing.global_enabled' in the
:ref:`HTTP Connection Manager <config_http_conn_man_runtime>`.
Default: 100%
.. _envoy_v3_api_field_config.route.v3.Tracing.custom_tags:
custom_tags
(:ref:`type.tracing.v3.CustomTag <envoy_v3_api_msg_type.tracing.v3.CustomTag>`) A list of custom tags with unique tag name to create tags for the active span.
It will take effect after merging with the :ref:`corresponding configuration
<envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.custom_tags>`
configured in the HTTP connection manager. If two tags with the same name are configured
each in the HTTP connection manager and the route level, the one configured here takes
priority.
.. _envoy_v3_api_msg_config.route.v3.VirtualCluster:
config.route.v3.VirtualCluster
------------------------------
`[config.route.v3.VirtualCluster proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1275>`_
A virtual cluster is a way of specifying a regex matching rule against
certain important endpoints such that statistics are generated explicitly for
the matched requests. The reason this is useful is that when doing
prefix/path matching Envoy does not always know what the application
considers to be an endpoint. Thus, it’s impossible for Envoy to generically
emit per endpoint statistics. However, often systems have highly critical
endpoints that they wish to get “perfect” statistics on. Virtual cluster
statistics are perfect in the sense that they are emitted on the downstream
side such that they include network level failures.
Documentation for :ref:`virtual cluster statistics <config_http_filters_router_vcluster_stats>`.
.. note::
Virtual clusters are a useful tool, but we do not recommend setting up a virtual cluster for
every application endpoint. This is both not easily maintainable and as well the matching and
statistics output are not free.
.. code-block:: json
{
"headers": [],
"name": "..."
}
.. _envoy_v3_api_field_config.route.v3.VirtualCluster.headers:
headers
(:ref:`config.route.v3.HeaderMatcher <envoy_v3_api_msg_config.route.v3.HeaderMatcher>`) Specifies a list of header matchers to use for matching requests. Each specified header must
match. The pseudo-headers `:path` and `:method` can be used to match the request path and
method, respectively.
.. _envoy_v3_api_field_config.route.v3.VirtualCluster.name:
name
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) Specifies the name of the virtual cluster. The virtual cluster name as well
as the virtual host name are used when emitting statistics. The statistics are emitted by the
router filter and are documented :ref:`here <config_http_filters_router_stats>`.
.. _envoy_v3_api_msg_config.route.v3.RateLimit:
config.route.v3.RateLimit
-------------------------
`[config.route.v3.RateLimit proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1294>`_
Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`.
.. code-block:: json
{
"stage": "{...}",
"disable_key": "...",
"actions": []
}
.. _envoy_v3_api_field_config.route.v3.RateLimit.stage:
stage
(`UInt32Value <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#uint32value>`_) Refers to the stage set in the filter. The rate limit configuration only
applies to filters with the same stage number. The default stage number is
0.
.. note::
The filter supports a range of 0 - 10 inclusively for stage numbers.
.. _envoy_v3_api_field_config.route.v3.RateLimit.disable_key:
disable_key
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) The key to be set in runtime to disable this rate limit configuration.
.. _envoy_v3_api_field_config.route.v3.RateLimit.actions:
actions
(:ref:`config.route.v3.RateLimit.Action <envoy_v3_api_msg_config.route.v3.RateLimit.Action>`, *REQUIRED*) A list of actions that are to be applied for this rate limit configuration.
Order matters as the actions are processed sequentially and the descriptor
is composed by appending descriptor entries in that sequence. If an action
cannot append a descriptor entry, no descriptor is generated for the
configuration. See :ref:`composing actions
<config_http_filters_rate_limit_composing_actions>` for additional documentation.
.. _envoy_v3_api_msg_config.route.v3.RateLimit.Action:
config.route.v3.RateLimit.Action
--------------------------------
`[config.route.v3.RateLimit.Action proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1298>`_
.. code-block:: json
{
"source_cluster": "{...}",
"destination_cluster": "{...}",
"request_headers": "{...}",
"remote_address": "{...}",
"generic_key": "{...}",
"header_value_match": "{...}"
}
.. _envoy_v3_api_field_config.route.v3.RateLimit.Action.source_cluster:
source_cluster
(:ref:`config.route.v3.RateLimit.Action.SourceCluster <envoy_v3_api_msg_config.route.v3.RateLimit.Action.SourceCluster>`) Rate limit on source cluster.
Precisely one of :ref:`source_cluster <envoy_v3_api_field_config.route.v3.RateLimit.Action.source_cluster>`, :ref:`destination_cluster <envoy_v3_api_field_config.route.v3.RateLimit.Action.destination_cluster>`, :ref:`request_headers <envoy_v3_api_field_config.route.v3.RateLimit.Action.request_headers>`, :ref:`remote_address <envoy_v3_api_field_config.route.v3.RateLimit.Action.remote_address>`, :ref:`generic_key <envoy_v3_api_field_config.route.v3.RateLimit.Action.generic_key>`, :ref:`header_value_match <envoy_v3_api_field_config.route.v3.RateLimit.Action.header_value_match>` must be set.
.. _envoy_v3_api_field_config.route.v3.RateLimit.Action.destination_cluster:
destination_cluster
(:ref:`config.route.v3.RateLimit.Action.DestinationCluster <envoy_v3_api_msg_config.route.v3.RateLimit.Action.DestinationCluster>`) Rate limit on destination cluster.
Precisely one of :ref:`source_cluster <envoy_v3_api_field_config.route.v3.RateLimit.Action.source_cluster>`, :ref:`destination_cluster <envoy_v3_api_field_config.route.v3.RateLimit.Action.destination_cluster>`, :ref:`request_headers <envoy_v3_api_field_config.route.v3.RateLimit.Action.request_headers>`, :ref:`remote_address <envoy_v3_api_field_config.route.v3.RateLimit.Action.remote_address>`, :ref:`generic_key <envoy_v3_api_field_config.route.v3.RateLimit.Action.generic_key>`, :ref:`header_value_match <envoy_v3_api_field_config.route.v3.RateLimit.Action.header_value_match>` must be set.
.. _envoy_v3_api_field_config.route.v3.RateLimit.Action.request_headers:
request_headers
(:ref:`config.route.v3.RateLimit.Action.RequestHeaders <envoy_v3_api_msg_config.route.v3.RateLimit.Action.RequestHeaders>`) Rate limit on request headers.
Precisely one of :ref:`source_cluster <envoy_v3_api_field_config.route.v3.RateLimit.Action.source_cluster>`, :ref:`destination_cluster <envoy_v3_api_field_config.route.v3.RateLimit.Action.destination_cluster>`, :ref:`request_headers <envoy_v3_api_field_config.route.v3.RateLimit.Action.request_headers>`, :ref:`remote_address <envoy_v3_api_field_config.route.v3.RateLimit.Action.remote_address>`, :ref:`generic_key <envoy_v3_api_field_config.route.v3.RateLimit.Action.generic_key>`, :ref:`header_value_match <envoy_v3_api_field_config.route.v3.RateLimit.Action.header_value_match>` must be set.
.. _envoy_v3_api_field_config.route.v3.RateLimit.Action.remote_address:
remote_address
(:ref:`config.route.v3.RateLimit.Action.RemoteAddress <envoy_v3_api_msg_config.route.v3.RateLimit.Action.RemoteAddress>`) Rate limit on remote address.
Precisely one of :ref:`source_cluster <envoy_v3_api_field_config.route.v3.RateLimit.Action.source_cluster>`, :ref:`destination_cluster <envoy_v3_api_field_config.route.v3.RateLimit.Action.destination_cluster>`, :ref:`request_headers <envoy_v3_api_field_config.route.v3.RateLimit.Action.request_headers>`, :ref:`remote_address <envoy_v3_api_field_config.route.v3.RateLimit.Action.remote_address>`, :ref:`generic_key <envoy_v3_api_field_config.route.v3.RateLimit.Action.generic_key>`, :ref:`header_value_match <envoy_v3_api_field_config.route.v3.RateLimit.Action.header_value_match>` must be set.
.. _envoy_v3_api_field_config.route.v3.RateLimit.Action.generic_key:
generic_key
(:ref:`config.route.v3.RateLimit.Action.GenericKey <envoy_v3_api_msg_config.route.v3.RateLimit.Action.GenericKey>`) Rate limit on a generic key.
Precisely one of :ref:`source_cluster <envoy_v3_api_field_config.route.v3.RateLimit.Action.source_cluster>`, :ref:`destination_cluster <envoy_v3_api_field_config.route.v3.RateLimit.Action.destination_cluster>`, :ref:`request_headers <envoy_v3_api_field_config.route.v3.RateLimit.Action.request_headers>`, :ref:`remote_address <envoy_v3_api_field_config.route.v3.RateLimit.Action.remote_address>`, :ref:`generic_key <envoy_v3_api_field_config.route.v3.RateLimit.Action.generic_key>`, :ref:`header_value_match <envoy_v3_api_field_config.route.v3.RateLimit.Action.header_value_match>` must be set.
.. _envoy_v3_api_field_config.route.v3.RateLimit.Action.header_value_match:
header_value_match
(:ref:`config.route.v3.RateLimit.Action.HeaderValueMatch <envoy_v3_api_msg_config.route.v3.RateLimit.Action.HeaderValueMatch>`) Rate limit on the existence of request headers.
Precisely one of :ref:`source_cluster <envoy_v3_api_field_config.route.v3.RateLimit.Action.source_cluster>`, :ref:`destination_cluster <envoy_v3_api_field_config.route.v3.RateLimit.Action.destination_cluster>`, :ref:`request_headers <envoy_v3_api_field_config.route.v3.RateLimit.Action.request_headers>`, :ref:`remote_address <envoy_v3_api_field_config.route.v3.RateLimit.Action.remote_address>`, :ref:`generic_key <envoy_v3_api_field_config.route.v3.RateLimit.Action.generic_key>`, :ref:`header_value_match <envoy_v3_api_field_config.route.v3.RateLimit.Action.header_value_match>` must be set.
.. _envoy_v3_api_msg_config.route.v3.RateLimit.Action.SourceCluster:
config.route.v3.RateLimit.Action.SourceCluster
----------------------------------------------
`[config.route.v3.RateLimit.Action.SourceCluster proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1309>`_
The following descriptor entry is appended to the descriptor:
.. code-block:: cpp
("source_cluster", "<local service cluster>")
<local service cluster> is derived from the :option:`--service-cluster` option.
.. code-block:: json
{}
.. _envoy_v3_api_msg_config.route.v3.RateLimit.Action.DestinationCluster:
config.route.v3.RateLimit.Action.DestinationCluster
---------------------------------------------------
`[config.route.v3.RateLimit.Action.DestinationCluster proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1330>`_
The following descriptor entry is appended to the descriptor:
.. code-block:: cpp
("destination_cluster", "<routed target cluster>")
Once a request matches against a route table rule, a routed cluster is determined by one of
the following :ref:`route table configuration <envoy_v3_api_msg_config.route.v3.RouteConfiguration>`
settings:
* :ref:`cluster <envoy_v3_api_field_config.route.v3.RouteAction.cluster>` indicates the upstream cluster
to route to.
* :ref:`weighted_clusters <envoy_v3_api_field_config.route.v3.RouteAction.weighted_clusters>`
chooses a cluster randomly from a set of clusters with attributed weight.
* :ref:`cluster_header <envoy_v3_api_field_config.route.v3.RouteAction.cluster_header>` indicates which
header in the request contains the target cluster.
.. code-block:: json
{}
.. _envoy_v3_api_msg_config.route.v3.RateLimit.Action.RequestHeaders:
config.route.v3.RateLimit.Action.RequestHeaders
-----------------------------------------------
`[config.route.v3.RateLimit.Action.RequestHeaders proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1341>`_
The following descriptor entry is appended when a header contains a key that matches the
*header_name*:
.. code-block:: cpp
("<descriptor_key>", "<header_value_queried_from_header>")
.. code-block:: json
{
"header_name": "...",
"descriptor_key": "..."
}
.. _envoy_v3_api_field_config.route.v3.RateLimit.Action.RequestHeaders.header_name:
header_name
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) The header name to be queried from the request headers. The header’s
value is used to populate the value of the descriptor entry for the
descriptor_key.
.. _envoy_v3_api_field_config.route.v3.RateLimit.Action.RequestHeaders.descriptor_key:
descriptor_key
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) The key to use in the descriptor entry.
.. _envoy_v3_api_msg_config.route.v3.RateLimit.Action.RemoteAddress:
config.route.v3.RateLimit.Action.RemoteAddress
----------------------------------------------
`[config.route.v3.RateLimit.Action.RemoteAddress proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1362>`_
The following descriptor entry is appended to the descriptor and is populated using the
trusted address from :ref:`x-forwarded-for <config_http_conn_man_headers_x-forwarded-for>`:
.. code-block:: cpp
("remote_address", "<trusted address from x-forwarded-for>")
.. code-block:: json
{}
.. _envoy_v3_api_msg_config.route.v3.RateLimit.Action.GenericKey:
config.route.v3.RateLimit.Action.GenericKey
-------------------------------------------
`[config.route.v3.RateLimit.Action.GenericKey proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1372>`_
The following descriptor entry is appended to the descriptor:
.. code-block:: cpp
("generic_key", "<descriptor_value>")
.. code-block:: json
{
"descriptor_value": "..."
}
.. _envoy_v3_api_field_config.route.v3.RateLimit.Action.GenericKey.descriptor_value:
descriptor_value
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) The value to use in the descriptor entry.
.. _envoy_v3_api_msg_config.route.v3.RateLimit.Action.HeaderValueMatch:
config.route.v3.RateLimit.Action.HeaderValueMatch
-------------------------------------------------
`[config.route.v3.RateLimit.Action.HeaderValueMatch proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1385>`_
The following descriptor entry is appended to the descriptor:
.. code-block:: cpp
("header_match", "<descriptor_value>")
.. code-block:: json
{
"descriptor_value": "...",
"expect_match": "{...}",
"headers": []
}
.. _envoy_v3_api_field_config.route.v3.RateLimit.Action.HeaderValueMatch.descriptor_value:
descriptor_value
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) The value to use in the descriptor entry.
.. _envoy_v3_api_field_config.route.v3.RateLimit.Action.HeaderValueMatch.expect_match:
expect_match
(`BoolValue <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue>`_) If set to true, the action will append a descriptor entry when the
request matches the headers. If set to false, the action will append a
descriptor entry when the request does not match the headers. The
default value is true.
.. _envoy_v3_api_field_config.route.v3.RateLimit.Action.HeaderValueMatch.headers:
headers
(:ref:`config.route.v3.HeaderMatcher <envoy_v3_api_msg_config.route.v3.HeaderMatcher>`, *REQUIRED*) Specifies a set of headers that the rate limit action should match
on. The action will check the request’s headers against all the
specified headers in the config. A match will happen if all the
headers in the config are present in the request with the same values
(or based on presence if the value field is not in the config).
.. _envoy_v3_api_msg_config.route.v3.HeaderMatcher:
config.route.v3.HeaderMatcher
-----------------------------
`[config.route.v3.HeaderMatcher proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1475>`_
.. attention::
Internally, Envoy always uses the HTTP/2 *:authority* header to represent the HTTP/1 *Host*
header. Thus, if attempting to match on *Host*, match on *:authority* instead.
.. attention::
To route on HTTP method, use the special HTTP/2 *:method* header. This works for both
HTTP/1 and HTTP/2 as Envoy normalizes headers. E.g.,
.. code-block:: json
{
"name": ":method",
"exact_match": "POST"
}
.. attention::
In the absence of any header match specifier, match will default to :ref:`present_match
<envoy_v3_api_field_config.route.v3.HeaderMatcher.present_match>`. i.e, a request that has the :ref:`name
<envoy_v3_api_field_config.route.v3.HeaderMatcher.name>` header will match, regardless of the header's
value.
.. code-block:: json
{
"name": "...",
"exact_match": "...",
"safe_regex_match": "{...}",
"range_match": "{...}",
"present_match": "...",
"prefix_match": "...",
"suffix_match": "...",
"invert_match": "..."
}
.. _envoy_v3_api_field_config.route.v3.HeaderMatcher.name:
name
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) Specifies the name of the header in the request.
.. _envoy_v3_api_field_config.route.v3.HeaderMatcher.exact_match:
exact_match
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) If specified, header match will be performed based on the value of the header.
Specifies how the header match will be performed to route the request.
Only one of :ref:`exact_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.exact_match>`, :ref:`safe_regex_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.safe_regex_match>`, :ref:`range_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.range_match>`, :ref:`present_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.present_match>`, :ref:`prefix_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.prefix_match>`, :ref:`suffix_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.suffix_match>` may be set.
.. _envoy_v3_api_field_config.route.v3.HeaderMatcher.safe_regex_match:
safe_regex_match
(:ref:`type.matcher.v3.RegexMatcher <envoy_v3_api_msg_type.matcher.v3.RegexMatcher>`) If specified, this regex string is a regular expression rule which implies the entire request
header value must match the regex. The rule will not match if only a subsequence of the
request header value matches the regex.
Specifies how the header match will be performed to route the request.
Only one of :ref:`exact_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.exact_match>`, :ref:`safe_regex_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.safe_regex_match>`, :ref:`range_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.range_match>`, :ref:`present_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.present_match>`, :ref:`prefix_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.prefix_match>`, :ref:`suffix_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.suffix_match>` may be set.
.. _envoy_v3_api_field_config.route.v3.HeaderMatcher.range_match:
range_match
(:ref:`type.v3.Int64Range <envoy_v3_api_msg_type.v3.Int64Range>`) If specified, header match will be performed based on range.
The rule will match if the request header value is within this range.
The entire request header value must represent an integer in base 10 notation: consisting of
an optional plus or minus sign followed by a sequence of digits. The rule will not match if
the header value does not represent an integer. Match will fail for empty values, floating
point numbers or if only a subsequence of the header value is an integer.
Examples:
* For range [-10,0), route will match for header value -1, but not for 0, "somestring", 10.9,
"-1somestring"
Specifies how the header match will be performed to route the request.
Only one of :ref:`exact_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.exact_match>`, :ref:`safe_regex_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.safe_regex_match>`, :ref:`range_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.range_match>`, :ref:`present_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.present_match>`, :ref:`prefix_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.prefix_match>`, :ref:`suffix_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.suffix_match>` may be set.
.. _envoy_v3_api_field_config.route.v3.HeaderMatcher.present_match:
present_match
(`bool <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) If specified, header match will be performed based on whether the header is in the
request.
Specifies how the header match will be performed to route the request.
Only one of :ref:`exact_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.exact_match>`, :ref:`safe_regex_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.safe_regex_match>`, :ref:`range_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.range_match>`, :ref:`present_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.present_match>`, :ref:`prefix_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.prefix_match>`, :ref:`suffix_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.suffix_match>` may be set.
.. _envoy_v3_api_field_config.route.v3.HeaderMatcher.prefix_match:
prefix_match
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) If specified, header match will be performed based on the prefix of the header value.
Note: empty prefix is not allowed, please use present_match instead.
Examples:
* The prefix *abcd* matches the value *abcdxyz*, but not for *abcxyz*.
Specifies how the header match will be performed to route the request.
Only one of :ref:`exact_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.exact_match>`, :ref:`safe_regex_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.safe_regex_match>`, :ref:`range_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.range_match>`, :ref:`present_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.present_match>`, :ref:`prefix_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.prefix_match>`, :ref:`suffix_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.suffix_match>` may be set.
.. _envoy_v3_api_field_config.route.v3.HeaderMatcher.suffix_match:
suffix_match
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) If specified, header match will be performed based on the suffix of the header value.
Note: empty suffix is not allowed, please use present_match instead.
Examples:
* The suffix *abcd* matches the value *xyzabcd*, but not for *xyzbcd*.
Specifies how the header match will be performed to route the request.
Only one of :ref:`exact_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.exact_match>`, :ref:`safe_regex_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.safe_regex_match>`, :ref:`range_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.range_match>`, :ref:`present_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.present_match>`, :ref:`prefix_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.prefix_match>`, :ref:`suffix_match <envoy_v3_api_field_config.route.v3.HeaderMatcher.suffix_match>` may be set.
.. _envoy_v3_api_field_config.route.v3.HeaderMatcher.invert_match:
invert_match
(`bool <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) If specified, the match result will be inverted before checking. Defaults to false.
Examples:
* The regex ``\d{3}`` does not match the value *1234*, so it will match when inverted.
* The range [-10,0) will match the value -1, so it will not match when inverted.
.. _envoy_v3_api_msg_config.route.v3.QueryParameterMatcher:
config.route.v3.QueryParameterMatcher
-------------------------------------
`[config.route.v3.QueryParameterMatcher proto] <https://github.com/envoyproxy/envoy/blob/ca0d61134a84ce644c7f46549a06a99579fb97c0/api/envoy/config/route/v3/route_components.proto#L1542>`_
Query parameter matching treats the query string of a request's :path header
as an ampersand-separated list of keys and/or key=value elements.
.. code-block:: json
{
"name": "...",
"string_match": "{...}",
"present_match": "..."
}
.. _envoy_v3_api_field_config.route.v3.QueryParameterMatcher.name:
name
(`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_, *REQUIRED*) Specifies the name of a key that must be present in the requested
*path*'s query string.
.. _envoy_v3_api_field_config.route.v3.QueryParameterMatcher.string_match:
string_match
(:ref:`type.matcher.v3.StringMatcher <envoy_v3_api_msg_type.matcher.v3.StringMatcher>`) Specifies whether a query parameter value should match against a string.
Only one of :ref:`string_match <envoy_v3_api_field_config.route.v3.QueryParameterMatcher.string_match>`, :ref:`present_match <envoy_v3_api_field_config.route.v3.QueryParameterMatcher.present_match>` may be set.
.. _envoy_v3_api_field_config.route.v3.QueryParameterMatcher.present_match:
present_match
(`bool <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Specifies whether a query parameter should be present.
Only one of :ref:`string_match <envoy_v3_api_field_config.route.v3.QueryParameterMatcher.string_match>`, :ref:`present_match <envoy_v3_api_field_config.route.v3.QueryParameterMatcher.present_match>` may be set.