grpc_routes

Creates, updates, deletes, gets or lists a grpc_routes resource.

Overview

Name	grpc_routes
Type	Resource
Id	google.networkservices.grpc_routes

Fields

Name	Datatype	Description
name	string	Identifier. Name of the GrpcRoute resource. It matches pattern projects/*/locations/global/grpcRoutes/
description	string	Optional. A free-text description of the resource. Max length 1024 characters.
createTime	string	Output only. The timestamp when the resource was created.
gateways	array	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: projects/*/locations/global/gateways/
hostnames	array	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 (*.). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. foo.example.com) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. *.example.com). 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 *.foo.bar.com and *.bar.com to be associated with the same route, it is not possible to associate two routes both with *.bar.com or both with bar.com. 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").
labels	object	Optional. Set of label tags associated with the GrpcRoute resource.
meshes	array	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: projects/*/locations/global/meshes/
rules	array	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.
selfLink	string	Output only. Server-defined URL of this resource
updateTime	string	Output only. The timestamp when the resource was updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	grpcRoutesId, locationsId, projectsId	Gets details of a single GrpcRoute.
list	SELECT	locationsId, projectsId	Lists GrpcRoutes in a given project and location.
create	INSERT	locationsId, projectsId	Creates a new GrpcRoute in a given project and location.
delete	DELETE	grpcRoutesId, locationsId, projectsId	Deletes a single GrpcRoute.
patch	UPDATE	grpcRoutesId, locationsId, projectsId	Updates the parameters of a single GrpcRoute.

SELECT examples

Lists GrpcRoutes in a given project and location.

SELECT
name,
description,
createTime,
gateways,
hostnames,
labels,
meshes,
rules,
selfLink,
updateTime
FROM google.networkservices.grpc_routes
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new grpc_routes resource.

All Properties

/*+ create */
INSERT INTO google.networkservices.grpc_routes (
locationsId,
projectsId,
name,
labels,
description,
hostnames,
meshes,
gateways,
rules
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ labels }}',
'{{ description }}',
'{{ hostnames }}',
'{{ meshes }}',
'{{ gateways }}',
'{{ rules }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: selfLink
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: labels
      value: object
    - name: description
      value: string
    - name: hostnames
      value:
        - string
    - name: meshes
      value:
        - string
    - name: gateways
      value:
        - string
    - name: rules
      value:
        - - name: matches
            value:
              - - name: method
                  value:
                    - name: type
                      value: string
                    - name: grpcService
                      value: string
                    - name: grpcMethod
                      value: string
                    - name: caseSensitive
                      value: boolean
                - name: headers
                  value:
                    - - name: type
                        value: string
                      - name: key
                        value: string
                      - name: value
                        value: string
          - name: action
            value:
              - name: destinations
                value:
                  - - name: serviceName
                      value: string
                    - name: weight
                      value: integer
              - name: faultInjectionPolicy
                value:
                  - name: delay
                    value:
                      - name: fixedDelay
                        value: string
                      - name: percentage
                        value: integer
                  - name: abort
                    value:
                      - name: httpStatus
                        value: integer
                      - name: percentage
                        value: integer
              - name: timeout
                value: string
              - name: retryPolicy
                value:
                  - name: retryConditions
                    value:
                      - string
                  - name: numRetries
                    value: integer
              - name: statefulSessionAffinity
                value:
                  - name: cookieTtl
                    value: string
              - name: idleTimeout
                value: string

UPDATE example

Updates a grpc_routes resource.

/*+ update */
UPDATE google.networkservices.grpc_routes
SET 
name = '{{ name }}',
labels = '{{ labels }}',
description = '{{ description }}',
hostnames = '{{ hostnames }}',
meshes = '{{ meshes }}',
gateways = '{{ gateways }}',
rules = '{{ rules }}'
WHERE 
grpcRoutesId = '{{ grpcRoutesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified grpc_routes resource.

/*+ delete */
DELETE FROM google.networkservices.grpc_routes
WHERE grpcRoutesId = '{{ grpcRoutesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';