options.proto

Package: gloo.solo.io

Types:

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

ListenerOptions

Optional, feature-specific configuration that lives on gateways. Each ListenerOption object contains configuration for a specific feature. Note to developers: new Listener plugins must be added to this struct to be usable by Gloo. (plugins currently need to be compiled into Gloo)

"accessLoggingService": .als.options.gloo.solo.io.AccessLoggingService
"extensions": .gloo.solo.io.Extensions
"perConnectionBufferLimitBytes": .google.protobuf.UInt32Value

Field Type Description Default
accessLoggingService .als.options.gloo.solo.io.AccessLoggingService
extensions .gloo.solo.io.Extensions Extensions will be passed along from Listeners, Gateways, VirtualServices, Routes, and Route tables to the underlying Proxy, making them useful for controllers, validation tools, etc. which interact with kubernetes yaml. Some sample use cases: * controllers, deployment pipelines, helm charts, etc. which wish to use extensions as a kind of opaque metadata. * In the future, Gloo may support gRPC-based plugins which communicate with the Gloo translator out-of-process. Opaque Extensions enables development of out-of-process plugins without requiring recompiling & redeploying Gloo’s API.
perConnectionBufferLimitBytes .google.protobuf.UInt32Value Soft limit on size of the listener’s new connection read and write buffers. If unspecified, defaults to 1MiB For more info, check out the Envoy docs.

HttpListenerOptions

Optional, feature-specific configuration that lives on http listeners

"grpcWeb": .grpc_web.options.gloo.solo.io.GrpcWeb
"httpConnectionManagerSettings": .hcm.options.gloo.solo.io.HttpConnectionManagerSettings
"healthCheck": .healthcheck.options.gloo.solo.io.HealthCheck
"extensions": .gloo.solo.io.Extensions
"waf": .waf.options.gloo.solo.io.Settings
"dlp": .dlp.options.gloo.solo.io.FilterConfig
"wasm": .wasm.options.gloo.solo.io.PluginSource
"extauth": .enterprise.gloo.solo.io.Settings
"ratelimitServer": .ratelimit.options.gloo.solo.io.Settings
"gzip": .envoy.config.filter.http.gzip.v2.Gzip
"proxyLatency": .envoy.config.filter.http.proxylatency.v2.ProxyLatency
"buffer": .envoy.extensions.filters.http.buffer.v3.Buffer
"grpcJsonTranscoder": .grpc_json.options.gloo.solo.io.GrpcJsonTranscoder

Field Type Description Default
grpcWeb .grpc_web.options.gloo.solo.io.GrpcWeb
httpConnectionManagerSettings .hcm.options.gloo.solo.io.HttpConnectionManagerSettings
healthCheck .healthcheck.options.gloo.solo.io.HealthCheck enable Envoy health checks on this listener.
extensions .gloo.solo.io.Extensions Extensions will be passed along from Listeners, Gateways, VirtualServices, Routes, and Route tables to the underlying Proxy, making them useful for controllers, validation tools, etc. which interact with kubernetes yaml. Some sample use cases: * controllers, deployment pipelines, helm charts, etc. which wish to use extensions as a kind of opaque metadata. * In the future, Gloo may support gRPC-based plugins which communicate with the Gloo translator out-of-process. Opaque Extensions enables development of out-of-process plugins without requiring recompiling & redeploying Gloo’s API.
waf .waf.options.gloo.solo.io.Settings Enterprise-only: Config for Web Application Firewall (WAF), supporting the popular ModSecurity 3.0 ruleset.
dlp .dlp.options.gloo.solo.io.FilterConfig Enterprise-only: Config for data loss prevention.
wasm .wasm.options.gloo.solo.io.PluginSource Wasm filter config [very-experimental!] Currently these extensions will only work if Gloo deployed using the helm flag, wasm.enabled=true These require a special nightly version of envoy which is not deployed by default.
extauth .enterprise.gloo.solo.io.Settings Enterprise-only: External auth related settings.
ratelimitServer .ratelimit.options.gloo.solo.io.Settings Enterprise-only: Settings for the rate limiting server itself.
gzip .envoy.config.filter.http.gzip.v2.Gzip Gzip is an HTTP option which enables Gloo to compress data returned from an upstream service upon client request. Compression is useful in situations where large payloads need to be transmitted without compromising the response time. Example: gzip: contentType: - "application/json" compressionLevel: BEST.
proxyLatency .envoy.config.filter.http.proxylatency.v2.ProxyLatency Enterprise-only: Proxy latency.
buffer .envoy.extensions.filters.http.buffer.v3.Buffer Buffer can be used to set the maximum request size that the filter will buffer before the connection manager will stop buffering and return a 413 response.
grpcJsonTranscoder .grpc_json.options.gloo.solo.io.GrpcJsonTranscoder Exposed envoy config for the gRPC to JSON transcoding filter, envoy.filters.http.grpc_json_transcoder. For more, see https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/http/grpc_json_transcoder/v3/transcoder.proto.

TcpListenerOptions

Optional, feature-specific configuration that lives on tcp listeners

"tcpProxySettings": .tcp.options.gloo.solo.io.TcpProxySettings

Field Type Description Default
tcpProxySettings .tcp.options.gloo.solo.io.TcpProxySettings

VirtualHostOptions

Optional, feature-specific configuration that lives on virtual hosts. Each VirtualHostPlugin object contains configuration for a specific feature. Note to developers: new Virtual Host plugins must be added to this struct to be usable by Gloo. (plugins currently need to be compiled into Gloo)

"extensions": .gloo.solo.io.Extensions
"retries": .retries.options.gloo.solo.io.RetryPolicy
"stats": .stats.options.gloo.solo.io.Stats
"headerManipulation": .headers.options.gloo.solo.io.HeaderManipulation
"cors": .cors.options.gloo.solo.io.CorsPolicy
"transformations": .transformation.options.gloo.solo.io.Transformations
"ratelimitBasic": .ratelimit.options.gloo.solo.io.IngressRateLimit
"ratelimit": .ratelimit.options.gloo.solo.io.RateLimitVhostExtension
"rateLimitConfigs": .ratelimit.options.gloo.solo.io.RateLimitConfigRefs
"waf": .waf.options.gloo.solo.io.Settings
"jwt": .jwt.options.gloo.solo.io.VhostExtension
"rbac": .rbac.options.gloo.solo.io.ExtensionSettings
"extauth": .enterprise.gloo.solo.io.ExtAuthExtension
"dlp": .dlp.options.gloo.solo.io.Config
"bufferPerRoute": .envoy.extensions.filters.http.buffer.v3.BufferPerRoute
"includeRequestAttemptCount": .google.protobuf.BoolValue
"includeAttemptCountInResponse": .google.protobuf.BoolValue
"stagedTransformations": .transformation.options.gloo.solo.io.TransformationStages

Field Type Description Default
extensions .gloo.solo.io.Extensions Extensions will be passed along from Listeners, Gateways, VirtualServices, Routes, and Route tables to the underlying Proxy, making them useful for controllers, validation tools, etc. which interact with kubernetes yaml. Some sample use cases: * controllers, deployment pipelines, helm charts, etc. which wish to use extensions as a kind of opaque metadata. * In the future, Gloo may support gRPC-based plugins which communicate with the Gloo translator out-of-process. Opaque Extensions enables development of out-of-process plugins without requiring recompiling & redeploying Gloo’s API.
retries .retries.options.gloo.solo.io.RetryPolicy
stats .stats.options.gloo.solo.io.Stats
headerManipulation .headers.options.gloo.solo.io.HeaderManipulation Append/Remove headers on Requests or Responses on all routes contained in this Virtual Host.
cors .cors.options.gloo.solo.io.CorsPolicy Defines a CORS policy for the virtual host If a CORS policy is also defined on the route matched by the request, the policies are merged.
transformations .transformation.options.gloo.solo.io.Transformations Transformations to apply. Note: this field is superceded by staged_transformations. If staged_transformations.regular is set, this field will be ignored.
ratelimitBasic .ratelimit.options.gloo.solo.io.IngressRateLimit Enterprise-only: Config for GlooE rate-limiting using simplified (gloo-specific) API.
ratelimit .ratelimit.options.gloo.solo.io.RateLimitVhostExtension Enterprise-only: Partial config for GlooE rate-limiting based on Envoy’s rate-limit service; supports Envoy’s rate-limit service API. (reference here: https://github.com/lyft/ratelimit#configuration) Configure rate-limit actions here, which define how request characteristics get translated into descriptors used by the rate-limit service for rate-limiting. Configure rate-limit descriptors and their associated limits on the Gloo settings. Only one of ratelimit or rate_limit_configs can be set. Only one of ratelimit or rateLimitConfigs can be set.
rateLimitConfigs .ratelimit.options.gloo.solo.io.RateLimitConfigRefs References to RateLimitConfig resources. This is used to configure the GlooE rate limit server. Only one of ratelimit or rate_limit_configs can be set. Only one of rateLimitConfigs or ratelimit can be set.
waf .waf.options.gloo.solo.io.Settings Enterprise-only: Config for Web Application Firewall (WAF), supporting the popular ModSecurity 3.0 ruleset.
jwt .jwt.options.gloo.solo.io.VhostExtension Enterprise-only: Config for reading and verifying JWTs. Copy verifiable information from JWTs into other headers to make routing decisions or combine with RBAC for fine-grained access control.
rbac .rbac.options.gloo.solo.io.ExtensionSettings Enterprise-only: Config for RBAC (currently only supports RBAC based on JWT claims).
extauth .enterprise.gloo.solo.io.ExtAuthExtension Enterprise-only: Authentication configuration.
dlp .dlp.options.gloo.solo.io.Config Enterprise-only: Config for data loss prevention.
bufferPerRoute .envoy.extensions.filters.http.buffer.v3.BufferPerRoute BufferPerRoute can be used to set the maximum request size that the filter will buffer before the connection manager will stop buffering and return a 413 response. Note: If you have not set a global config (at the gateway level), this override will not do anything by itself.
includeRequestAttemptCount .google.protobuf.BoolValue IncludeRequestAttemptCount decides whether the x-envoy-attempt-count header should be included in the upstream request. Setting this option will cause it to override any existing header value, so in the case of two Envoys on the request path with this option enabled, the upstream will see the attempt count as perceived by the second Envoy. Defaults to false.
includeAttemptCountInResponse .google.protobuf.BoolValue IncludeAttemptCountInResponse decides whether the x-envoy-attempt-count header should be included in the downstream response. Setting this option will cause the router to override any existing header value, so in the case of two Envoys on the request path with this option enabled, the downstream will see the attempt count as perceived by the Envoy closest upstream from itself. Defaults to false.
stagedTransformations .transformation.options.gloo.solo.io.TransformationStages Early transformations stage. These transformations run before most other options are processed. If the regular field is set in here, the transformations field is ignored.

RouteOptions

Optional, feature-specific configuration that lives on routes. Each RouteOption object contains configuration for a specific feature. Note to developers: new Route plugins must be added to this struct to be usable by Gloo. (plugins currently need to be compiled into Gloo)

"transformations": .transformation.options.gloo.solo.io.Transformations
"faults": .fault.options.gloo.solo.io.RouteFaults
"prefixRewrite": .google.protobuf.StringValue
"timeout": .google.protobuf.Duration
"retries": .retries.options.gloo.solo.io.RetryPolicy
"extensions": .gloo.solo.io.Extensions
"tracing": .tracing.options.gloo.solo.io.RouteTracingSettings
"shadowing": .shadowing.options.gloo.solo.io.RouteShadowing
"headerManipulation": .headers.options.gloo.solo.io.HeaderManipulation
"hostRewrite": string
"autoHostRewrite": .google.protobuf.BoolValue
"cors": .cors.options.gloo.solo.io.CorsPolicy
"lbHash": .lbhash.options.gloo.solo.io.RouteActionHashConfig
"upgrades": []protocol_upgrade.options.gloo.solo.io.ProtocolUpgradeConfig
"ratelimitBasic": .ratelimit.options.gloo.solo.io.IngressRateLimit
"ratelimit": .ratelimit.options.gloo.solo.io.RateLimitRouteExtension
"rateLimitConfigs": .ratelimit.options.gloo.solo.io.RateLimitConfigRefs
"waf": .waf.options.gloo.solo.io.Settings
"jwt": .jwt.options.gloo.solo.io.RouteExtension
"rbac": .rbac.options.gloo.solo.io.ExtensionSettings
"extauth": .enterprise.gloo.solo.io.ExtAuthExtension
"dlp": .dlp.options.gloo.solo.io.Config
"bufferPerRoute": .envoy.extensions.filters.http.buffer.v3.BufferPerRoute
"stagedTransformations": .transformation.options.gloo.solo.io.TransformationStages

Field Type Description Default
transformations .transformation.options.gloo.solo.io.Transformations Transformations to apply. Note: this field is superceded by staged_transformations. If staged_transformations.regular is set, this field will be ignored.
faults .fault.options.gloo.solo.io.RouteFaults
prefixRewrite .google.protobuf.StringValue For requests matched on this route, rewrite the HTTP request path to the provided value before forwarding upstream.
timeout .google.protobuf.Duration Specifies the upstream timeout for the route. If not specified, the default is 15s. This spans between the point at which the entire downstream request (i.e. end-of-stream) has been processed and when the upstream response has been completely processed. A value of 0 will disable the route’s timeout.
retries .retries.options.gloo.solo.io.RetryPolicy
extensions .gloo.solo.io.Extensions Extensions will be passed along from Listeners, Gateways, VirtualServices, Routes, and Route tables to the underlying Proxy, making them useful for controllers, validation tools, etc. which interact with kubernetes yaml. Some sample use cases: * controllers, deployment pipelines, helm charts, etc. which wish to use extensions as a kind of opaque metadata. * In the future, Gloo may support gRPC-based plugins which communicate with the Gloo translator out-of-process. Opaque Extensions enables development of out-of-process plugins without requiring recompiling & redeploying Gloo’s API.
tracing .tracing.options.gloo.solo.io.RouteTracingSettings Defines route-specific tracing configuration. See here for additional information on Envoy’s tracing capabilities: https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/observability/tracing.html See here for additional information about configuring tracing with Gloo: https://gloo.solo.io/observability/tracing/.
shadowing .shadowing.options.gloo.solo.io.RouteShadowing Specifies traffic shadowing configuration for the route. See here for additional information on Envoy’s shadowing capabilities: https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/route/route.proto#envoy-api-msg-route-routeaction-requestmirrorpolicy.
headerManipulation .headers.options.gloo.solo.io.HeaderManipulation Append/Remove headers on Requests or Responses on this Route.
hostRewrite string Indicates that during forwarding, the host header will be swapped with this value. Only one of hostRewrite or autoHostRewrite can be set.
autoHostRewrite .google.protobuf.BoolValue Enable/Disable auto host re-write. Indicates that the host header will be swapped with the hostname of the upstream host. This setting is only honored for upstreams that use DNS resolution (i.e., their generated Envoy cluster is of type STRICT_DNS or LOGICAL_DNS – think aws, azure, or static upstreams with hostnames). Only one of autoHostRewrite or hostRewrite can be set.
cors .cors.options.gloo.solo.io.CorsPolicy Defines a CORS policy for the route If a CORS policy is also defined on the route’s virtual host, the policies are merged.
lbHash .lbhash.options.gloo.solo.io.RouteActionHashConfig For routes served by a hashing load balancer, this defines the input to the hash key Gloo configures Envoy with the first available RouteActionHashConfig among the following ordered list of providers: - route, upstream, virtual service.
upgrades []protocol_upgrade.options.gloo.solo.io.ProtocolUpgradeConfig Route configuration for protocol upgrade requests.
ratelimitBasic .ratelimit.options.gloo.solo.io.IngressRateLimit Enterprise-only: Config for GlooE rate-limiting using simplified (gloo-specific) API.
ratelimit .ratelimit.options.gloo.solo.io.RateLimitRouteExtension Enterprise-only: Partial config for GlooE rate-limiting based on Envoy’s rate-limit service; supports Envoy’s rate-limit service API. (reference here: https://github.com/lyft/ratelimit#configuration) Configure rate-limit actions here, which define how request characteristics get translated into descriptors used by the rate-limit service for rate-limiting. Configure rate-limit descriptors and their associated limits on the Gloo settings. Only one of ratelimit or rate_limit_configs can be set. Only one of ratelimit or rateLimitConfigs can be set.
rateLimitConfigs .ratelimit.options.gloo.solo.io.RateLimitConfigRefs References to RateLimitConfig resources. This is used to configure the GlooE rate limit server. Only one of ratelimit or rate_limit_configs can be set. Only one of rateLimitConfigs or ratelimit can be set.
waf .waf.options.gloo.solo.io.Settings Enterprise-only: Config for Web Application Firewall (WAF), supporting the popular ModSecurity 3.0 ruleset.
jwt .jwt.options.gloo.solo.io.RouteExtension Enterprise-only: Config for reading and verifying JWTs. Copy verifiable information from JWTs into other headers to make routing decisions or combine with RBAC for fine-grained access control.
rbac .rbac.options.gloo.solo.io.ExtensionSettings Enterprise-only: Config for RBAC (currently only supports RBAC based on JWT claims).
extauth .enterprise.gloo.solo.io.ExtAuthExtension Enterprise-only: Authentication configuration.
dlp .dlp.options.gloo.solo.io.Config Enterprise-only: Config for data loss prevention.
bufferPerRoute .envoy.extensions.filters.http.buffer.v3.BufferPerRoute BufferPerRoute can be used to set the maximum request size that the filter will buffer before the connection manager will stop buffering and return a 413 response. Note: If you have not set a global config (at the gateway level), this override will not do anything by itself.
stagedTransformations .transformation.options.gloo.solo.io.TransformationStages Early transformations stage. These transformations run before most other options are processed. If the regular field is set in here, the transformations field is ignored.

DestinationSpec

Configuration for Destinations that are tied to the UpstreamSpec or ServiceSpec on that destination

"aws": .aws.options.gloo.solo.io.DestinationSpec
"azure": .azure.options.gloo.solo.io.DestinationSpec
"rest": .rest.options.gloo.solo.io.DestinationSpec
"grpc": .grpc.options.gloo.solo.io.DestinationSpec

Field Type Description Default
aws .aws.options.gloo.solo.io.DestinationSpec Only one of aws, azure, or grpc can be set.
azure .azure.options.gloo.solo.io.DestinationSpec Only one of azure, aws, or grpc can be set.
rest .rest.options.gloo.solo.io.DestinationSpec Only one of rest, aws, or grpc can be set.
grpc .grpc.options.gloo.solo.io.DestinationSpec Only one of grpc, aws, or rest can be set.

WeightedDestinationOptions

Optional, feature-specific configuration that is applied when a specific weighted destination is selected for routing.

"headerManipulation": .headers.options.gloo.solo.io.HeaderManipulation
"transformations": .transformation.options.gloo.solo.io.Transformations
"extensions": .gloo.solo.io.Extensions
"extauth": .enterprise.gloo.solo.io.ExtAuthExtension
"bufferPerRoute": .envoy.extensions.filters.http.buffer.v3.BufferPerRoute
"stagedTransformations": .transformation.options.gloo.solo.io.TransformationStages

Field Type Description Default
headerManipulation .headers.options.gloo.solo.io.HeaderManipulation Append/Remove headers on Requests or Responses to/from this Weighted Destination.
transformations .transformation.options.gloo.solo.io.Transformations Transformations to apply. Note: this field is superceded by staged_transformations. If staged_transformations.regular is set, this field will be ignored.
extensions .gloo.solo.io.Extensions Extensions will be passed along from Listeners, Gateways, VirtualServices, Routes, and Route tables to the underlying Proxy, making them useful for controllers, validation tools, etc. which interact with kubernetes yaml. Some sample use cases: * controllers, deployment pipelines, helm charts, etc. which wish to use extensions as a kind of opaque metadata. * In the future, Gloo may support gRPC-based plugins which communicate with the Gloo translator out-of-process. Opaque Extensions enables development of out-of-process plugins without requiring recompiling & redeploying Gloo’s API.
extauth .enterprise.gloo.solo.io.ExtAuthExtension Enterprise-only: Authentication configuration.
bufferPerRoute .envoy.extensions.filters.http.buffer.v3.BufferPerRoute BufferPerRoute can be used to set the maximum request size that the filter will buffer before the connection manager will stop buffering and return a 413 response. Note: If you have not set a global config (at the gateway level), this override will not do anything by itself.
stagedTransformations .transformation.options.gloo.solo.io.TransformationStages Early transformations stage. These transformations run before most other options are processed. If the regular field is set in here, the transformations field is ignored.