VirtualHostOptions

Documentation

Reference

API

Top-level APIs

VirtualHostOptions

Package: gloo.solo.io

Types:

VirtualHostOptions

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

VirtualHostOptions

Optional, feature-specific configuration that lives on virtual hosts. Each VirtualHostOptions object contains configuration for a specific feature. Note to developers: new Virtual Host plugins must be added to this struct to be usable by K8sGateway.

"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
"bufferPerRoute": .solo.io.envoy.extensions.filters.http.buffer.v3.BufferPerRoute
"csrf": .solo.io.envoy.extensions.filters.http.csrf.v3.CsrfPolicy
"includeRequestAttemptCount": .google.protobuf.BoolValue
"includeAttemptCountInResponse": .google.protobuf.BoolValue
"stagedTransformations": .transformation.options.gloo.solo.io.TransformationStages
"corsPolicyMergeSettings": .cors.options.gloo.solo.io.CorsPolicyMergeSettings

Field	Type	Description
`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.
`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 route policy overrides the virtual host policy for any configured field unless CorsPolicyMergeSettings are specified that define an alternate behavior.
`transformations`	.transformation.options.gloo.solo.io.Transformations	Transformations to apply. Note: this field is superseded by `staged_transformations`. If `staged_transformations.regular` is set, this field will be ignored.
`bufferPerRoute`	.solo.io.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.
`csrf`	.solo.io.envoy.extensions.filters.http.csrf.v3.CsrfPolicy	Csrf can be used to set percent of requests for which the CSRF filter is enabled, enable shadow-only mode where policies will be evaluated and tracked, but not enforced and add additional source origins that will be allowed in addition to the destination origin. For more, see https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/http/csrf/v3/csrf.proto#envoy-v3-api-msg-extensions-filters-http-csrf-v3-csrfpolicy.
`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.
`corsPolicyMergeSettings`	.cors.options.gloo.solo.io.CorsPolicyMergeSettings	Settings for determining merge strategy for CORS settings when present at both Route and VirtualHost levels.

Upstream