ContourConfiguration

projectcontour.io / v1alpha1

apiVersion: projectcontour.io/v1alpha1 kind: ContourConfiguration metadata: name: example

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata object

spec object required

ContourConfigurationSpec represents a configuration of a Contour controller. It contains most of all the options that can be customized, the other remaining options being command line flags.

debug object

Debug contains parameters to enable debug logging and debug interfaces inside Contour.

address string

Defines the Contour debug address interface. Contour's default is "127.0.0.1".

port integer

Defines the Contour debug address port. Contour's default is 6060.

enableExternalNameService boolean

EnableExternalNameService allows processing of ExternalNameServices Contour's default is false for security reasons.

envoy object

Envoy contains parameters for Envoy as well as how to optionally configure a managed Envoy fleet.

clientCertificate object

ClientCertificate defines the namespace/name of the Kubernetes secret containing the client certificate and private key to be used when establishing TLS connection to upstream cluster.

name string required

namespace string required

cluster object

Cluster holds various configurable Envoy cluster values that can be set in the config file.

circuitBreakers object

GlobalCircuitBreakerDefaults specifies default circuit breaker budget across all services. If defined, this will be used as the default for all services.

maxConnections integer

The maximum number of connections that a single Envoy instance allows to the Kubernetes Service; defaults to 1024.

format: int32

maxPendingRequests integer

The maximum number of pending requests that a single Envoy instance allows to the Kubernetes Service; defaults to 1024.

format: int32

maxRequests integer

The maximum parallel requests a single Envoy instance allows to the Kubernetes Service; defaults to 1024

format: int32

maxRetries integer

The maximum number of parallel retries a single Envoy instance allows to the Kubernetes Service; defaults to 3.

format: int32

perHostMaxConnections integer

PerHostMaxConnections is the maximum number of connections that Envoy will allow to each individual host in a cluster.

format: int32

dnsLookupFamily string

DNSLookupFamily defines how external names are looked up When configured as V4, the DNS resolver will only perform a lookup for addresses in the IPv4 family. If V6 is configured, the DNS resolver will only perform a lookup for addresses in the IPv6 family. If AUTO is configured, the DNS resolver will first perform a lookup for addresses in the IPv6 family and fallback to a lookup for addresses in the IPv4 family. If ALL is specified, the DNS resolver will perform a lookup for both IPv4 and IPv6 families, and return all resolved addresses. When this is used, Happy Eyeballs will be enabled for upstream connections. Refer to Happy Eyeballs Support for more information. Note: This only applies to externalName clusters. See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto.html#envoy-v3-api-enum-config-cluster-v3-cluster-dnslookupfamily for more information. Values: `auto` (default), `v4`, `v6`, `all`. Other values will produce an error.

maxRequestsPerConnection integer

Defines the maximum requests for upstream connections. If not specified, there is no limit. see https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-msg-config-core-v3-httpprotocoloptions for more information.

format: int32

minimum: 1

per-connection-buffer-limit-bytes integer

Defines the soft limit on size of the cluster’s new connection read and write buffers in bytes. If unspecified, an implementation defined default is applied (1MiB). see https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto#envoy-v3-api-field-config-cluster-v3-cluster-per-connection-buffer-limit-bytes for more information.

format: int32

minimum: 1

upstreamTLS object

UpstreamTLS contains the TLS policy parameters for upstream connections

cipherSuites []string

CipherSuites defines the TLS ciphers to be supported by Envoy TLS listeners when negotiating TLS 1.2. Ciphers are validated against the set that Envoy supports by default. This parameter should only be used by advanced users. Note that these will be ignored when TLS 1.3 is in use. This field is optional; when it is undefined, a Contour-managed ciphersuite list will be used, which may be updated to keep it secure. Contour's default list is: - "[ECDHE-ECDSA-AES128-GCM-SHA256|ECDHE-ECDSA-CHACHA20-POLY1305]" - "[ECDHE-RSA-AES128-GCM-SHA256|ECDHE-RSA-CHACHA20-POLY1305]" - "ECDHE-ECDSA-AES256-GCM-SHA384" - "ECDHE-RSA-AES256-GCM-SHA384" Ciphers provided are validated against the following list: - "[ECDHE-ECDSA-AES128-GCM-SHA256|ECDHE-ECDSA-CHACHA20-POLY1305]" - "[ECDHE-RSA-AES128-GCM-SHA256|ECDHE-RSA-CHACHA20-POLY1305]" - "ECDHE-ECDSA-AES128-GCM-SHA256" - "ECDHE-RSA-AES128-GCM-SHA256" - "ECDHE-ECDSA-AES128-SHA" - "ECDHE-RSA-AES128-SHA" - "AES128-GCM-SHA256" - "AES128-SHA" - "ECDHE-ECDSA-AES256-GCM-SHA384" - "ECDHE-RSA-AES256-GCM-SHA384" - "ECDHE-ECDSA-AES256-SHA" - "ECDHE-RSA-AES256-SHA" - "AES256-GCM-SHA384" - "AES256-SHA" Contour recommends leaving this undefined unless you are sure you must. See: https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/transport_sockets/tls/v3/common.proto#extensions-transport-sockets-tls-v3-tlsparameters Note: This list is a superset of what is valid for stock Envoy builds and those using BoringSSL FIPS.

maximumProtocolVersion string

MaximumProtocolVersion is the maximum TLS version this vhost should negotiate. Values: `1.2`, `1.3`(default). Other values will produce an error.

minimumProtocolVersion string

MinimumProtocolVersion is the minimum TLS version this vhost should negotiate. Values: `1.2` (default), `1.3`. Other values will produce an error.

defaultHTTPVersions []string

DefaultHTTPVersions defines the default set of HTTPS versions the proxy should accept. HTTP versions are strings of the form "HTTP/xx". Supported versions are "HTTP/1.1" and "HTTP/2". Values: `HTTP/1.1`, `HTTP/2` (default: both). Other values will produce an error.

health object

Health defines the endpoint Envoy uses to serve health checks. Contour's default is { address: "0.0.0.0", port: 8002 }.

address string

Defines the health address interface.

minLength: 1

port integer

Defines the health port.

http object

Defines the HTTP Listener for Envoy. Contour's default is { address: "0.0.0.0", port: 8080, accessLog: "/dev/stdout" }.

accessLog string

AccessLog defines where Envoy logs are outputted for this listener.

address string

Defines an Envoy Listener Address.

minLength: 1

port integer

Defines an Envoy listener Port.

https object

Defines the HTTPS Listener for Envoy. Contour's default is { address: "0.0.0.0", port: 8443, accessLog: "/dev/stdout" }.

accessLog string

AccessLog defines where Envoy logs are outputted for this listener.

address string

Defines an Envoy Listener Address.

minLength: 1

port integer

Defines an Envoy listener Port.

listener object

Listener hold various configurable Envoy listener values.

connectionBalancer string

ConnectionBalancer. If the value is exact, the listener will use the exact connection balancer See https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/listener.proto#envoy-api-msg-listener-connectionbalanceconfig for more information. Values: (empty string): use the default ConnectionBalancer, `exact`: use the Exact ConnectionBalancer. Other values will produce an error.

disableAllowChunkedLength boolean

DisableAllowChunkedLength disables the RFC-compliant Envoy behavior to strip the "Content-Length" header if "Transfer-Encoding: chunked" is also set. This is an emergency off-switch to revert back to Envoy's default behavior in case of failures. Please file an issue if failures are encountered. See: https://github.com/projectcontour/contour/issues/3221 Contour's default is false.

disableMergeSlashes boolean

DisableMergeSlashes disables Envoy's non-standard merge_slashes path transformation option which strips duplicate slashes from request URL paths. Contour's default is false.

httpMaxConcurrentStreams integer

Defines the value for SETTINGS_MAX_CONCURRENT_STREAMS Envoy will advertise in the SETTINGS frame in HTTP/2 connections and the limit for concurrent streams allowed for a peer on a single HTTP/2 connection. It is recommended to not set this lower than 100 but this field can be used to bound resource usage by HTTP/2 connections and mitigate attacks like CVE-2023-44487. The default value when this is not set is unlimited.

format: int32

minimum: 1

maxConnectionsPerListener integer

Defines the limit on number of active connections to a listener. The limit is applied per listener. The default value when this is not set is unlimited.

format: int32

minimum: 1

maxRequestsPerConnection integer

Defines the maximum requests for downstream connections. If not specified, there is no limit. see https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-msg-config-core-v3-httpprotocoloptions for more information.

format: int32

minimum: 1

maxRequestsPerIOCycle integer

Defines the limit on number of HTTP requests that Envoy will process from a single connection in a single I/O cycle. Requests over this limit are processed in subsequent I/O cycles. Can be used as a mitigation for CVE-2023-44487 when abusive traffic is detected. Configures the http.max_requests_per_io_cycle Envoy runtime setting. The default value when this is not set is no limit.

format: int32

minimum: 1

per-connection-buffer-limit-bytes integer

Defines the soft limit on size of the listener’s new connection read and write buffers in bytes. If unspecified, an implementation defined default is applied (1MiB). see https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/listener/v3/listener.proto#envoy-v3-api-field-config-listener-v3-listener-per-connection-buffer-limit-bytes for more information.

format: int32

minimum: 1

serverHeaderTransformation string

Defines the action to be applied to the Server header on the response path. When configured as overwrite, overwrites any Server header with "envoy". When configured as append_if_absent, if a Server header is present, pass it through, otherwise set it to "envoy". When configured as pass_through, pass through the value of the Server header, and do not append a header if none is present. Values: `overwrite` (default), `append_if_absent`, `pass_through` Other values will produce an error. Contour's default is overwrite.

socketOptions object

SocketOptions defines configurable socket options for the listeners. Single set of options are applied to all listeners.

tos integer

Defines the value for IPv4 TOS field (including 6 bit DSCP field) for IP packets originating from Envoy listeners. Single value is applied to all listeners. If listeners are bound to IPv6-only addresses, setting this option will cause an error.

format: int32

minimum: 0

maximum: 255

trafficClass integer

Defines the value for IPv6 Traffic Class field (including 6 bit DSCP field) for IP packets originating from the Envoy listeners. Single value is applied to all listeners. If listeners are bound to IPv4-only addresses, setting this option will cause an error.

format: int32

minimum: 0

maximum: 255

tls object

TLS holds various configurable Envoy TLS listener values.

cipherSuites []string

maximumProtocolVersion string

MaximumProtocolVersion is the maximum TLS version this vhost should negotiate. Values: `1.2`, `1.3`(default). Other values will produce an error.

minimumProtocolVersion string

MinimumProtocolVersion is the minimum TLS version this vhost should negotiate. Values: `1.2` (default), `1.3`. Other values will produce an error.

useProxyProtocol boolean

Use PROXY protocol for all listeners. Contour's default is false.

logging object

Logging defines how Envoy's logs can be configured.

accessLogFormat string

AccessLogFormat sets the global access log format. Values: `envoy` (default), `json`. Other values will produce an error.

accessLogFormatString string

AccessLogFormatString sets the access log format when format is set to `envoy`. When empty, Envoy's default format is used.

accessLogJSONFields []string

AccessLogJSONFields sets the fields that JSON logging will output when AccessLogFormat is json.

accessLogLevel string

AccessLogLevel sets the verbosity level of the access log. Values: `info` (default, all requests are logged), `error` (all non-success requests, i.e. 300+ response code, are logged), `critical` (all 5xx requests are logged) and `disabled`. Other values will produce an error.

metrics object

Metrics defines the endpoint Envoy uses to serve metrics. Contour's default is { address: "0.0.0.0", port: 8002 }.

address string

Defines the metrics address interface.

minLength: 1

maxLength: 253

port integer

Defines the metrics port.

tls object

TLS holds TLS file config details. Metrics and health endpoints cannot have same port number when metrics is served over HTTPS.

caFile string

CA filename.

certFile string

Client certificate filename.

keyFile string

Client key filename.

network object

Network holds various configurable Envoy network values.

adminPort integer

Configure the port used to access the Envoy Admin interface. If configured to port "0" then the admin interface is disabled. Contour's default is 9001.

numTrustedHops integer

XffNumTrustedHops defines the number of additional ingress proxy hops from the right side of the x-forwarded-for HTTP header to trust when determining the origin client’s IP address. See https://www.envoyproxy.io/docs/envoy/v1.17.0/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto?highlight=xff_num_trusted_hops for more information. Contour's default is 0.

format: int32

service object

Service holds Envoy service parameters for setting Ingress status. Contour's default is { namespace: "projectcontour", name: "envoy" }.

name string required

namespace string required

timeouts object

Timeouts holds various configurable timeouts that can be set in the config file.

connectTimeout string

ConnectTimeout defines how long the proxy should wait when establishing connection to upstream service. If not set, a default value of 2 seconds will be used. See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto#envoy-v3-api-field-config-cluster-v3-cluster-connect-timeout for more information.

connectionIdleTimeout string

ConnectionIdleTimeout defines how long the proxy should wait while there are no active requests (for HTTP/1.1) or streams (for HTTP/2) before terminating an HTTP connection. Set to "infinity" to disable the timeout entirely. See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-idle-timeout for more information.

connectionShutdownGracePeriod string

ConnectionShutdownGracePeriod defines how long the proxy will wait between sending an initial GOAWAY frame and a second, final GOAWAY frame when terminating an HTTP/2 connection. During this grace period, the proxy will continue to respond to new streams. After the final GOAWAY frame has been sent, the proxy will refuse new streams. See https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-drain-timeout for more information.

delayedCloseTimeout string

DelayedCloseTimeout defines how long envoy will wait, once connection close processing has been initiated, for the downstream peer to close the connection before Envoy closes the socket associated with the connection. Setting this timeout to 'infinity' will disable it, equivalent to setting it to '0' in Envoy. Leaving it unset will result in the Envoy default value being used. See https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-delayed-close-timeout for more information.

maxConnectionDuration string

MaxConnectionDuration defines the maximum period of time after an HTTP connection has been established from the client to the proxy before it is closed by the proxy, regardless of whether there has been activity or not. Omit or set to "infinity" for no max duration. See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-connection-duration for more information.

requestTimeout string

RequestTimeout sets the client request timeout globally for Contour. Note that this is a timeout for the entire request, not an idle timeout. Omit or set to "infinity" to disable the timeout entirely. See https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-request-timeout for more information.

streamIdleTimeout string

StreamIdleTimeout defines how long the proxy should wait while there is no request activity (for HTTP/1.1) or stream activity (for HTTP/2) before terminating the HTTP request or stream. Set to "infinity" to disable the timeout entirely. See https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto#envoy-v3-api-field-extensions-filters-network-http-connection-manager-v3-httpconnectionmanager-stream-idle-timeout for more information.

featureFlags []string

FeatureFlags defines toggle to enable new contour features. Available toggles are: useEndpointSlices - Configures contour to fetch endpoint data from k8s endpoint slices. defaults to true, If false then reads endpoint data from the k8s endpoints.

gateway object

Gateway contains parameters for the gateway-api Gateway that Contour is configured to serve traffic.

gatewayRef object required

GatewayRef defines the specific Gateway that this Contour instance corresponds to.

name string required

namespace string required

globalExtAuth object

GlobalExternalAuthorization allows envoys external authorization filter to be enabled for all virtual hosts.

authPolicy object

AuthPolicy sets a default authorization policy for client requests. This policy will be used unless overridden by individual routes.

context object

Context is a set of key/value pairs that are sent to the authentication server in the check request. If a context is provided at an enclosing scope, the entries are merged such that the inner scope overrides matching keys from the outer scope.

disabled boolean

When true, this field disables client request authentication for the scope of the policy.

extensionRef object

ExtensionServiceRef specifies the extension resource that will authorize client requests.

apiVersion string

API version of the referent. If this field is not specified, the default "projectcontour.io/v1alpha1" will be used

minLength: 1

name string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

minLength: 1

namespace string

Namespace of the referent. If this field is not specifies, the namespace of the resource that targets the referent will be used. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

minLength: 1

failOpen boolean

If FailOpen is true, the client request is forwarded to the upstream service even if the authorization server fails to respond. This field should not be set in most cases. It is intended for use only while migrating applications from internal authorization to Contour external authorization.

responseTimeout string

ResponseTimeout configures maximum time to wait for a check response from the authorization server. Timeout durations are expressed in the Go [Duration format](https://godoc.org/time#ParseDuration). Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The string "infinity" is also a valid input and specifies no timeout.

pattern:

^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$

withRequestBody object

WithRequestBody specifies configuration for sending the client request's body to authorization server.

allowPartialMessage boolean

If AllowPartialMessage is true, then Envoy will buffer the body until MaxRequestBytes are reached.

maxRequestBytes integer

MaxRequestBytes sets the maximum size of message body ExtAuthz filter will hold in-memory.

format: int32

minimum: 1

packAsBytes boolean

If PackAsBytes is true, the body sent to Authorization Server is in raw bytes.

health object

Health defines the endpoints Contour uses to serve health checks. Contour's default is { address: "0.0.0.0", port: 8000 }.

address string

Defines the health address interface.

minLength: 1

port integer

Defines the health port.

httpproxy object

HTTPProxy defines parameters on HTTPProxy.

disablePermitInsecure boolean

DisablePermitInsecure disables the use of the permitInsecure field in HTTPProxy. Contour's default is false.

fallbackCertificate object

FallbackCertificate defines the namespace/name of the Kubernetes secret to use as fallback when a non-SNI request is received.

name string required

namespace string required

rootNamespaces []string

Restrict Contour to searching these namespaces for root ingress routes.

ingress object

Ingress contains parameters for ingress options.

classNames []string

Ingress Class Names Contour should use.

statusAddress string

Address to set in Ingress object status.

metrics object

Metrics defines the endpoint Contour uses to serve metrics. Contour's default is { address: "0.0.0.0", port: 8000 }.

address string

Defines the metrics address interface.

minLength: 1

maxLength: 253

port integer

Defines the metrics port.

tls object

TLS holds TLS file config details. Metrics and health endpoints cannot have same port number when metrics is served over HTTPS.

caFile string

CA filename.

certFile string

Client certificate filename.

keyFile string

Client key filename.

policy object

Policy specifies default policy applied if not overridden by the user

applyToIngress boolean

ApplyToIngress determines if the Policies will apply to ingress objects Contour's default is false.

requestHeaders object

RequestHeadersPolicy defines the request headers set/removed on all routes

remove []string

set object

responseHeaders object

ResponseHeadersPolicy defines the response headers set/removed on all routes

remove []string

set object

rateLimitService object

RateLimitService optionally holds properties of the Rate Limit Service to be used for global rate limiting.

defaultGlobalRateLimitPolicy object

DefaultGlobalRateLimitPolicy allows setting a default global rate limit policy for every HTTPProxy. HTTPProxy can overwrite this configuration.

descriptors []object

Descriptors defines the list of descriptors that will be generated and sent to the rate limit service. Each descriptor contains 1+ key-value pair entries.

minItems: 1

entries []object

Entries is the list of key-value pair generators.

minItems: 1

genericKey object

GenericKey defines a descriptor entry with a static key and value.

key string

Key defines the key of the descriptor entry. If not set, the key is set to "generic_key".

value string

Value defines the value of the descriptor entry.

minLength: 1

remoteAddress object

RemoteAddress defines a descriptor entry with a key of "remote_address" and a value equal to the client's IP address (from x-forwarded-for).

requestHeader object

RequestHeader defines a descriptor entry that's populated only if a given header is present on the request. The descriptor key is static, and the descriptor value is equal to the value of the header.

descriptorKey string

DescriptorKey defines the key to use on the descriptor entry.

minLength: 1

headerName string

HeaderName defines the name of the header to look for on the request.

minLength: 1

requestHeaderValueMatch object

RequestHeaderValueMatch defines a descriptor entry that's populated if the request's headers match a set of 1+ match criteria. The descriptor key is "header_match", and the descriptor value is static.

expectMatch boolean

ExpectMatch defines whether the request must positively match the match criteria in order to generate a descriptor entry (i.e. true), or not match the match criteria in order to generate a descriptor entry (i.e. false). The default is true.

headers []object

Headers is a list of 1+ match criteria to apply against the request to determine whether to populate the descriptor entry or not.

minItems: 1

contains string

Contains specifies a substring that must be present in the header value.

exact string

Exact specifies a string that the header value must be equal to.

ignoreCase boolean

IgnoreCase specifies that string matching should be case insensitive. Note that this has no effect on the Regex parameter.

name string required

Name is the name of the header to match against. Name is required. Header names are case insensitive.

notcontains string

NotContains specifies a substring that must not be present in the header value.

notexact string

NoExact specifies a string that the header value must not be equal to. The condition is true if the header has any other value.

notpresent boolean

NotPresent specifies that condition is true when the named header is not present. Note that setting NotPresent to false does not make the condition true if the named header is present.

present boolean

Present specifies that condition is true when the named header is present, regardless of its value. Note that setting Present to false does not make the condition true if the named header is absent.

regex string

Regex specifies a regular expression pattern that must match the header value.

treatMissingAsEmpty boolean

TreatMissingAsEmpty specifies if the header match rule specified header does not exist, this header value will be treated as empty. Defaults to false. Unlike the underlying Envoy implementation this is **only** supported for negative matches (e.g. NotContains, NotExact).

value string

Value defines the value of the descriptor entry.

minLength: 1

disabled boolean

Disabled configures the HTTPProxy to not use the default global rate limit policy defined by the Contour configuration.

domain string

Domain is passed to the Rate Limit Service.

enableResourceExhaustedCode boolean

EnableResourceExhaustedCode enables translating error code 429 to grpc code RESOURCE_EXHAUSTED. When disabled it's translated to UNAVAILABLE

enableXRateLimitHeaders boolean

EnableXRateLimitHeaders defines whether to include the X-RateLimit headers X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset (as defined by the IETF Internet-Draft linked below), on responses to clients when the Rate Limit Service is consulted for a request. ref. https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html

extensionService object required

ExtensionService identifies the extension service defining the RLS.

name string required

namespace string required

failOpen boolean

FailOpen defines whether to allow requests to proceed when the Rate Limit Service fails to respond with a valid rate limit decision within the timeout defined on the extension service.

tracing object

Tracing defines properties for exporting trace data to OpenTelemetry.

customTags []object

CustomTags defines a list of custom tags with unique tag name.

literal string

Literal is a static custom tag value. Precisely one of Literal, RequestHeaderName must be set.

requestHeaderName string

RequestHeaderName indicates which request header the label value is obtained from. Precisely one of Literal, RequestHeaderName must be set.

tagName string required

TagName is the unique name of the custom tag.

extensionService object required

ExtensionService identifies the extension service defining the otel-collector.

name string required

namespace string required

includePodDetail boolean

IncludePodDetail defines a flag. If it is true, contour will add the pod name and namespace to the span of the trace. the default is true. Note: The Envoy pods MUST have the HOSTNAME and CONTOUR_NAMESPACE environment variables set for this to work properly.

maxPathTagLength integer

MaxPathTagLength defines maximum length of the request path to extract and include in the HttpUrl tag. contour's default is 256.

format: int32

overallSampling string

OverallSampling defines the sampling rate of trace data. contour's default is 100.

serviceName string

ServiceName defines the name for the service. contour's default is contour.

xdsServer object

XDSServer contains parameters for the xDS server.

address string

Defines the xDS gRPC API address which Contour will serve. Contour's default is "0.0.0.0".

minLength: 1

port integer

Defines the xDS gRPC API port which Contour will serve. Contour's default is 8001.

tls object

TLS holds TLS file config details. Contour's default is { caFile: "/certs/ca.crt", certFile: "/certs/tls.cert", keyFile: "/certs/tls.key", insecure: false }.

caFile string

CA filename.

certFile string

Client certificate filename.

insecure boolean

Allow serving the xDS gRPC API without TLS.

keyFile string

Client key filename.

type string

Defines the XDSServer to use for `contour serve`. Values: `envoy` (default), `contour (deprecated)`. Other values will produce an error. Deprecated: this field will be removed in a future release when the `contour` xDS server implementation is removed.

status object

ContourConfigurationStatus defines the observed state of a ContourConfiguration resource.

conditions []object

Conditions contains the current status of the Contour resource. Contour will update a single condition, `Valid`, that is in normal-true polarity. Contour will not modify any other Conditions set in this block, in case some other controller wants to add a Condition.

errors []object

Errors contains a slice of relevant error subconditions for this object. Subconditions are expected to appear when relevant (when there is a error), and disappear when not relevant. An empty slice here indicates no errors.

message string required

Message is a human readable message indicating details about the transition. This may be an empty string.

maxLength: 32768

reason string required

Reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

minLength: 1

maxLength: 1024

status string required

Status of the condition, one of True, False, Unknown.

enum: True, False, Unknown

type string required

Type of condition in `CamelCase` or in `foo.example.com/CamelCase`. This must be in abnormal-true polarity, that is, `ErrorFound` or `controller.io/ErrorFound`. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

maxLength: 316

lastTransitionTime string required

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

format: date-time

message string required

message is a human readable message indicating details about the transition. This may be an empty string.

maxLength: 32768

observedGeneration integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

format: int64

minimum: 0

reason string required

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

minLength: 1

maxLength: 1024

status string required

status of the condition, one of True, False, Unknown.

enum: True, False, Unknown

type string required

type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

maxLength: 316

warnings []object

Warnings contains a slice of relevant warning subconditions for this object. Subconditions are expected to appear when relevant (when there is a warning), and disappear when not relevant. An empty slice here indicates no warnings.

message string required

Message is a human readable message indicating details about the transition. This may be an empty string.

maxLength: 32768

reason string required

pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

minLength: 1

maxLength: 1024

status string required

Status of the condition, one of True, False, Unknown.

enum: True, False, Unknown

type string required

pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

maxLength: 316

No matches. Try .spec.debug for an exact path