Rules and Priorities
A router is in charge of connecting incoming requests to the services that can handle them. To customize the connection, Traefik Hub API Gateway allows you to define your matching rules and prioritize the routes.
Rules
Rule consists of a set of matchers configured with values, that determine if a particular request matches specific criteria. If the rule is verified, the router becomes active, calls middlewares, and then forwards the request to the service.
- The character
@is not authorized in the router name. - To set the value of a rule, use backticks
`or escaped double-quotes\". - Single quotes
'are not accepted since the values are Go's String Literals. - Regular Expressions:
- Matchers that accept a regexp as their value use a Go flavored syntax.
- The usual AND (
&&) and OR (||) logical operators can be used, with the expected precedence rules, as well as parentheses to express complex rules. - The NOT (
!) operator allows you to invert the matcher
The table below lists all the available matchers:
| Matcher | Description |
|---|---|
Header(`key`, `value`) | Matches requests containing a header named key set to value. |
HeaderRegexp(`key`, `regexp`) | Matches requests containing a header named key matching regexp. |
Host(`domain`) | Matches requests host set to domain. |
HostRegexp(`regexp`) | Matches requests host matching regexp. |
Method(`method`) | Matches requests method set to method. |
Path(`path`) | Matches requests path set to path. |
PathPrefix(`prefix`) | Matches requests path prefix set to prefix. |
PathRegexp(`regexp`) | Matches request path using regexp. |
Query(`key`, `value`) | Matches requests query parameters named key set to value. |
QueryRegexp(`key`, `regexp`) | Matches requests query parameters named key matching regexp. |
ClientIP(`ip`) | Matches requests client IP using ip. It accepts IPv4, IPv6 and CIDR formats. |
Header and HeaderRegexp
The Header and HeaderRegexp matchers allow matching requests that contain specific header.
| Behavior | Rule |
|---|---|
Match requests with a Content-Type header set to application/yaml | Header(`Content-Type`, `application/yaml`) |
Match requests with a Content-Type header set to either application/json or application/yaml | HeaderRegexp(`Content-Type`, `^application/(json|yaml)$`) |
| Match headers case-insensitively | HeaderRegexp(`Content-Type`, `(?i)^application/(json|yaml)$`) |
Host and HostRegexp
The Host and HostRegexp matchers allow matching requests that are targeted to a given host.
These matchers do not support non-ASCII characters, use punycode encoded values (rfc 3492) to match such domains.
If no Host is set in the request URL (for example, it's an IP address), these matchers will look at the Host header.
These matchers will match the request's host in lowercase.
| Behavior | Rule |
|---|---|
Match requests with Host set to example.com | Host(`example.com`) |
Match requests sent to any subdomain of example.com | HostRegexp(`^.+\.example\.com$`) |
Match requests with Host set to either example.com or example.org | HostRegexp(`^example\.(com|org)$`) |
Match Host case-insensitively | HostRegexp(`(?i)^example\.(com|org)$`) |
Method
The Method matchers allows matching requests sent based on their HTTP method (also known as request verb).
| Behavior | Rule |
|---|---|
Match OPTIONS requests: | Method(`OPTIONS`) |
Path, PathPrefix, and PathRegexp
These matchers allow matching requests based on their URL path.
For exact matches, use Path and its prefixed alternative PathPrefix, for regexp matches, use PathRegexp.
Path are always starting with a /, except for PathRegexp.
| Behavior | Rule |
|---|---|
Match /products but neither /products/shoes nor /products/ | Path(`/products`) |
Match /products as well as everything under /products, such as /products/shoes, /products/ but also /products-for-sale | PathPrefix(`/products`) |
Match both /products/shoes and /products/socks with and ID like /products/shoes/31 | PathRegexp(`^/products/(shoes|socks)/[0-9]+$`) |
Match requests with a path ending in either .jpeg, .jpg or .png | PathRegexp(`\.(jpeg|jpg|png)$`) |
Match /products as well as everything under /products, such as /products/shoes, /products/ but also /products-for-sale, case-insensitively | HostRegexp(`(?i)^/products`) |
Query and QueryRegexp
The Query and QueryRegexp matchers allow matching requests based on query parameters.
| Behavior | Rule |
|---|---|
Match requests with a mobile query parameter set to true, such as in /search?mobile=true | Query(`mobile`, `true`) |
Match requests with a query parameter mobile that has no value, such as in /search?mobile | Query(`mobile`) |
Match requests with a mobile query parameter set to either true or yes | QueryRegexp(`mobile`, `^(true|yes)$`) |
Match requests with a mobile query parameter set to any value (including the empty value) | QueryRegexp(`mobile`, `^.*$`) |
| Match query parameters case-insensitively | QueryRegexp(`mobile`, `(?i)^(true|yes)$`) |
ClientIP
The ClientIP matcher allows matching requests sent from the given client IP.
It only matches the request client IP and does not use the X-Forwarded-For header for matching.
| Behavior | Rule |
|---|---|
| Match requests coming from a given IP (IPv4) | ClientIP(`10.76.105.11`) |
| Match requests coming from a given IP (IPv6) | ClientIP(`::1`) |
| Match requests coming from a given subnet (IPv4) | ClientIP(`192.168.1.0/24`) |
| Match requests coming from a given subnet (IPv6) | ClientIP(`fe80::/10`) |
Priority
To avoid path overlap, routes are sorted, by default, in descending order using rules length. The priority is directly equal to the length of the rule, and so the longest length has the highest priority.
A value of 0 for the priority is ignored: priority: 0 means that the default rules length sorting is used.
Traefik reserves a range of priorities for its internal routers, the maximum user-defined router priority value is:
(MaxInt32 - 1000)for 32-bit platforms,(MaxInt64 - 1000)for 64-bit platforms.
Example
In the example below, all requests with host foobar.traefik.com will be routed through
Router-1 instead of Router-2, because Router-1 has a higher priority than Router-2.
| Name | Rule | Priority |
|---|---|---|
| Router-1 | HostRegexp(`[a-z]+\.traefik\.com`) | 34 |
| Router-2 | Host(`foobar.traefik.com`) | 26 |
If you set the option priority: 2 to Router-1, it allows Router-2 to handle requests with the foobar.traefik.com host.