Skip to main content

Grpc Route

GrpcRoute​

Defines the high-level intent for routing gRPC traffic.

The engine turns it into service mesh or load balancer configuration. It supports method-level routing, retry policies, and timeouts.

PropertyTypeDescription
apiVersionstringAPI schema version. Must be lowops.manifests.v1.
kindstringResource kind. Must be GrpcRoute.
metadatamapFree-form key/value labels. The engine reads reserved keys (for example name, project) to resolve the identity of this manifest and its parent ingress (PublicIngress or PrivateIngress).
specSpecDesired gRPC route configuration. See Spec.

Target​

Resolved backend target of the route.

NOT YET IMPLEMENTED. The engine ignores this message and never sets it.

PropertyTypeDescription
kindstringTarget resource kind.
namestringName of the resolved backend target manifest.

Spec​

User-defined gRPC routing rules.

The engine turns the rules into mesh gRPC route rules on the parent ingress.

PropertyTypeDescription
descriptionstringOptional free text. It appears in generated documentation, and AI assistants use it as context. The engine does not use it otherwise.
ruleslist of GrpcRouteRuleOrdered list of match/forward rules. See GrpcRouteRule. Each rule becomes a mesh gRPC route rule bound to a hostname from the manifest name. A rule can set service/method matching, retries, timeouts, and fault injection.

GrpcRouteRule​

gRPC routing rule.

Pairs match conditions with an action.

PropertyTypeDescription
matcheslist of GrpcRouteRuleMatchConditions that select requests for this rule. A request matches if any condition holds.
authenticationlist of RouteRuleAuthenticationConfigAuthentication configuration. If not set, the rule needs no authentication.
authorizationlist of ComputedAuthorizationAccessRuleCheckAuthorization configuration. If not set, the rule is open to all users.

ComputedAuthorizationAccessRuleCheck​

Computed access check for a route rule.

The identity tuple (namespace, relation, object) that the authorization extension checks.

PropertyTypeDescription
namespacestringCopy of spec.authorization.namespace of the child HttpRoute or GrpcRoute manifest.
relationstringCopy of spec.authorization.relation of the child HttpRoute or GrpcRoute manifest.
objectstringCopy of spec.authorization.object of the child HttpRoute or GrpcRoute manifest.

RouteRuleAuthenticationConfig​

Authentication exceptions for a route rule.

Sets how authentication works for the paths that the rule matches.

PropertyTypeDescription
typestringIDENTITY_PROVIDER limits access to the identity providers in tenants. INTERNAL limits access to internal callers. Validation checks it against the declared identity providers.
tenantslist of stringIdentityProvider names that can access this route. Only for type IDENTITY_PROVIDER. Each entry must reference a provider that exists.

GrpcRouteRuleMatch​

Match criteria for a gRPC request.

Selects requests by metadata or by service and method.

PropertyTypeDescription
headerslist of GrpcRouteRuleMatchHeaderConditions on gRPC metadata. All must match.
methodMethodMatchRestricts the rule to a gRPC service and method.

GrpcRouteRuleMatchHeader​

Condition on gRPC metadata.

Selects requests by custom metadata, the gRPC equivalent of HTTP headers.

PropertyTypeDescription
keystringName of the metadata entry to test.
valuestringExpected value of the entry. type sets whether it is an exact value or a regular expression.
typestringHow to compare value: EXACT for a literal match or REGULAR_EXPRESSION for a regex match. TYPE_UNSPECIFIED means EXACT.

MethodMatch​

Match by gRPC service or method.

The main routing condition of a gRPC route, in place of a URL path match.

PropertyTypeDescription
grpcServicestringFully qualified gRPC service name, for example package.Service.
grpcMethodstringMethod of the service.
caseSensitiveboolIf true, service and method names are case-sensitive.