You are browsing unreleased documentation. See the latest documentation here.
MeshGatewayRoute
New to Kuma? Don’t use this, check the
MeshHTTPRoute
policy orMeshTCPRoute
policy instead.
MeshGatewayRoute
is a policy used to configure Kong Mesh’s builtin gateway.
It is used in combination with MeshGateway
.
MeshGatewayRoute
is a Kong Mesh dataplane policy that replaces TrafficRoute for Kong Mesh Gateway.
It configures how a gateway should process network traffic.
At the moment, it targets HTTP routing use cases.
MeshGatewayRoutes
are attached to gateways by matching their selector to the MeshGateway
listener tags. This requires the kuma.io/service
tag and, optionally, additional tags to match specific MeshGateway
listeners.
The following MeshGatewayRoute
routes traffic to the backend
service and attaches to any listeners tagged with vhost=foo.example.com
that attach to builtin gateways with kuma.io/service: edge-gateway
.
Listener tags
When Kong Mesh binds a MeshGatewayRoute
to a MeshGateway
, careful specification of tags lets you control whether the MeshGatewayRoute
will bind to one or more of the listeners declared on the MeshGateway
.
Each listener stanza on a MeshGateway
has a set of tags; Kong Mesh creates the listener tags by combining these tags with the tags from the underlying builtin gateway Dataplane
.
A selector that matches only on the kuma.io/service
tag will bind to all listeners on the MeshGateway
, but a selector that includes listener tags will only bind to matching listeners.
One application of this mechanism is to inject standard routes into all virtual hosts, without the need to modify MeshGatewayRoutes
that configure specific applications.
Matching
MeshGatewayRoute
allows HTTP requests to be matched by various criteria (e.g. URI path, HTTP headers).
When Kong Mesh generates the final Envoy configuration for a builtin gateway Dataplane
, it combines all the matching MeshGatewayRoutes
into a single set of routing tables, partitioned by the virtual hostname, which is specified either in the MeshGateway
listener or in the MeshGatewayRoute
.
Kong Mesh sorts the rules in each table by specificity, so that routes with more specific match criteria are always ordered first.
For example, a rule that matches on a HTTP header and a path is more specific than one that matches only on path, and the longest match path will be considered more specific.
This ordering allows Kume to combine routing rules from multiple MeshGatewayRoute
resources and still produce predictable results.
Filters
Every rule can include filters that further modifies requests. For example, by modifying headers and mirroring, redirecting, or rewriting requests.
For example, the following filters match /prefix
, trim it from the path and set the Host
header:
...
- matches:
- path:
match: PREFIX
value: /prefix/
backends:
- destination:
kuma.io/service: backend
filters:
- requestHeader:
set:
- name: Host
value: test.com
- rewrite:
replacePrefixMatch: "/"