package io.linkerd.proxy.http_route

Get desktop application:
View/edit binary Protocol Buffers messages

Describes how to match a header by name and value.

Used in: grpc_route.GrpcRouteMatch, HttpRouteMatch

• string name = 1

• oneof value

  • bytes exact = 2

  • string regex = 3

Describes how to match an `:authority` or `host` header.

Used in: inbound.GrpcRoute, inbound.HttpRoute, outbound.GrpcRoute, outbound.HttpRoute

• oneof match

  • string exact = 1

    Match an exact hostname, e.g. www.example.com.

  • HostMatch.Suffix suffix = 2

    Match a hostname as a wildcard suffix, e.g. *.example.com.

A match like `*.example.com` is encoded as [com, example].

Used in: HostMatch

• repeated string reverse_labels = 1

Configures a route to respond with a fixed response.

Used in: inbound.HttpRoute.Filter, outbound.HttpRoute.Filter

• uint32 status = 1

  The status code to use in the HTTP response. Must be specified.

• string message = 2

  An error message to log and include in the `l5d-proxy-err` header.

• optional Ratio ratio = 3

  If specified, the rate of requests that should be failed. If not specified, ALL requests are failed.

Describes a set of matches, ALL of which must apply.

Used in: inbound.HttpRoute.Rule, outbound.HttpRoute.Rule

• optional PathMatch path = 1

  Matches requests by path.

• repeated HeaderMatch headers = 2

  A set of header value matches that must be satisified. This match is not comprehensive, so requests may include headers that are not covered by this match.

• repeated QueryParamMatch query_params = 3

  A set of query parmaeter value matches that must be satisified. This match is not comprehensive, so requests may include query parameters that are not covered by this match.

• optional http_types.HttpMethod method = 4

  If specified, restricts the match to a single HTTP method.

Describes how to match a path.

Used in: HttpRouteMatch

• oneof kind

  • string exact = 1

  • string prefix = 2

  • string regex = 3

Describes how a path value may be rewritten in a route.

Used in: RequestRedirect

• oneof replace

  • string full = 1

    Indicates that the path should be replaced with the given value.

  • string prefix = 2

    Indicates that the path prefix should be replaced with the given value. When used, the route MUST match the request with PathMatch prefix match. Server implementations SHOULD prevent the useof prefix modifiers on routes that do use a PathMatch prefix match. Proxyies MUST not process requests for routes where this condition is not satisfied.

Describes how to match a query parameter by name and value.

Used in: HttpRouteMatch

• string name = 1

• oneof value

  • string exact = 2

  • string regex = 3

A ratio (i.e., of requests) to which an filter should be applied. Represents fractional values on [0, 1].

Used in: grpc_route.GrpcFailureInjector, HttpFailureInjector

• uint32 numerator = 1

• uint32 denominator = 2

  MUST not be zero.

Configures a route to modify a request's headers. Modifications are to be applied in the order they are described here: additions apply first, then sets, and then removals.

Used in: inbound.GrpcRoute.Filter, inbound.HttpRoute.Filter, outbound.GrpcRoute.Filter, outbound.HttpRoute.Filter

• optional http_types.Headers add = 1

  A list of headers name-value pairs to set on requests, augmenting any existing values for the header.

• optional http_types.Headers set = 2

  A list of headers name-value pairs to set on requests, replacing any existing values for the header.

• repeated string remove = 3

  A list of headers names to be removed from requests.

Configures a route to respond with a redirect response. The `location` header is set with the given URL parameters.

Used in: inbound.HttpRoute.Filter, outbound.HttpRoute.Filter

• optional http_types.Scheme scheme = 1

  The scheme value to be used in the `location` header. If not specified, the original request's scheme is used.

• string host = 2

  The host value to be used in the `location` header. If not specified, the original request's host is used.

• optional PathModifier path = 3

  If set, configures how the request's path should be modified for use in the `location` header. If not specified, the original request's path is used.

• uint32 port = 4

  If set, specifies the port to use in the `location` header.

• uint32 status = 5

  The status code to use in the HTTP response. If not specified, 301 is used.

Configures a route to modify a response's headers. Modifications are to be applied in the order they are described here: additions apply first, then sets, and then removals.

Used in: outbound.HttpRoute.Filter

• optional http_types.Headers add = 1

  A list of headers name-value pairs to set on responses, augmenting any existing values for the header.

• optional http_types.Headers set = 2

  A list of headers name-value pairs to set on responses, replacing any existing values for the header.

• repeated string remove = 3

  A list of headers names to be removed from responses.

Used in: outbound.GrpcRoute.Rule, outbound.HttpRoute.Rule

• optional google.protobuf.Duration response = 1

  Limits the the time a stream may be active after all request frames have been processed.

• optional google.protobuf.Duration request = 2

  Limits the total duration of the stream from the request being initiated until all frames have been processed.

• optional google.protobuf.Duration idle = 3

  Limits the amount of time a stream may be idle (i.e. with no frames being processed).