- Resource: GrpcRoute
- RouteRule
- RouteMatch
- MethodMatch
- Type
- HeaderMatch
- Type
- RouteAction
- Destination
- FaultInjectionPolicy
- Delay
- Abort
- RetryPolicy
- StatefulSessionAffinityPolicy
- Methods
Resource: GrpcRoute
GrpcRoute is the resource defining how gRPC traffic routed by a Mesh or Gateway resource is routed.
JSON representation |
---|
{
"name": string,
"selfLink": string,
"createTime": string,
"updateTime": string,
"labels": {
string: string,
...
},
"description": string,
"hostnames": [
string
],
"meshes": [
string
],
"gateways": [
string
],
"rules": [
{
object ( |
Fields | |
---|---|
name |
Required. Name of the GrpcRoute resource. It matches pattern |
selfLink |
Output only. Server-defined URL of this resource |
createTime |
Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. The timestamp when the resource was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
labels |
Optional. Set of label tags associated with the GrpcRoute resource. An object containing a list of |
description |
Optional. A free-text description of the resource. Max length 1024 characters. |
hostnames[] |
Required. Service hostnames with an optional port for which this route describes traffic. Format: Hostname is the fully qualified domain name of a network host. This matches the RFC 1123 definition of a hostname with 2 notable exceptions: - IPs are not allowed. - A hostname may be prefixed with a wildcard label ( Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateway must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames If a port is specified, then gRPC clients must use the channel URI with the port to match this rule (i.e. "xds:///service:123"), otherwise they must supply the URI without a port (i.e. "xds:///service"). |
meshes[] |
Optional. Meshes defines a list of meshes this GrpcRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: |
gateways[] |
Optional. Gateways defines a list of gateways this GrpcRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: |
rules[] |
Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied. |
RouteRule
Describes how to route traffic.
JSON representation |
---|
{ "matches": [ { object ( |
Fields | |
---|---|
matches[] |
Optional. Matches define conditions used for matching the rule against incoming gRPC requests. Each match is independent, i.e. this rule will be matched if ANY one of the matches is satisfied. If no matches field is specified, this rule will unconditionally match traffic. |
action |
Required. A detailed rule defining how to route traffic. This field is required. |
RouteMatch
Criteria for matching traffic. A RouteMatch will be considered to match when all supplied fields match.
JSON representation |
---|
{ "headers": [ { object ( |
Fields | |
---|---|
headers[] |
Optional. Specifies a collection of headers to match. |
method |
Optional. A gRPC method to match against. If this field is empty or omitted, will match all methods. |
MethodMatch
Specifies a match against a method.
JSON representation |
---|
{
"type": enum ( |
Fields | |
---|---|
type |
Optional. Specifies how to match against the name. If not specified, a default value of "EXACT" is used. |
grpcService |
Required. Name of the service to match against. If unspecified, will match all services. |
grpcMethod |
Required. Name of the method to match against. If unspecified, will match all methods. |
caseSensitive |
Optional. Specifies that matches are case sensitive. The default value is true. caseSensitive must not be used with a type of REGULAR_EXPRESSION. |
Type
The type of the match.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Unspecified. |
EXACT |
Will only match the exact name provided. |
REGULAR_EXPRESSION |
Will interpret grpcMethod and grpcService as regexes. RE2 syntax is supported. |
HeaderMatch
A match against a collection of headers.
JSON representation |
---|
{
"type": enum ( |
Fields | |
---|---|
type |
Optional. Specifies how to match against the value of the header. If not specified, a default value of EXACT is used. |
key |
Required. The key of the header. |
value |
Required. The value of the header. |
Type
The type of match.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Unspecified. |
EXACT |
Will only match the exact value provided. |
REGULAR_EXPRESSION |
Will match paths conforming to the prefix specified by value. RE2 syntax is supported. |
RouteAction
Specifies how to route matched traffic.
JSON representation |
---|
{ "destinations": [ { object ( |
Fields | |
---|---|
destinations[] |
Optional. The destination services to which traffic should be forwarded. If multiple destinations are specified, traffic will be split between Backend Service(s) according to the weight field of these destinations. |
faultInjectionPolicy |
Optional. The specification for fault injection introduced into traffic to test the resiliency of clients to destination service failure. As part of fault injection, when clients send requests to a destination, delays can be introduced on a percentage of requests before sending those requests to the destination service. Similarly requests from clients can be aborted by for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a faultInjectionPolicy |
timeout |
Optional. Specifies the timeout for selected route. Timeout is computed from the time the request has been fully processed (i.e. end of stream) up until the response has been completely processed. Timeout includes all retries. A duration in seconds with up to nine fractional digits, ending with ' |
retryPolicy |
Optional. Specifies the retry policy associated with this route. |
statefulSessionAffinity |
Optional. Specifies cookie-based stateful session affinity. |
idleTimeout |
Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled. A duration in seconds with up to nine fractional digits, ending with ' |
Destination
The destination to which traffic will be routed.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field destination_type . Specifies the kind of destination to which traffic will be routed. destination_type can be only one of the following: |
|
serviceName |
Required. The URL of a destination service to which to route traffic. Must refer to either a BackendService or ServiceDirectoryService. |
weight |
Optional. Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. This is computed as: - weight/Sum(weights in this destination list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. If only one serviceName is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weights are specified for any one service name, they need to be specified for all of them. If weights are unspecified for all services, then, traffic is distributed in equal proportions to all of them. |
FaultInjectionPolicy
The specification for fault injection introduced into traffic to test the resiliency of clients to destination service failure. As part of fault injection, when clients send requests to a destination, delays can be introduced on a percentage of requests before sending those requests to the destination service. Similarly requests from clients can be aborted by for a percentage of requests.
JSON representation |
---|
{ "delay": { object ( |
Fields | |
---|---|
delay |
The specification for injecting delay to client requests. |
abort |
The specification for aborting to client requests. |
Delay
Specification of how client requests are delayed as part of fault injection before being sent to a destination.
JSON representation |
---|
{ "fixedDelay": string, "percentage": integer } |
Fields | |
---|---|
fixedDelay |
Specify a fixed delay before forwarding the request. A duration in seconds with up to nine fractional digits, ending with ' |
percentage |
The percentage of traffic on which delay will be injected. The value must be between [0, 100] |
Abort
Specification of how client requests are aborted as part of fault injection before being sent to a destination.
JSON representation |
---|
{ "httpStatus": integer, "percentage": integer } |
Fields | |
---|---|
httpStatus |
The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. |
percentage |
The percentage of traffic which will be aborted. The value must be between [0, 100] |
RetryPolicy
The specifications for retries.
JSON representation |
---|
{ "retryConditions": [ string ], "numRetries": integer } |
Fields | |
---|---|
retryConditions[] |
|
numRetries |
Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1. |
StatefulSessionAffinityPolicy
The specification for cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name "GSSA" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy.
The gRPC proxyless mesh library or sidecar proxy will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next.
JSON representation |
---|
{ "cookieTtl": string } |
Fields | |
---|---|
cookieTtl |
Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 1 to 86400 seconds (24 hours) inclusive. A duration in seconds with up to nine fractional digits, ending with ' |
Methods |
|
---|---|
|
Creates a new GrpcRoute in a given project and location. |
|
Deletes a single GrpcRoute. |
|
Gets details of a single GrpcRoute. |
|
Gets the access control policy for a resource. |
|
Lists GrpcRoutes in a given project and location. |
|
Updates the parameters of a single GrpcRoute. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |