base.proto

Package: solo.io.envoy.config.core.v3 Types:

• Locality
• BuildVersion
• Extension
• Node
• Metadata
• RuntimeUInt32
• RuntimeDouble
• RuntimeFeatureFlag
• HeaderValue
• HeaderValueOption
• HeaderMap
• DataSource
• RetryPolicy
• RemoteDataSource
• AsyncDataSource
• TransportSocket
• RuntimeFractionalPercent
• ControlPlane

Enums:

- [RoutingPriority](#routingpriority)
- [RequestMethod](#requestmethod)
- [TrafficDirection](#trafficdirection)

Source File: github.com/solo-io/gloo/projects/gloo/api/external/envoy/config/core/v3/base.proto

Locality

Identifies location of where either Envoy runs or where upstream hosts run.

"region": string
"zone": string
"subZone": string

BuildVersion

BuildVersion combines SemVer version of extension with free-form build information (i.e. ‘alpha’, ‘private-build’) as a set of strings.

"version": .solo.io.envoy.type.v3.SemanticVersion
"metadata": .google.protobuf.Struct

Extension

Version and identification for an Envoy extension.

"name": string
"category": string
"typeDescriptor": string
"version": .solo.io.envoy.config.core.v3.BuildVersion
"disabled": bool

Node

Identifies a specific Envoy instance. The node identifier is presented to the management server, which may use this identifier to distinguish per Envoy configuration for serving.

"id": string
"cluster": string
"metadata": .google.protobuf.Struct
"locality": .solo.io.envoy.config.core.v3.Locality
"userAgentName": string
"userAgentVersion": string
"userAgentBuildVersion": .solo.io.envoy.config.core.v3.BuildVersion
"extensions": []solo.io.envoy.config.core.v3.Extension
"clientFeatures": []string
"listeningAddresses": []solo.io.envoy.config.core.v3.Address

Metadata

Metadata provides additional inputs to filters based on matched listeners, filter chains, routes and endpoints. It is structured as a map, usually from filter name (in reverse DNS format) to metadata specific to the filter. Metadata key-values for a filter are merged as connection and request handling occurs, with later values for the same key overriding earlier values.

An example use of metadata is providing additional values to http_connection_manager in the envoy.http_connection_manager.access_log namespace.

Another example use of metadata is to per service config info in cluster metadata, which may get consumed by multiple filters.

For load balancing, Metadata provides a means to subset cluster endpoints. Endpoints have a Metadata object associated and routes contain a Metadata object to match against. There are some well defined metadata used today for this purpose:

• {"envoy.lb": {"canary": <bool> }} This indicates the canary status of an endpoint and is also used during header processing (x-envoy-upstream-canary) and for stats purposes. [#next-major-version: move to type/metadata/v2]

"filterMetadata": map<string, .google.protobuf.Struct>

RuntimeUInt32

Runtime derived uint32 with a default when not specified.

"defaultValue": int
"runtimeKey": string

RuntimeDouble

Runtime derived double with a default when not specified.

"defaultValue": float
"runtimeKey": string

RuntimeFeatureFlag

Runtime derived bool with a default when not specified.

"defaultValue": .google.protobuf.BoolValue
"runtimeKey": string

HeaderValue

Header name/value pair.

"key": string
"value": string

HeaderValueOption

Header name/value pair plus option to control append behavior.

"header": .solo.io.envoy.config.core.v3.HeaderValue
"append": .google.protobuf.BoolValue

HeaderMap

Wrapper for a set of headers.

"headers": []solo.io.envoy.config.core.v3.HeaderValue

DataSource

Data source consisting of either a file or an inline value.

"filename": string
"inlineBytes": bytes
"inlineString": string

RetryPolicy

The message specifies the retry policy of remote data source when fetching fails.

"retryBackOff": .solo.io.envoy.config.core.v3.BackoffStrategy
"numRetries": .google.protobuf.UInt32Value

RemoteDataSource

The message specifies how to fetch data from remote and how to verify it.

"httpUri": .solo.io.envoy.config.core.v3.HttpUri
"sha256": string
"retryPolicy": .solo.io.envoy.config.core.v3.RetryPolicy

AsyncDataSource

Async data source which support async data fetch.

"local": .solo.io.envoy.config.core.v3.DataSource
"remote": .solo.io.envoy.config.core.v3.RemoteDataSource

TransportSocket

Configuration for transport socket in listeners and clusters <envoy_api_msg_config.cluster.v3.Cluster>`. If the configuration is empty, a default transport socket implementation and configuration will be chosen based on the platform and existence of tls_context.

"name": string
"typedConfig": .google.protobuf.Any

RuntimeFractionalPercent

Runtime derived FractionalPercent with defaults for when the numerator or denominator is not specified via a runtime key.

Note:

Parsing of the runtime key’s data is implemented such that it may be represented as a FractionalPercent proto represented as JSON/YAML and may also be represented as an integer with the assumption that the value is an integral percentage out of 100. For instance, a runtime key lookup returning the value “42” would parse as a FractionalPercent whose numerator is 42 and denominator is HUNDRED.

"defaultValue": .solo.io.envoy.type.v3.FractionalPercent
"runtimeKey": string

ControlPlane

Identifies a specific ControlPlane instance that Envoy is connected to.

"identifier": string

RoutingPriority

Description: Envoy supports upstream priority routing <arch_overview_http_routing_priority>` both at the route and the virtual cluster level. The current priority implementation uses different connection pool and circuit breaking settings for each priority level. This means that even for HTTP/2 requests, two physical connections will be used to an upstream host. In the future Envoy will likely support true HTTP/2 priority over a single upstream connection.

RequestMethod

Description: HTTP request method.

TrafficDirection

Description: Identifies the direction of the traffic relative to the local Envoy.