status-im/consul
2
0
Fork 0
mirror of https://github.com/status-im/consul.git synced 2025-02-02 08:56:43 +00:00
Code Issues Projects Releases Wiki Activity

docs: fixing L7 config entries documentation (#6358)

Browse Source 
- add service-router example involving gRPC
- fix indentation on service-router page by splitting it up
- remove reference to removed setting
This commit is contained in:
R.B. Boyer 2019-08-21 12:17:38 -05:00 committed by R.B. Boyer
parent 33c09f80c8
commit 65fc93ea33
2 changed files with 105 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
website/source/docs/agent/config-entries/service-resolver.html.md
View File

@ -146,14 +146,6 @@ name = "web"
- `Datacenters` `(array<string>)` - A fixed list of datacenters to try during - `Datacenters` `(array<string>)` - A fixed list of datacenters to try during
failover. failover.
- `OverprovisioningFactor` `(int: 0)` - OverprovisioningFactor is a pass
through for envoy's
[`overprovisioning_factor`](https://www.envoyproxy.io/docs/envoy/v1.10.0/intro/arch_overview/load_balancing/priority)
value.
If omitted the overprovisioning factor value will be set so high as to
imply binary failover (all or nothing).
## Service Subsets ## Service Subsets
A service subset assigns a concrete name to a specific subset of discoverable A service subset assigns a concrete name to a specific subset of discoverable

156
website/source/docs/agent/config-entries/service-router.html.md
View File

@ -98,6 +98,28 @@ routes = [
] ]
``` ```
Re-route a gRPC method to another service. Since gRPC method calls [are
HTTP2](https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md), we can use an HTTP path match rule to re-route traffic:
```hcl
kind = "service-router"
name = "billing"
routes = [
{
match {
http {
path_exact = "/mycompany.BillingService/GenerateInvoice"
}
}
destination {
service = "invoice-generator"
}
},
# NOTE: a default catch-all will send unmatched traffic to "billing"
]
```
## Available Fields ## Available Fields
- `Kind` - Must be set to `service-router` - `Kind` - Must be set to `service-router`
@ -112,120 +134,124 @@ routes = [
- `Match` `(ServiceRouteMatch: <optional>)` - A set of criteria that can - `Match` `(ServiceRouteMatch: <optional>)` - A set of criteria that can
match incoming L7 requests. If empty or omitted it acts as a catch-all. match incoming L7 requests. If empty or omitted it acts as a catch-all.
- `HTTP` `(ServiceRouteHTTPMatch: <optional>)` - A set of http-specific match criteria. - `HTTP` `(ServiceRouteHTTPMatch: <optional>)` - A set of
[http-specific match criteria](#serviceroutehttpmatch).
- `PathExact` `(string: "")` - Exact path to match on the HTTP request path. - `Destination` `(ServiceRouteDestination: <optional>)` - Controls [how to
proxy](#serviceroutedestination) the matching request(s) to a
service.
### `ServiceRouteHTTPMatch`
- `PathExact` `(string: "")` - Exact path to match on the HTTP request path.
At most only one of `PathExact`, `PathPrefix`, or `PathRegex` may be configured. At most only one of `PathExact`, `PathPrefix`, or `PathRegex` may be configured.
- `PathPrefix` `(string: "")` - Path prefix to match on the HTTP request path. - `PathPrefix` `(string: "")` - Path prefix to match on the HTTP request path.
At most only one of `PathExact`, `PathPrefix`, or `PathRegex` may be configured. At most only one of `PathExact`, `PathPrefix`, or `PathRegex` may be configured.
- `PathRegex` `(string: "")` - Regular expression to match on the HTTP - `PathRegex` `(string: "")` - Regular expression to match on the HTTP
request path. request path.
The syntax when using the Envoy proxy is [documented here](https://en.cppreference.com/w/cpp/regex/ecmascript). The syntax when using the Envoy proxy is [documented here](https://en.cppreference.com/w/cpp/regex/ecmascript).
At most only one of `PathExact`, `PathPrefix`, or `PathRegex` may be configured. At most only one of `PathExact`, `PathPrefix`, or `PathRegex` may be configured.
- `Header` `(array<ServiceRouteHTTPMatchHeader>)` - A set of criteria - `Header` `(array<ServiceRouteHTTPMatchHeader>)` - A set of criteria that can
that can match on HTTP request headers. If more than one is configured match on HTTP request headers. If more than one is configured all must match
all must match for the overall match to apply. for the overall match to apply.
- `Name` `(string: <required>)` - Name of the header to match on. - `Name` `(string: <required>)` - Name of the header to match.
- `Present` `(bool: false)` - Match if the header with the given name - `Present` `(bool: false)` - Match if the header with the given name is
is present with any value. present with any value.
At most only one of `Exact`, `Prefix`, `Suffix`, `Regex`, or At most only one of `Exact`, `Prefix`, `Suffix`, `Regex`, or `Present`
`Present` may be configured. may be configured.
- `Exact` `(string: "")` - Match if the header with the given name is - `Exact` `(string: "")` - Match if the header with the given name is this
this value. value.
At most only one of `Exact`, `Prefix`, `Suffix`, `Regex`, or At most only one of `Exact`, `Prefix`, `Suffix`, `Regex`, or `Present`
`Present` may be configured. may be configured.
- `Prefix` `(string: "")` - Match if the header with the given name has - `Prefix` `(string: "")` - Match if the header with the given name has
this prefix. this prefix.
At most only one of `Exact`, `Prefix`, `Suffix`, `Regex`, or At most only one of `Exact`, `Prefix`, `Suffix`, `Regex`, or `Present`
`Present` may be configured. may be configured.
- `Suffix` `(string: "")` - Match if the header with the given name has - `Suffix` `(string: "")` - Match if the header with the given name has
this suffix. this suffix.
At most only one of `Exact`, `Prefix`, `Suffix`, `Regex`, or At most only one of `Exact`, `Prefix`, `Suffix`, `Regex`, or `Present`
`Present` may be configured. may be configured.
- `Regex` `(string: "")` - Match if the header with the given name - `Regex` `(string: "")` - Match if the header with the given name matches
this pattern.
The syntax when using the Envoy proxy is [documented here](https://en.cppreference.com/w/cpp/regex/ecmascript).
At most only one of `Exact`, `Prefix`, `Suffix`, `Regex`, or `Present`
may be configured.
- `Invert` `(bool: false)` - Inverts the logic of the match.
- `QueryParam` `(array<ServiceRouteHTTPMatchQueryParam>)` - A set of criteria
that can match on HTTP query parameters. If more than one is configured all
must match for the overall match to apply.
- `Name` `(string: <required>)` - The name of the query parameter to match on.
- `Present` `(bool: false)` - Match if the query parameter with the given
name is present with any value.
At most only one of `Exact`, `Regex`, or `Present` may be configured.
- `Exact` `(string: "")` - Match if the query parameter with the given name
is this value.
At most only one of `Exact`, `Regex`, or `Present` may be configured.
- `Regex` `(string: "")` - Match if the query parameter with the given name
matches this pattern. matches this pattern.
The syntax when using the Envoy proxy is [documented here](https://en.cppreference.com/w/cpp/regex/ecmascript). The syntax when using the Envoy proxy is [documented here](https://en.cppreference.com/w/cpp/regex/ecmascript).
At most only one of `Exact`, `Prefix`, `Suffix`, `Regex`, or
`Present` may be configured.
- `Invert` `(bool: false)` - Inverts the logic of the match.
- `QueryParam` `(array<ServiceRouteHTTPMatchQueryParam>)` - A set of
criteria that can match on HTTP query parameters. If more than one is
configured all must match for the overall match to apply.
- `Name` `(string: <required>)` - The name of the query parameter to
match on.
- `Present` `(bool: false)` - Match if the query parameter with the given name
is present with any value.
At most only one of `Exact`, `Regex`, or `Present` may be configured. At most only one of `Exact`, `Regex`, or `Present` may be configured.
- `Exact` `(string: "")` - Match if the query parameter with the given - `Methods` `(array<string>)` - A list of HTTP methods for which this match
name is this value.
At most only one of `Exact`, `Regex`, or `Present` may be configured.
- `Regex` `(string: "")` - Match if the query parameter with the given
name matches this pattern.
The syntax when using the Envoy proxy is [documented here](https://en.cppreference.com/w/cpp/regex/ecmascript).
At most only one of `Exact`, `Regex`, or `Present` may be configured.
- `Methods` `(array<string>)` - A list of HTTP methods for which this match
applies. If unspecified all http methods are matched. applies. If unspecified all http methods are matched.
- `Destination` `(ServiceRouteDestination: <optional>)` - Controls how to ### `ServiceRouteDestination`
proxy the actual matching request to a service.
- `Service` `(string: "")` - The service to resolve instead of the default - `Service` `(string: "")` - The service to resolve instead of the default
service. If empty then the default service name is used. service. If empty then the default service name is used.
- `ServiceSubset` `(string: "")` - A named subset of the given service to - `ServiceSubset` `(string: "")` - A named subset of the given service to
resolve instead of one defined as that service's `DefaultSubset`. If resolve instead of the one defined as that service's `DefaultSubset`. If empty,
empty the default subset is used. the default subset is used.
- `Namespace` `(string: "")` - The namespace to resolve the service from - `Namespace` `(string: "")` - The namespace to resolve the service from
instead of the current namespace. If empty the current namespace is instead of the current namespace. If empty the current namespace is assumed.
assumed.
- `PrefixRewrite` `(string: "")` - Defines how to rewrite the http request - `PrefixRewrite` `(string: "")` - Defines how to rewrite the HTTP request path
path before proxying it to its final destination. before proxying it to its final destination.
This requires that either `Match.HTTP.PathPrefix` or This requires that either `Match.HTTP.PathPrefix` or
`Match.HTTP.PathExact` be configured on this route. `Match.HTTP.PathExact` be configured on this route.
- `RequestTimeout` `(duration: 0s)` - The total amount of time permitted - `RequestTimeout` `(duration: 0s)` - The total amount of time permitted for
for the entire downstream request (and retries) to be processed. the entire downstream request (and retries) to be processed.
- `NumRetries` `(int: 0)` - The number of times to retry the request when a - `NumRetries` `(int: 0)` - The number of times to retry the request when a
retryable result occurs. retryable result occurs.
- `RetryOnConnectFailure` `(bool: false)` - Allows for connection failure - `RetryOnConnectFailure` `(bool: false)` - Allows for connection failure
errors to trigger a retry. errors to trigger a retry.
- `RetryOnStatusCodes` `(array<int>)` - A flat list of http response status - `RetryOnStatusCodes` `(array<int>)` - A flat list of http response status
codes that are eligible for retry. codes that are eligible for retry.
## ACLs ## ACLs