virtual_service.proto

Package: gateway.solo.io

Types:

• VirtualService Top-Level Resource
• VirtualHost
• Route
• DelegateOptionsRefs
• DelegateAction
• RouteTableSelector
• Expression
• Operator

Source File: github.com/solo-io/gloo/projects/gateway/api/v1/virtual_service.proto

VirtualService

The VirtualService is the root routing object for the Gloo Gateway. A virtual service describes the set of routes to match for a set of domains.

It defines:

• a set of domains
• the root set of routes for those domains
• an optional SSL configuration for server TLS Termination
• VirtualHostOptions that will apply configuration to all routes that live on the VirtualService.

Domains must be unique across all virtual services within a gateway (i.e. no overlap between sets).

VirtualServices can delegate routing behavior to the RouteTable resource by using the delegateAction on routes.

An example configuration using two VirtualServices (one with TLS termination and one without) which share a RouteTable looks as follows:

# HTTP VirtualService:
apiVersion: gateway.solo.io/v1
kind: VirtualService
metadata:
  name: 'http'
  namespace: 'usernamespace'
spec:
  virtualHost:
    domains:
    - '*.mydomain.com'
    - 'mydomain.com'
    routes:
    - matchers:
      - prefix: '/'
      # delegate all traffic to the `shared-routes` RouteTable
      delegateAction:
        ref:
          name: 'shared-routes'
          namespace: 'usernamespace'

# HTTPS VirtualService:
apiVersion: gateway.solo.io/v1
kind: VirtualService
metadata:
  name: 'https'
  namespace: 'usernamespace'
spec:
  virtualHost:
    domains:
    - '*.mydomain.com'
    - 'mydomain.com'
    routes:
    - matchers:
      - prefix: '/'
      # delegate all traffic to the `shared-routes` RouteTable
      delegateAction:
        ref:
          name: 'shared-routes'
          namespace: 'usernamespace'
  sslConfig:
    secretRef:
      name: gateway-tls
      namespace: gloo-system

# the RouteTable shared by both VirtualServices:
apiVersion: gateway.solo.io/v1
kind: RouteTable
metadata:
  name: 'shared-routes'
  namespace: 'usernamespace'
spec:
  routes:
    - matchers:
      - prefix: '/some-route'
      routeAction:
        single:
          upstream:
            name: 'some-upstream'
     ...

Delegated Routes are routes that use the delegateAction routing action. Delegated Routes obey the following constraints:

• delegate routes must use prefix path matchers
• delegated routes cannot specify header, query, or methods portion of the normal route matcher.
• routeOptions configuration will be inherited from parent routes, but can be overridden by the child

"virtualHost": .gateway.solo.io.VirtualHost
"sslConfig": .gloo.solo.io.SslConfig
"displayName": string
"namespacedStatuses": .core.solo.io.NamespacedStatuses
"metadata": .core.solo.io.Metadata

VirtualHost

Virtual Hosts serve an ordered list of routes for a set of domains.

An HTTP request is first matched to a virtual host based on its host header, then to a route within the virtual host.

If a request is not matched to any virtual host or a route therein, the target proxy will reply with a 404.

Unlike the Gloo Virtual Host, Gateway Virtual Hosts can delegate their routes to RouteTables.

"domains": []string
"routes": []gateway.solo.io.Route
"options": .gloo.solo.io.VirtualHostOptions
"optionsConfigRefs": .gateway.solo.io.DelegateOptionsRefs

Route

A route specifies how to match a request and what action to take when the request is matched.

When a request matches on a route, the route can perform one of the following actions:

• Route the request to a destination
• Reply with a Direct Response
• Send a Redirect response to the client
• Delegate the action for the request to one or more top-level RouteTable resources DelegateActions can be used to delegate the behavior for a set out routes with a given prefix to top-level RouteTable resources.

"matchers": []matchers.core.gloo.solo.io.Matcher
"inheritableMatchers": .google.protobuf.BoolValue
"inheritablePathMatchers": .google.protobuf.BoolValue
"routeAction": .gloo.solo.io.RouteAction
"redirectAction": .gloo.solo.io.RedirectAction
"directResponseAction": .gloo.solo.io.DirectResponseAction
"delegateAction": .gateway.solo.io.DelegateAction
"graphqlApiRef": .core.solo.io.ResourceRef
"options": .gloo.solo.io.RouteOptions
"name": string
"optionsConfigRefs": .gateway.solo.io.DelegateOptionsRefs

DelegateOptionsRefs

"delegateOptions": []core.solo.io.ResourceRef

DelegateAction

DelegateActions are used to delegate routing decisions to Route Tables.

"name": string
"namespace": string
"ref": .core.solo.io.ResourceRef
"selector": .gateway.solo.io.RouteTableSelector

RouteTableSelector

Select route tables for delegation by namespace, labels, or both.

"namespaces": []string
"labels": map<string, string>
"expressions": []gateway.solo.io.RouteTableSelector.Expression

Expression

"key": string
"operator": .gateway.solo.io.RouteTableSelector.Expression.Operator
"values": []string

Operator

Route Table Selector expression operator, while the set-based syntax differs from Kubernetes (kubernetes: key: !mylabel, gloo: key: mylabel, operator: "!" | kubernetes: key: mylabel, gloo: key: mylabel, operator: exists), the functionality remains the same.