projectcontour.io / v1alpha1 / ContourConfiguration

• string

  .apiVersion

  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

• string

  .kind

  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

• object

  .metadata

• object required

  .spec

  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.

• object

  .spec .debug

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

• string

  .spec .debug .address

  Defines the Contour debug address interface. Contour’s default is “127.0.0.1”.

• integer

  .spec .debug .port

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

• boolean

  .spec .enableExternalNameService

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

• object

  .spec .envoy

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

• object

  .spec .envoy .clientCertificate

  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.

• string required

  .spec .envoy .clientCertificate .name

• string required

  .spec .envoy .clientCertificate .namespace

• object

  .spec .envoy .cluster

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

• object

  .spec .envoy .cluster .circuitBreakers

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

• integer

  .spec .envoy .cluster .circuitBreakers .maxConnections

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

• integer

  .spec .envoy .cluster .circuitBreakers .maxPendingRequests

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

• integer

  .spec .envoy .cluster .circuitBreakers .maxRequests

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

• integer

  .spec .envoy .cluster .circuitBreakers .maxRetries

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

• integer

  .spec .envoy .cluster .circuitBreakers .perHostMaxConnections

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

• string

  .spec .envoy .cluster .dnsLookupFamily

  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.

• integer

  .spec .envoy .cluster .maxRequestsPerConnection

  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.

• integer

  .spec .envoy .cluster .per-connection-buffer-limit-bytes

  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.

• object

  .spec .envoy .cluster .upstreamTLS

  UpstreamTLS contains the TLS policy parameters for upstream connections

• array

  .spec .envoy .cluster .upstreamTLS .cipherSuites

  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.
• string

  .spec .envoy .cluster .upstreamTLS .maximumProtocolVersion

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

• string

  .spec .envoy .cluster .upstreamTLS .minimumProtocolVersion

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

• array

  .spec .envoy .defaultHTTPVersions

  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.

• object

  .spec .envoy .health

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

• string

  .spec .envoy .health .address

  Defines the health address interface.

• integer

  .spec .envoy .health .port

  Defines the health port.

• object

  .spec .envoy .http

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

• string

  .spec .envoy .http .accessLog

  AccessLog defines where Envoy logs are outputted for this listener.

• string

  .spec .envoy .http .address

  Defines an Envoy Listener Address.

• integer

  .spec .envoy .http .port

  Defines an Envoy listener Port.

• object

  .spec .envoy .https

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

• string

  .spec .envoy .https .accessLog

  AccessLog defines where Envoy logs are outputted for this listener.

• string

  .spec .envoy .https .address

  Defines an Envoy Listener Address.

• integer

  .spec .envoy .https .port

  Defines an Envoy listener Port.

• object

  .spec .envoy .listener

  Listener hold various configurable Envoy listener values.

• object

  .spec .envoy .listener .compression

  Compression defines configuration related to compression in the default HTTP Listener filters.

• string

  .spec .envoy .listener .compression .algorithm

  Algorithm selects the response compression type applied in the compression HTTP filter of the default Listener filters. Values: gzip (default), brotli, zstd, disabled. Setting this to disabled will make Envoy skip “Accept-Encoding: gzip,deflate” request header and always return uncompressed response.

• string

  .spec .envoy .listener .connectionBalancer

  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.

• boolean

  .spec .envoy .listener .disableAllowChunkedLength

  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.

• boolean

  .spec .envoy .listener .disableMergeSlashes

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

• integer

  .spec .envoy .listener .httpMaxConcurrentStreams

  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.

• integer

  .spec .envoy .listener .maxConnectionsPerListener

  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.

• integer

  .spec .envoy .listener .maxRequestsPerConnection

  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.

• integer

  .spec .envoy .listener .maxRequestsPerIOCycle

  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.

• integer

  .spec .envoy .listener .per-connection-buffer-limit-bytes

  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.

• string

  .spec .envoy .listener .serverHeaderTransformation

  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.

• object

  .spec .envoy .listener .socketOptions

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

• integer

  .spec .envoy .listener .socketOptions .tos

  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.

• integer

  .spec .envoy .listener .socketOptions .trafficClass

  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.

• object

  .spec .envoy .listener .tls

  TLS holds various configurable Envoy TLS listener values.

• array

  .spec .envoy .listener .tls .cipherSuites

  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.
• string

  .spec .envoy .listener .tls .maximumProtocolVersion

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

• string

  .spec .envoy .listener .tls .minimumProtocolVersion

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

• boolean

  .spec .envoy .listener .useProxyProtocol

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

• object

  .spec .envoy .logging

  Logging defines how Envoy’s logs can be configured.

• string

  .spec .envoy .logging .accessLogFormat

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

• string

  .spec .envoy .logging .accessLogFormatString

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

• array

  .spec .envoy .logging .accessLogJSONFields

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

• string

  .spec .envoy .logging .accessLogLevel

  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.

• object

  .spec .envoy .metrics

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

• string

  .spec .envoy .metrics .address

  Defines the metrics address interface.

• integer

  .spec .envoy .metrics .port

  Defines the metrics port.

• object

  .spec .envoy .metrics .tls

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

• string

  .spec .envoy .metrics .tls .caFile

  CA filename.

• string

  .spec .envoy .metrics .tls .certFile

  Client certificate filename.

• string

  .spec .envoy .metrics .tls .keyFile

  Client key filename.

• object

  .spec .envoy .network

  Network holds various configurable Envoy network values.

• integer

  .spec .envoy .network .adminPort

  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.

• integer

  .spec .envoy .network .numTrustedHops

  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.

• boolean

  .spec .envoy .network .stripTrailingHostDot

  EnvoyStripTrailingHostDot defines if trailing dot of the host should be removed from host/authority header before any processing of request by HTTP filters or routing. This affects the upstream host header. Without setting this option to true, incoming requests with host example.com. will not match against route with domains match set to example.com. See https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/filters/network/http_connection_manager/v3/http_connection_manager.proto?highlight=strip_trailing_host_dot for more information. Contour’s default is false.

• object

  .spec .envoy .omEnforcedHealth

  OMEnforcedHealth defines the endpoint Envoy uses to serve health checks with the envoy overload manager actions, such as global connection limits, enforced. The configured values must be different from the endpoints configured by [EnvoyConfig.Metrics] and [EnvoyConfig.Health] This is disabled by default

• string

  .spec .envoy .omEnforcedHealth .address

  Defines the health address interface.

• integer

  .spec .envoy .omEnforcedHealth .port

  Defines the health port.

• object

  .spec .envoy .service

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

• string required

  .spec .envoy .service .name

• string required

  .spec .envoy .service .namespace

• object

  .spec .envoy .timeouts

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

• string

  .spec .envoy .timeouts .connectTimeout

  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.

• string

  .spec .envoy .timeouts .connectionIdleTimeout

  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.

• string

  .spec .envoy .timeouts .connectionShutdownGracePeriod

  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.

• string

  .spec .envoy .timeouts .delayedCloseTimeout

  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.

• string

  .spec .envoy .timeouts .maxConnectionDuration

  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.

• string

  .spec .envoy .timeouts .requestTimeout

  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.

• string

  .spec .envoy .timeouts .streamIdleTimeout

  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.

• array

  .spec .featureFlags

  FeatureFlags defines toggle to enable new contour features.

• object

  .spec .gateway

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

• object required

  .spec .gateway .gatewayRef

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

• string required

  .spec .gateway .gatewayRef .name

• string required

  .spec .gateway .gatewayRef .namespace

• object

  .spec .globalExtAuth

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

• object

  .spec .globalExtAuth .authPolicy

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

• object

  .spec .globalExtAuth .authPolicy .context

  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.

• boolean

  .spec .globalExtAuth .authPolicy .disabled

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

• object

  .spec .globalExtAuth .extensionRef

  ExtensionServiceRef specifies the extension resource that will authorize client requests.

• string

  .spec .globalExtAuth .extensionRef .apiVersion

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

• string

  .spec .globalExtAuth .extensionRef .name

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

• string

  .spec .globalExtAuth .extensionRef .namespace

  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/

• boolean

  .spec .globalExtAuth .failOpen

  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.

• string

  .spec .globalExtAuth .responseTimeout

  ResponseTimeout configures maximum time to wait for a check response from the authorization server. Timeout durations are expressed in the Go Duration format. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. The string “infinity” is also a valid input and specifies no timeout.

• object

  .spec .globalExtAuth .withRequestBody

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

• boolean

  .spec .globalExtAuth .withRequestBody .allowPartialMessage

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

• integer

  .spec .globalExtAuth .withRequestBody .maxRequestBytes

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

• boolean

  .spec .globalExtAuth .withRequestBody .packAsBytes

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

• object

  .spec .health

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

• string

  .spec .health .address

  Defines the health address interface.

• integer

  .spec .health .port

  Defines the health port.

• object

  .spec .httpproxy

  HTTPProxy defines parameters on HTTPProxy.

• boolean

  .spec .httpproxy .disablePermitInsecure

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

• object

  .spec .httpproxy .fallbackCertificate

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

• string required

  .spec .httpproxy .fallbackCertificate .name

• string required

  .spec .httpproxy .fallbackCertificate .namespace

• array

  .spec .httpproxy .rootNamespaces

  Restrict Contour to searching these namespaces for root ingress routes.

• object

  .spec .ingress

  Ingress contains parameters for ingress options.

• array

  .spec .ingress .classNames

  Ingress Class Names Contour should use.

• string

  .spec .ingress .statusAddress

  Address to set in Ingress object status.

• object

  .spec .metrics

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

• string

  .spec .metrics .address

  Defines the metrics address interface.

• integer

  .spec .metrics .port

  Defines the metrics port.

• object

  .spec .metrics .tls

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

• string

  .spec .metrics .tls .caFile

  CA filename.

• string

  .spec .metrics .tls .certFile

  Client certificate filename.

• string

  .spec .metrics .tls .keyFile

  Client key filename.

• object

  .spec .policy

  Policy specifies default policy applied if not overridden by the user

• boolean

  .spec .policy .applyToIngress

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

• object

  .spec .policy .requestHeaders

  RequestHeadersPolicy defines the request headers set/removed on all routes

• array

  .spec .policy .requestHeaders .remove

• object

  .spec .policy .requestHeaders .set

• object

  .spec .policy .responseHeaders

  ResponseHeadersPolicy defines the response headers set/removed on all routes

• array

  .spec .policy .responseHeaders .remove

• object

  .spec .policy .responseHeaders .set

• object

  .spec .rateLimitService

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

• object

  .spec .rateLimitService .defaultGlobalRateLimitPolicy

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

• array

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors

  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.

• array required

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries

  Entries is the list of key-value pair generators.

• object

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .genericKey

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

• string

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .genericKey .key

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

• string required

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .genericKey .value

  Value defines the value of the descriptor entry.

• object

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .remoteAddress

  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).

• object

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .requestHeader

  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.

• string required

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .requestHeader .descriptorKey

  DescriptorKey defines the key to use on the descriptor entry.

• string required

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .requestHeader .headerName

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

• object

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .requestHeaderValueMatch

  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.

• boolean

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .requestHeaderValueMatch .expectMatch

  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.

• array

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .requestHeaderValueMatch .headers

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

• string

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .requestHeaderValueMatch .headers[] .contains

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

• string

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .requestHeaderValueMatch .headers[] .exact

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

• boolean

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .requestHeaderValueMatch .headers[] .ignoreCase

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

• string required

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .requestHeaderValueMatch .headers[] .name

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

• string

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .requestHeaderValueMatch .headers[] .notcontains

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

• string

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .requestHeaderValueMatch .headers[] .notexact

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

• boolean

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .requestHeaderValueMatch .headers[] .notpresent

  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.

• boolean

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .requestHeaderValueMatch .headers[] .present

  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.

• string

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .requestHeaderValueMatch .headers[] .regex

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

• boolean

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .requestHeaderValueMatch .headers[] .treatMissingAsEmpty

  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).

• string required

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .descriptors[] .entries[] .requestHeaderValueMatch .value

  Value defines the value of the descriptor entry.

• boolean

  .spec .rateLimitService .defaultGlobalRateLimitPolicy .disabled

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

• string

  .spec .rateLimitService .domain

  Domain is passed to the Rate Limit Service.

• boolean

  .spec .rateLimitService .enableResourceExhaustedCode

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

• boolean

  .spec .rateLimitService .enableXRateLimitHeaders

  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

• object required

  .spec .rateLimitService .extensionService

  ExtensionService identifies the extension service defining the RLS.

• string required

  .spec .rateLimitService .extensionService .name

• string required

  .spec .rateLimitService .extensionService .namespace

• boolean

  .spec .rateLimitService .failOpen

  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.

• object

  .spec .tracing

  Tracing defines properties for exporting trace data to OpenTelemetry.

• array

  .spec .tracing .customTags

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

• string

  .spec .tracing .customTags[] .literal

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

• string

  .spec .tracing .customTags[] .requestHeaderName

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

• string required

  .spec .tracing .customTags[] .tagName

  TagName is the unique name of the custom tag.

• object required

  .spec .tracing .extensionService

  ExtensionService identifies the extension service defining the otel-collector.

• string required

  .spec .tracing .extensionService .name

• string required

  .spec .tracing .extensionService .namespace

• boolean

  .spec .tracing .includePodDetail

  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.

• integer

  .spec .tracing .maxPathTagLength

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

• string

  .spec .tracing .overallSampling

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

• string

  .spec .tracing .serviceName

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

• object

  .spec .xdsServer

  XDSServer contains parameters for the xDS server.

• string

  .spec .xdsServer .address

  Defines the xDS gRPC API address which Contour will serve. Contour’s default is “0.0.0.0”.

• integer

  .spec .xdsServer .port

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

• object

  .spec .xdsServer .tls

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

• string

  .spec .xdsServer .tls .caFile

  CA filename.

• string

  .spec .xdsServer .tls .certFile

  Client certificate filename.

• boolean

  .spec .xdsServer .tls .insecure

  Allow serving the xDS gRPC API without TLS.

• string

  .spec .xdsServer .tls .keyFile

  Client key filename.

• object

  .status

  ContourConfigurationStatus defines the observed state of a ContourConfiguration resource.

• array

  .status .conditions

  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.

• array

  .status .conditions[] .errors

  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.

• string required

  .status .conditions[] .errors[] .message

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

• string required

  .status .conditions[] .errors[] .reason

  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.

• string required

  .status .conditions[] .errors[] .status

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

• string required

  .status .conditions[] .errors[] .type

  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)

• string required

  .status .conditions[] .lastTransitionTime

  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.

• string required

  .status .conditions[] .message

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

• integer

  .status .conditions[] .observedGeneration

  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.

• string required

  .status .conditions[] .reason

  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.

• string required

  .status .conditions[] .status

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

• string required

  .status .conditions[] .type

  type of condition in CamelCase or in foo.example.com/CamelCase.

• array

  .status .conditions[] .warnings

  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.

• string required

  .status .conditions[] .warnings[] .message

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

• string required

  .status .conditions[] .warnings[] .reason

  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.

• string required

  .status .conditions[] .warnings[] .status

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

• string required

  .status .conditions[] .warnings[] .type

  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)