References
Proto: references.proto
Package: common.gloo.solo.io
Types:
DestinationReference
Destinations are pointers to routable destinations for routes. Each destination should resolve to one and only one hostname.
Destinations can refer to a variety of object types. The behavior of the route action
will vary depending on the type of destination selected. Defaults to the kubernetes v1/Service.
Currently supported destination types:
- Service
- VirtualDestination (route traffic to one of the VirtualDestination's backing services, based on the locality of the request)
- ExternalService (route traffic to a static set of service endpoints external to the mesh)
- CloudProvider (route traffic to a cloud provider, selected using the functionCall field)
| Field | Description |
|---|---|
ref |
(ObjectReference)reference to the destination object by its metadata |
kind |
(DestinationKind)the kind of destination being selected. defaults to Kubernetes Service. |
port |
(PortSelector)the port on the destination object being targeted. required if the object provides more than one port. |
subset |
(repeated DestinationReference.SubsetEntry)select a subset of the destination's endpoints for routing based on their labels. Not applicable for a CloudProvider destination. |
weight |
(uint32)Specify the proportion of traffic to be forwarded to this destination. Weights across all of the destinations must sum to 100. Weight is only relevant when used in the context of a route with multiple destinations. |
function |
(FunctionDestinationSpec) |
DestinationReference.SubsetEntry
| Field | Description |
|---|---|
key |
(string) |
value |
(string) |
ListenerPortReference
ListenerPortReference identifies a single listener in a VirtualGateway by port number
| Field | Description |
|---|---|
gatewayRef |
(ObjectReference)The gateway containing the listener. |
port |
(uint32)The port of the listener on the gateway. |
ObjectReference
reference to a Kubernetes API object. Kube API objects are referenced explicitly by the namespace and cluster containing them.
| Field | Description |
|---|---|
name |
(string)the name of the object |
namespace |
(string)the namespace of the object. if the field is omitted, Gloo Mesh will use the same namespace as the parent object containing this reference. |
cluster |
(string)the cluster of the object. if the field is omitted, Gloo Mesh will use the same cluster as the parent object containing this reference. |
ObjectReferenceList
| Field | Description |
|---|---|
refs |
(repeated ObjectReference) |
WorkloadReference
| Field | Description |
|---|---|
ref |
(ObjectReference) |
kind |
(WorkloadReference.WorkloadKind) |
WorkloadReference.WorkloadKind
References the supported types for the Workload interface in pkg/utils/workloadutils/workload_types.go
| Name | Number | Description |
|---|---|---|
UNRECOGNIZED_WORKLOAD |
0 | Default value for unsupported workload kind |
DEPLOYMENT |
1 | |
DAEMON_SET |
2 | |
STATEFUL_SET |
3 | |
REPLICA_SET |
4 |