package envoy.api.v2.route
Get desktop application:
View/edit binary Protocol Buffers messages
message
route_components.proto:489[#next-free-field: 12]
Used in: ,
repeated string allow_origin = 1
Specifies the origins that will be allowed to do CORS requests. An origin is allowed if either allow_origin or allow_origin_regex match. .. attention:: This field has been deprecated in favor of `allow_origin_string_match`.
repeated string allow_origin_regex = 8
Specifies regex patterns that match allowed origins. An origin is allowed if either allow_origin or allow_origin_regex match. .. attention:: This field has been deprecated in favor of `allow_origin_string_match` as it is not safe for use with untrusted input in all cases.
repeated allow_origin_string_match = 11
Specifies string patterns that match allowed origins. An origin is allowed if any of the string matchers match.
string allow_methods = 2
Specifies the content for the *access-control-allow-methods* header.
string allow_headers = 3
Specifies the content for the *access-control-allow-headers* header.
string expose_headers = 4
Specifies the content for the *access-control-expose-headers* header.
string max_age = 5
Specifies the content for the *access-control-max-age* header.
optional allow_credentials = 6
Specifies whether the resource allows credentials.
oneof enabled_specifier
enabled = 7
Specifies if the CORS filter is enabled. Defaults to true. Only effective on route. .. attention:: **This field is deprecated**. Set the :ref:`filter_enabled<envoy_api_field_route.CorsPolicy.filter_enabled>` field instead.
filter_enabled = 9
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_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified, Envoy will lookup the runtime key to get the percentage of requests to filter.
optional shadow_enabled = 10
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_api_field_core.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.
message
route_components.proto:1249Used in:
string operation = 1
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.
optional propagate = 2
Whether the decorated details should be propagated to the other party. The default is true.
message
route_components.proto:1234Used in:
uint32 status = 1
Specifies the HTTP response status to be returned.
optional body = 2
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_api_msg_route.Route`, :ref:`envoy_api_msg_RouteConfiguration` or :ref:`envoy_api_msg_route.VirtualHost`.
message
route_components.proto:187A filter-defined action type.
Used in:
optional action = 1
message
route_components.proto:1517.. 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_api_field_route.HeaderMatcher.present_match>`. i.e, a request that has the :ref:`name <envoy_api_field_route.HeaderMatcher.name>` header will match, regardless of the header's value. [#next-major-version: HeaderMatcher should be refactored to use StringMatcher.] [#next-free-field: 12]
Used in: , , , , , , , , , , ,
string name = 1
Specifies the name of the header in the request.
oneof header_match_specifier
Specifies how the header match will be performed to route the request.
string exact_match = 4
If specified, header match will be performed based on the value of the header.
string regex_match = 5
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. The regex grammar used in the value field is defined `here <https://en.cppreference.com/w/cpp/regex/ecmascript>`_. Examples: * The regex ``\d{3}`` matches the value *123* * The regex ``\d{3}`` does not match the value *1234* * The regex ``\d{3}`` does not match the value *123.456* .. attention:: This field has been deprecated in favor of `safe_regex_match` as it is not safe for use with untrusted input in all cases.
safe_regex_match = 11
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.
range_match = 6
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"
bool present_match = 7
If specified, header match will be performed based on whether the header is in the request.
string prefix_match = 9
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*.
string suffix_match = 10
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*.
bool invert_match = 8
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.
message
route_components.proto:1125HTTP request hedging :ref:`architecture overview <arch_overview_http_routing_hedging>`.
Used in: ,
optional initial_requests = 1
Specifies the number of initial requests that should be sent upstream. Must be at least 1. Defaults to 1. [#not-implemented-hide:]
optional additional_request_chance = 2
Specifies a probability that an additional upstream request should be sent on top of what is specified by initial_requests. Defaults to 0. [#not-implemented-hide:]
bool hedge_on_per_try_timeout = 3
Indicates that a hedged request should be sent when the per-try timeout is hit. This means that a retry will be issued without resetting the original request, leaving multiple upstream requests in flight. The first request to complete successfully will be the one returned to the caller. * At any time, a successful response (i.e. not triggering any of the retry-on conditions) would be returned to the client. * Before per-try timeout, an error response (per retry-on conditions) would be retried immediately or returned ot the client if there are no more retries left. * After per-try timeout, an error response would be discarded, as a retry in the form of a hedged request is already in progress. Note: For this to have effect, you must have a :ref:`RetryPolicy <envoy_api_msg_route.RetryPolicy>` that retries at least one error code and specifies a maximum number of retries. Defaults to false.
message
route_components.proto:1600Query parameter matching treats the query string of a request's :path header as an ampersand-separated list of keys and/or key=value elements. [#next-free-field: 7]
Used in: ,
string name = 1
Specifies the name of a key that must be present in the requested *path*'s query string.
string value = 3
Specifies the value of the key. If the value is absent, a request that contains the key in its query string will match, whether the key appears with a value (e.g., "?debug=true") or not (e.g., "?debug") ..attention:: This field is deprecated. Use an `exact` match inside the `string_match` field.
optional regex = 4
Specifies whether the query parameter value is a regular expression. Defaults to false. The entire query parameter value (i.e., the part to the right of the equals sign in "key=value") must match the regex. E.g., the regex ``\d+$`` will match *123* but not *a123* or *123a*. ..attention:: This field is deprecated. Use a `safe_regex` match inside the `string_match` field.
oneof query_parameter_match_specifier
string_match = 5
Specifies whether a query parameter value should match against a string.
bool present_match = 6
Specifies whether a query parameter should be present.
message
route_components.proto:1356Global rate limiting :ref:`architecture overview <arch_overview_global_rate_limit>`.
Used in: , ,
optional stage = 1
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.
string disable_key = 2
The key to be set in runtime to disable this rate limit configuration.
repeated actions = 3
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.
message
route_components.proto:1358[#next-free-field: 7]
Used in:
oneof action_specifier
source_cluster = 1
Rate limit on source cluster.
destination_cluster = 2
Rate limit on destination cluster.
request_headers = 3
Rate limit on request headers.
remote_address = 4
Rate limit on remote address.
generic_key = 5
Rate limit on a generic key.
header_value_match = 6
Rate limit on the existence of request headers.
message
route_components.proto:1385The 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_api_msg_RouteConfiguration>` settings: * :ref:`cluster <envoy_api_field_route.RouteAction.cluster>` indicates the upstream cluster to route to. * :ref:`weighted_clusters <envoy_api_field_route.RouteAction.weighted_clusters>` chooses a cluster randomly from a set of clusters with attributed weight. * :ref:`cluster_header <envoy_api_field_route.RouteAction.cluster_header>` indicates which header in the request contains the target cluster.
Used in:
(message has no fields)
message
route_components.proto:1420The following descriptor entry is appended to the descriptor: .. code-block:: cpp ("generic_key", "<descriptor_value>")
Used in:
string descriptor_value = 1
The value to use in the descriptor entry.
message
route_components.proto:1430The following descriptor entry is appended to the descriptor: .. code-block:: cpp ("header_match", "<descriptor_value>")
Used in:
string descriptor_value = 1
The value to use in the descriptor entry.
optional expect_match = 2
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.
repeated headers = 3
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).
message
route_components.proto:1412The 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>")
Used in:
(message has no fields)
message
route_components.proto:1394The 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>")
Used in:
string header_name = 1
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.
string descriptor_key = 2
The key to use in the descriptor entry.
message
route_components.proto:1366The 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.
Used in:
(message has no fields)
message
route_components.proto:1155[#next-free-field: 9]
Used in:
oneof scheme_rewrite_specifier
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
bool https_redirect = 4
The scheme portion of the URL will be swapped with "https".
string scheme_redirect = 7
The scheme portion of the URL will be swapped with this value.
string host_redirect = 1
The host portion of the URL will be swapped with this value.
uint32 port_redirect = 8
The port value of the URL will be swapped with this value.
oneof path_rewrite_specifier
string path_redirect = 2
The path portion of the URL will be swapped with this value. Please note that query string in path_redirect will override the request's query string and will not be stripped. For example, let's say we have the following routes: - match: { path: "/old-path-1" } redirect: { path_redirect: "/new-path-1" } - match: { path: "/old-path-2" } redirect: { path_redirect: "/new-path-2", strip-query: "true" } - match: { path: "/old-path-3" } redirect: { path_redirect: "/new-path-3?foo=1", strip_query: "true" } 1. if request uri is "/old-path-1?bar=1", users will be redirected to "/new-path-1?bar=1" 2. if request uri is "/old-path-2?bar=1", users will be redirected to "/new-path-2" 3. if request uri is "/old-path-3?bar=1", users will be redirected to "/new-path-3?foo=1"
string prefix_rewrite = 5
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_api_field_route.RouteAction.prefix_rewrite>`.
RedirectAction.RedirectResponseCode response_code = 3
The HTTP status code to use in the redirect response. The default response code is MOVED_PERMANENTLY (301).
bool strip_query = 6
Indicates that during redirection, the query portion of the URL will be removed. Default value is false.
Used in:
MOVED_PERMANENTLY = 0
Moved Permanently HTTP Status Code - 301.
FOUND = 1
Found HTTP Status Code - 302.
SEE_OTHER = 2
See Other HTTP Status Code - 303.
TEMPORARY_REDIRECT = 3
Temporary Redirect HTTP Status Code - 307.
PERMANENT_REDIRECT = 4
Permanent Redirect HTTP Status Code - 308.
message
route_components.proto:1028HTTP retry :ref:`architecture overview <arch_overview_http_routing_retry>`. [#next-free-field: 11]
Used in: ,
string retry_on = 1
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`.
optional num_retries = 2
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`.
optional per_try_timeout = 3
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_api_field_route.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.
optional retry_priority = 4
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.
repeated retry_host_predicate = 5
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.
int64 host_selection_retry_max_attempts = 6
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.
repeated uint32 retriable_status_codes = 7
HTTP status codes that should trigger a retry in addition to those specified by retry_on.
optional retry_back_off = 8
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.
repeated retriable_headers = 9
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.
repeated retriable_request_headers = 10
HTTP headers which must be present in the request for retries to be attempted.
message
route_components.proto:1049Used in:
optional base_interval = 1
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.
optional max_interval = 2
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.
message
route_components.proto:1039Used in:
string name = 1
oneof config_type
config = 2
typed_config = 3
message
route_components.proto:1029Used in:
string name = 1
oneof config_type
config = 2
typed_config = 3
message
route_components.proto:199A 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_api_msg_route.HeaderMatcher>`. [#next-free-field: 18]
Used in:
string name = 14
Name for the route.
optional match = 1
Route matching parameters.
oneof action
route = 2
Route request to some upstream cluster.
redirect = 3
Return a redirect.
direct_response = 7
Return an arbitrary HTTP response directly, without proxying.
filter_action = 17
[#not-implemented-hide:] If true, a filter will define the action (e.g., it could dynamically generate the RouteAction).
optional metadata = 4
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*.
optional decorator = 5
Decorator for the matched route.
map<string, > per_filter_config = 8
The 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.
map<string, > typed_per_filter_config = 13
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.
repeated request_headers_to_add = 9
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_api_msg_route.VirtualHost` and :ref:`envoy_api_msg_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>`.
repeated string request_headers_to_remove = 12
Specifies a list of HTTP headers that should be removed from each request matching this route.
repeated response_headers_to_add = 10
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_api_msg_route.VirtualHost` and :ref:`envoy_api_msg_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>`.
repeated string response_headers_to_remove = 11
Specifies a list of HTTP headers that should be removed from each response to requests matching this route.
optional tracing = 15
Presence of the object defines whether the connection manager's tracing configuration is overridden by this route specific instance.
optional per_request_buffer_limit_bytes = 16
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.
message
route_components.proto:561[#next-free-field: 34]
Used in:
oneof cluster_specifier
string cluster = 1
Indicates the upstream cluster to which the request should be routed to.
string cluster_header = 2
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. .. note:: If the header appears multiple times only the first value is used.
weighted_clusters = 3
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.
RouteAction.ClusterNotFoundResponseCode cluster_not_found_response_code = 20
The HTTP status code to use when configured cluster is not found. The default response code is 503 Service Unavailable.
optional metadata_match = 4
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_api_field_route.RouteAction.weighted_clusters>`, metadata will be merged, with values provided there taking precedence. The filter name should be specified as *envoy.lb*.
string prefix_rewrite = 5
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_api_field_route.RouteAction.regex_rewrite>` may be specified. .. attention:: Pay careful attention to the use of trailing slashes in the :ref:`route's match <envoy_api_field_route.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_api_msg_route.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*.
optional regex_rewrite = 32
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_api_field_route.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``.
oneof host_rewrite_specifier
string host_rewrite = 6
Indicates that during forwarding, the host header will be swapped with this value.
auto_host_rewrite = 7
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``, ``LOGICAL_DNS`` or ``STATIC``. For ``STATIC`` clusters, the hostname attribute of the endpoint must be configured. Setting this to true with other cluster types has no effect.
string auto_host_rewrite_header = 29
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. .. note:: If the header appears multiple times only the first value is used.
optional timeout = 8
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>`.
optional idle_timeout = 24
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_api_field_config.filter.network.http_connection_manager.v2.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_api_field_route.RouteAction.timeout>`, which provides an upper bound on the upstream response time; :ref:`idle_timeout <envoy_api_field_route.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.
optional retry_policy = 9
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).
optional retry_policy_typed_config = 33
[#not-implemented-hide:] Specifies the configuration for retry policy extension. 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). :ref:`Retry policy <envoy_api_field_route.VirtualHost.retry_policy>` should not be set if this field is used.
optional request_mirror_policy = 10
Indicates that the route has a request mirroring policy. .. attention:: This field has been deprecated in favor of `request_mirror_policies` which supports one or more mirroring policies.
repeated request_mirror_policies = 30
Indicates that the route has request mirroring policies.
core.RoutingPriority priority = 11
Optionally specifies the :ref:`routing priority <arch_overview_http_routing_priority>`.
repeated rate_limits = 13
Specifies a set of rate limit configurations that could be applied to the route.
optional include_vh_rate_limits = 14
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_api_field_route.VirtualHost.rate_limits>` are not applied to the request.
repeated hash_policy = 15
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.
optional cors = 17
Indicates that the route has a CORS policy.
optional max_grpc_timeout = 23
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_api_field_route.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_api_field_route.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>`.
optional grpc_timeout_offset = 28
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).
repeated upgrade_configs = 25
RouteAction.InternalRedirectAction internal_redirect_action = 26
optional max_internal_redirects = 31
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_api_field_route.RouteAction.internal_redirect_action>` is set to :ref:`HANDLE_INTERNAL_REDIRECT <envoy_api_enum_value_route.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_api_field_route.RouteAction.internal_redirect_action>` set to :ref:`PASS_THROUGH_INTERNAL_REDIRECT <envoy_api_enum_value_route.RouteAction.InternalRedirectAction.PASS_THROUGH_INTERNAL_REDIRECT>` will pass the redirect back to downstream. If not specified, at most one redirect will be followed.
optional hedge_policy = 27
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).
Used in:
SERVICE_UNAVAILABLE = 0
HTTP status code - 503 Service Unavailable.
NOT_FOUND = 1
HTTP status code - 404 Not Found.
message
route_components.proto:626Specifies the route's hashing policy if the upstream cluster uses a hashing :ref:`load balancer <arch_overview_load_balancing_types>`. [#next-free-field: 7]
Used in:
oneof policy_specifier
header = 1
Header hash policy.
cookie = 2
Cookie hash policy.
connection_properties = 3
Connection properties hash policy.
query_parameter = 5
Query parameter hash policy.
filter_state = 6
Filter state hash policy.
bool terminal = 4
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.
message
route_components.proto:665Used in:
bool source_ip = 1
Hash on source IP address.
message
route_components.proto:649Envoy 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.
Used in:
string name = 1
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.
optional ttl = 2
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.
string path = 3
The name of the path for the cookie. If no path is specified here, no path will be set for the cookie.
message
route_components.proto:677Used in:
string key = 1
The name of the Object in the per-request filterState, which is an Envoy::Hashable object. If there is no data associated with the key, or the stored object is not Envoy::Hashable, no hash will be produced.
message
route_components.proto:627Used in:
string header_name = 1
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.
message
route_components.proto:670Used in:
string name = 1
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.
Configures :ref:`internal redirect <arch_overview_internal_redirects>` behavior.
Used in:
PASS_THROUGH_INTERNAL_REDIRECT = 0
HANDLE_INTERNAL_REDIRECT = 1
message
route_components.proto:587The 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.
Used in:
string cluster = 1
Specifies the cluster that requests will be mirrored to. The cluster must exist in the cluster manager configuration.
string runtime_key = 2
If not specified, all requests to the target cluster will be mirrored. If specified, Envoy will lookup the runtime key to get the % of requests to mirror. Valid values are from 0 to 10000, allowing for increments of 0.01% of requests to be mirrored. If the runtime key is specified in the configuration but not present in runtime, 0 is the default and thus 0% of requests will be mirrored. .. attention:: **This field is deprecated**. Set the :ref:`runtime_fraction <envoy_api_field_route.RouteAction.RequestMirrorPolicy.runtime_fraction>` field instead. Mirroring occurs if both this and <envoy_api_field_route.RouteAction.RequestMirrorPolicy.runtime_fraction>` are not set.
optional runtime_fraction = 3
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.
optional trace_sampled = 4
Determines if the trace span should be sampled. Defaults to true.
message
route_components.proto:731Allows 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_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.upgrade_configs>` but does not affect any custom filter chain specified there.
Used in:
string upgrade_type = 1
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.
optional enabled = 2
Determines if upgrades are available on this route. Defaults to true.
message
route_components.proto:376[#next-free-field: 12]
Used in: ,
oneof path_specifier
string prefix = 1
If specified, the route is a prefix rule meaning that the prefix must match the beginning of the *:path* header.
string path = 2
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.
string regex = 3
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. The regex grammar is defined `here <https://en.cppreference.com/w/cpp/regex/ecmascript>`_. Examples: * The regex ``/b[io]t`` matches the path */bit* * The regex ``/b[io]t`` matches the path */bot* * The regex ``/b[io]t`` does not match the path */bite* * The regex ``/b[io]t`` does not match the path */bit/bot* .. attention:: This field has been deprecated in favor of `safe_regex` as it is not safe for use with untrusted input in all cases.
safe_regex = 10
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. [#next-major-version: In the v3 API we should redo how path specification works such that we utilize StringMatcher, and additionally have consistent options around whether we strip query strings, do a case sensitive match, etc. In the interim it will be too disruptive to deprecate the existing options. We should even consider whether we want to do away with path_specifier entirely and just rely on a set of header matchers which can already match on :path, etc. The issue with that is it is unclear how to generically deal with query string stripping. This needs more thought.]
optional case_sensitive = 4
Indicates that prefix/path matching should be case sensitive. The default is true.
optional runtime_fraction = 9
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.
repeated headers = 6
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).
repeated query_parameters = 7
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.
optional grpc = 8
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.
optional tls_context = 11
If specified, the client tls context will be matched against the defined match options. [#next-major-version: unify with RBAC]
message
route_components.proto:377Used in:
(message has no fields)
message
route_components.proto:380Used in:
optional presented = 1
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.
optional validated = 2
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.
message
route_components.proto:1264Used in:
optional client_sampling = 1
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_enabled' in the :ref:`HTTP Connection Manager <config_http_conn_man_runtime>`. Default: 100%
optional random_sampling = 2
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%
optional overall_sampling = 3
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%
repeated custom_tags = 4
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_api_field_config.filter.network.http_connection_manager.v2.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.
message
route_components.proto:1316A 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.
Used in:
string pattern = 1
Specifies a regex pattern to use for matching requests. The entire path of the request must match the regex. The regex grammar used is defined `here <https://en.cppreference.com/w/cpp/regex/ecmascript>`_. Examples: * The regex ``/rides/\d+`` matches the path */rides/0* * The regex ``/rides/\d+`` matches the path */rides/123* * The regex ``/rides/\d+`` does not match the path */rides/123/456* .. attention:: This field has been deprecated in favor of `headers` as it is not safe for use with untrusted input in all cases.
repeated headers = 4
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.
string name = 2
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>`.
core.RequestMethod method = 3
Optionally specifies the HTTP method to match on. For example GET, PUT, etc. .. attention:: This field has been deprecated in favor of `headers`.
message
route_components.proto:39The 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. [#next-free-field: 21]
Used in:
string name = 1
The logical name of the virtual host. This is used when emitting certain statistics but is not relevant for routing.
repeated string domains = 2
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.
repeated routes = 3
The list of routes that will be matched, in order, for incoming requests. The first route that matches will be used.
VirtualHost.TlsRequirementType require_tls = 4
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.
repeated virtual_clusters = 5
A list of virtual clusters defined for this virtual host. Virtual clusters are used for additional statistics gathering.
repeated rate_limits = 6
Specifies a set of rate limit configurations that will be applied to the virtual host.
repeated request_headers_to_add = 7
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_api_msg_route.Route` and before headers from the enclosing :ref:`envoy_api_msg_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>`.
repeated string request_headers_to_remove = 13
Specifies a list of HTTP headers that should be removed from each request handled by this virtual host.
repeated response_headers_to_add = 10
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_api_msg_route.Route` and before headers from the enclosing :ref:`envoy_api_msg_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>`.
repeated string response_headers_to_remove = 11
Specifies a list of HTTP headers that should be removed from each response handled by this virtual host.
optional cors = 8
Indicates that the virtual host has a CORS policy.
map<string, > per_filter_config = 12
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.
map<string, > typed_per_filter_config = 15
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.
bool include_request_attempt_count = 14
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_api_field_config.filter.http.router.v2.Router.suppress_envoy_headers>` flag. [#next-major-version: rename to include_attempt_count_in_request.]
bool include_attempt_count_in_response = 19
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_api_field_config.filter.http.router.v2.Router.suppress_envoy_headers>` flag.
optional retry_policy = 16
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).
optional retry_policy_typed_config = 20
[#not-implemented-hide:] Specifies the configuration for retry policy extension. 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). :ref:`Retry policy <envoy_api_field_route.VirtualHost.retry_policy>` should not be set if this field is used.
optional hedge_policy = 17
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).
optional per_request_buffer_limit_bytes = 18
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.
Used in:
NONE = 0
No TLS requirement for the virtual host.
EXTERNAL_ONLY = 1
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.
ALL = 2
All requests must use TLS. If a request is not using TLS, a 301 redirect will be sent telling the client to use HTTPS.
message
route_components.proto:292Compared to the :ref:`cluster <envoy_api_field_route.RouteAction.cluster>` field that specifies a single upstream cluster as the target of a request, the :ref:`weighted_clusters <envoy_api_field_route.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.
Used in: ,
repeated clusters = 1
Specifies one or more upstream clusters associated with the route.
optional total_weight = 3
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.
string runtime_key_prefix = 2
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.
message
route_components.proto:294[#next-free-field: 11]
Used in:
string name = 1
Name of the upstream cluster. The cluster must exist in the :ref:`cluster manager configuration <config_cluster_manager>`.
optional weight = 2
An integer between 0 and :ref:`total_weight <envoy_api_field_route.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, if total_weight is greater than 0.
optional metadata_match = 3
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_api_field_route.RouteAction.metadata_match>`, with values here taking precedence. The filter name should be specified as *envoy.lb*.
repeated request_headers_to_add = 4
Specifies a list of headers to be added to requests when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.RouteAction`. Headers specified at this level are applied before headers from the enclosing :ref:`envoy_api_msg_route.Route`, :ref:`envoy_api_msg_route.VirtualHost`, and :ref:`envoy_api_msg_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>`.
repeated string request_headers_to_remove = 9
Specifies a list of HTTP headers that should be removed from each request when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
repeated response_headers_to_add = 5
Specifies a list of headers to be added to responses when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.RouteAction`. Headers specified at this level are applied before headers from the enclosing :ref:`envoy_api_msg_route.Route`, :ref:`envoy_api_msg_route.VirtualHost`, and :ref:`envoy_api_msg_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>`.
repeated string response_headers_to_remove = 6
Specifies a list of headers to be removed from responses when this cluster is selected through the enclosing :ref:`envoy_api_msg_route.RouteAction`.
map<string, > per_filter_config = 8
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.
map<string, > typed_per_filter_config = 10
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.