Status is a container for computed information about the HTTPProxy.

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

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.

ExtensionServiceRef specifies the extension resource that will authorize client requests.

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

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.

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.

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

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

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

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

Specifies whether the resource allows credentials.

AllowOrigin specifies the origins that will be allowed to do CORS requests. Allowed values include “*” which signifies any origin is allowed, an exact origin of the form “scheme://host[:port]” (where port is optional), or a valid regex pattern. Note that regex patterns are validated and a simple “glob” pattern (e.g. *.foo.com) will be rejected or produce unexpected matches when applied as a regex.

AllowMethods specifies the content for the access-control-allow-methods header.

AllowHeaders specifies the content for the access-control-allow-headers header.

ExposeHeaders Specifies the content for the access-control-expose-headers header.

MaxAge indicates for how long the results of a preflight request can be cached. MaxAge durations are expressed in the Go Duration format. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”. Only positive values are allowed while 0 disables the cache requiring a preflight OPTIONS check for all cross-origin requests.

required, the name of a secret in the current namespace.

required, the namespaces the authority to reference the the secret will be delegated to. If TargetNamespaces is nil or empty, the CertificateDelegation’ is ignored. If the TargetNamespace list contains the character, “*” the secret will be delegated to all namespaces.

Subject of the client cert.

Client cert in URL encoded PEM format.

Client cert chain (including the leaf cert) in URL encoded PEM format.

DNS type Subject Alternative Names of the client cert.

URI type Subject Alternative Name of the client cert.

Value is the value to rewrite the Domain attribute to. For now this is required.

Value is the value to rewrite the Path attribute to. For now this is required.

Name is the name of the cookie for which attributes will be rewritten.

PathRewrite enables rewriting the Set-Cookie Path element. If not set, Path will not be rewritten.

DomainRewrite enables rewriting the Set-Cookie Domain element. If not set, Domain will not be rewritten.

Secure enables rewriting the Set-Cookie Secure element. If not set, Secure attribute will not be rewritten.

SameSite enables rewriting the Set-Cookie SameSite element. If not set, SameSite attribute will not be rewritten.

(Members of Condition are embedded into this type.)

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.

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.

Name of a Kubernetes secret that contains a CA certificate bundle. The secret must contain key named ca.crt. The client certificate must validate against the certificates in the bundle. If specified and SkipClientCertValidation is true, client certificates will be required on requests.

SkipClientCertValidation disables downstream client certificate validation. Defaults to false. This field is intended to be used in conjunction with external authorization in order to enable the external authorization server to validate client certificates. When this field is set to true, client certificates are requested but not verified by Envoy. If CACertificate is specified, client certificates are required on requests, but not verified. If external authorization is in use, they are presented to the external authorization server.

ForwardClientCertificate adds the selected data from the passed client TLS certificate to the x-forwarded-client-cert header.

Name of a Kubernetes opaque secret that contains a concatenated list of PEM encoded CRLs. The secret must contain key named crl.pem. This field will be used to verify that a client certificate has not been revoked. CRLs must be available from all CAs, unless crlOnlyVerifyLeafCert is true. Large CRL lists are not supported since individual secrets are limited to 1MiB in size.

If this option is set to true, only the certificate at the end of the certificate chain will be subject to validation by CRL.

OptionalClientCertificate when set to true will request a client certificate but allow the connection to continue if the client does not provide one. If a client certificate is sent, it will be verified according to the other properties, which includes disabling validation if SkipClientCertValidation is set. Defaults to false.

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

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/

Name of the referent.

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

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

Value defines the value of the descriptor entry.

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.

StatusCode is the HTTP response status to be returned.

Body is the content of the response body. If this setting is omitted, no body is included in the generated response.

Note: Body is not recommended to set too long otherwise it can have significant resource usage impacts.

HTTP endpoint used to perform health checks on upstream service

The value of the host header in the HTTP health check request. If left empty (default value), the name “contour-envoy-healthcheck” will be used.

The interval (seconds) between health checks

The time to wait (seconds) for a health check response

The number of unhealthy health checks required before a host is marked unhealthy

The number of healthy health checks required before a host is marked healthy

Virtualhost appears at most once. If it is present, the object is considered to be a “root” HTTPProxy.

Routes are the ingress routes. If TCPProxy is present, Routes is ignored.

TCPProxy holds TCP proxy information.

Includes allow for specific routing configuration to be included from another HTTPProxy, possibly in another namespace.

IngressClassName optionally specifies the ingress class to use for this HTTPProxy. This replaces the deprecated kubernetes.io/ingress.class annotation. For backwards compatibility, when that annotation is set, it is given precedence over this field.

LoadBalancer contains the current status of the load balancer.

Conditions contains information about the current status of the HTTPProxy, in an upstream-friendly container.

Contour will update a single condition, Valid, that is in normal-true polarity. That is, when currentStatus is valid, the Valid condition will be status: true, and vice versa.

Contour will leave untouched any other Conditions set in this block, in case some other controller wants to add a Condition.

If you are another controller owner and wish to add a condition, you should namespace your condition with a label, like controller.domain.com/ConditionName.

Scheme is the scheme to be used in the value of the Location header in the response. When empty, the scheme of the request is used.

Hostname is the precise hostname to be used in the value of the Location header in the response. When empty, the hostname of the request is used. No wildcards are allowed.

Port is the port to be used in the value of the Location header in the response. When empty, port (if specified) of the request is used.

StatusCode is the HTTP status code to be used in response.

Path allows for redirection to a different path from the original on the request. The path must start with a leading slash.

Note: Only one of Path or Prefix can be defined.

Prefix defines the value to swap the matched prefix or path with. The prefix must start with a leading slash.

Note: Only one of Path or Prefix can be defined.

HeaderName is the name of the HTTP request header that will be used to calculate the hash key. If the header specified is not present on a request, no hash will be produced.

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

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.

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.

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

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

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

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

Name represents a key of a header

Value represents the value of a header specified by a key

Set specifies a list of HTTP header values that will be set in the HTTP header. If the header does not exist it will be added, otherwise it will be overwritten with the new value.

Remove specifies a list of HTTP header names to remove.

Name of the HTTPProxy

Namespace of the HTTPProxy to include. Defaults to the current namespace if not supplied.

Conditions are a set of rules that are applied to included HTTPProxies. In effect, they are added onto the Conditions of included HTTPProxy Route structs. When applied, they are merged using AND, with one exception: There can be only one Prefix MatchCondition per Conditions slice. More than one Prefix, or contradictory Conditions, will make the include invalid.

Unique name for the provider.

Whether the provider should apply to all routes in the HTTPProxy/its includes by default. At most one provider can be marked as the default. If no provider is marked as the default, individual routes must explicitly identify the provider they require.

Issuer that JWTs are required to have in the “iss” field. If not provided, JWT issuers are not checked.

Audiences that JWTs are allowed to have in the “aud” field. If not provided, JWT audiences are not checked.

Remote JWKS to use for verifying JWT signatures.

Whether the JWT should be forwarded to the backend service after successful verification. By default, the JWT is not forwarded.

Require names a specific JWT provider (defined in the virtual host) to require for the route. If specified, this field overrides the default provider if one exists. If this field is not specified, the default provider will be required if one exists. At most one of this field or the “disabled” field can be specified.

Disabled defines whether to disable all JWT verification for this route. This can be used to opt specific routes out of the default JWT provider for the HTTPProxy. At most one of this field or the “require” field can be specified.

Strategy specifies the policy used to balance requests across the pool of backend pods. Valid policy names are Random, RoundRobin, WeightedLeastRequest, Cookie, and RequestHash. If an unknown strategy name is specified or no policy is supplied, the default RoundRobin policy is used.

RequestHashPolicies contains a list of hash policies to apply when the RequestHash load balancing strategy is chosen. If an element of the supplied list of hash policies is invalid, it will be ignored. If the list of hash policies is empty after validation, the load balancing strategy will fall back to the default RoundRobin.

Requests defines how many requests per unit of time should be allowed before rate limiting occurs.

Unit defines the period of time within which requests over the limit will be rate limited. Valid values are “second”, “minute” and “hour”.

Burst defines the number of requests above the requests per unit that should be allowed within a short period of time.

ResponseStatusCode is the HTTP status code to use for responses to rate-limited requests. Codes must be in the 400-599 range (inclusive). If not specified, the Envoy default of 429 (Too Many Requests) is used.

ResponseHeadersToAdd is an optional list of response headers to set when a request is rate-limited.

Prefix defines a prefix match for a request.

Header specifies the header condition to match.

ReplacePrefix describes how the path prefix should be replaced.

ParameterName is the name of the HTTP request query parameter that will be used to calculate the hash key. If the query parameter specified is not present on a request, no hash will be produced.

Entries is the list of key-value pair generators.

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

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.

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.

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

Local defines local rate limiting parameters, i.e. parameters for rate limiting that occurs within each Envoy pod as requests are handled.

Global defines global rate limiting parameters, i.e. parameters defining descriptors that are sent to an external rate limit service (RLS) for a rate limit decision on each request.

The URI for the JWKS.

UpstreamValidation defines how to verify the JWKS’s TLS certificate.

How long to wait for a response from the URI. If not specified, a default of 1s applies.

How long to cache the JWKS locally. If not specified, Envoy’s default of 5m applies.

The DNS IP address resolution policy for the JWKS URI. 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 “all” is configured, the DNS resolver will perform a lookup for addresses in both the IPv4 and 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 not specified, the Contour-wide setting defined in the config file or ContourConfiguration applies (defaults to “auto”).

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.

Prefix specifies the URL path prefix to be replaced.

If Prefix is specified, it must exactly match the MatchCondition prefix that is rendered by the chain of including HTTPProxies and only that path prefix will be replaced by Replacement. This allows HTTPProxies that are included through multiple roots to only replace specific path prefixes, leaving others unmodified.

If Prefix is not specified, all routing prefixes rendered by the include chain will be replaced.

Replacement is the string that the routing path prefix will be replaced with. This must not be empty.

Terminal is a flag that allows for short-circuiting computing of a hash for a given request. If set to true, and the request attribute specified in the attribute hash options is present, no further hash policies will be used to calculate a hash for the request.

HeaderHashOptions should be set when request header hash based load balancing is desired. It must be the only hash option field set, otherwise this request hash policy object will be ignored.

QueryParameterHashOptions should be set when request query parameter hash based load balancing is desired. It must be the only hash option field set, otherwise this request hash policy object will be ignored.

HashSourceIP should be set to true when request source IP hash based load balancing is desired. It must be the only hash option field set, otherwise this request hash policy object will be ignored.

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

DescriptorKey defines the key to use on the descriptor entry.

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

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.

Value defines the value of the descriptor entry.

NumRetries is maximum allowed number of retries. If set to -1, then retries are disabled. If set to 0 or not supplied, the value is set to the Envoy default of 1.

PerTryTimeout specifies the timeout per retry attempt. Ignored if NumRetries is not supplied.

RetryOn specifies the conditions on which to retry a request.

Supported HTTP conditions:

• 5xx
• gateway-error
• reset
• connect-failure
• retriable-4xx
• refused-stream
• retriable-status-codes
• retriable-headers

Supported gRPC conditions:

• cancelled
• deadline-exceeded
• internal
• resource-exhausted
• unavailable

RetriableStatusCodes specifies the HTTP status codes that should be retried.

This field is only respected when you include retriable-status-codes in the RetryOn field.

Conditions are a set of rules that are applied to a Route. When applied, they are merged using AND, with one exception: There can be only one Prefix MatchCondition per Conditions slice. More than one Prefix, or contradictory Conditions, will make the route invalid.

Services are the services to proxy traffic.

Enables websocket support for the route.

Allow this path to respond to insecure requests over HTTP which are normally not permitted when a virtualhost.tls block is present.

AuthPolicy updates the authorization policy that was set on the root HTTPProxy object for client requests that match this route.

The timeout policy for this route.

The retry policy for this route.

The health check policy for this route.

The load balancing policy for this route.

The policy for rewriting the path of the request URL after the request has been routed to a Service.

The policy for managing request headers during proxying.

The policy for managing response headers during proxying. Rewriting the ‘Host’ header is not supported.

The policies for rewriting Set-Cookie header attributes. Note that rewritten cookie names must be unique in this list. Order rewrite policies are specified in does not matter.

The policy for rate limiting on the route.

RequestRedirectPolicy defines an HTTP redirection.

DirectResponsePolicy returns an arbitrary HTTP response directly.

The policy for verifying JWTs for requests to this route.

Name is the name of Kubernetes service to proxy traffic. Names defined here will be used to look up corresponding endpoints which contain the ips to route.

Port (defined as Integer) to proxy traffic to since a service can have multiple defined.

HealthPort is the port for this service healthcheck. If not specified, Port is used for service healthchecks.

Protocol may be used to specify (or override) the protocol used to reach this Service. Values may be tls, h2, h2c. If omitted, protocol-selection falls back on Service annotations.

Weight defines percentage of traffic to balance traffic

UpstreamValidation defines how to verify the backend service’s certificate

If Mirror is true the Service will receive a read only mirror of the traffic for this route.

The policy for managing request headers during proxying. Rewriting the ‘Host’ header is not supported.

The policy for managing response headers during proxying. Rewriting the ‘Host’ header is not supported.

The policies for rewriting Set-Cookie header attributes.

Slow start will gradually increase amount of traffic to a newly added endpoint.

The duration of slow start window. Duration is expressed in the Go Duration format. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h”.

The speed of traffic increase over the slow start window. Defaults to 1.0, so that endpoint would get linearly increasing amount of traffic. When increasing the value for this parameter, the speed of traffic ramp-up increases non-linearly. The value of aggression parameter should be greater than 0.0.

More info: https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/load_balancing/slow_start

The minimum or starting percentage of traffic to send to new endpoints. A non-zero value helps avoid a too small initial weight, which may cause endpoints in slow start mode to receive no traffic in the beginning of the slow start window. If not specified, the default is 10%.

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)

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

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.

Message is a human readable message indicating details about the transition.

This may be an empty string.

The interval (seconds) between health checks

The time to wait (seconds) for a health check response

The number of unhealthy health checks required before a host is marked unhealthy

The number of healthy health checks required before a host is marked healthy

The load balancing policy for the backend services. Note that the Cookie and RequestHash load balancing strategies cannot be used here.

Services are the services to proxy traffic

Include specifies that this tcpproxy should be delegated to another HTTPProxy.

IncludesDeprecated allow for specific routing configuration to be appended to another HTTPProxy in another namespace.

Exists due to a mistake when developing HTTPProxy and the field was marked plural when it should have been singular. This field should stay to not break backwards compatibility to v1 users.

The health check policy for this tcp proxy

Name of the child HTTPProxy

Namespace of the HTTPProxy to include. Defaults to the current namespace if not supplied.

SecretName is the name of a TLS secret in the current namespace. Either SecretName or Passthrough must be specified, but not both. If specified, the named secret must contain a matching certificate for the virtual host’s FQDN.

MinimumProtocolVersion is the minimum TLS version this vhost should negotiate. Valid options are 1.2 (default) and 1.3. Any other value defaults to TLS 1.2.

Passthrough defines whether the encrypted TLS handshake will be passed through to the backing cluster. Either Passthrough or SecretName must be specified, but not both.

ClientValidation defines how to verify the client certificate when an external client establishes a TLS connection to Envoy.

This setting:

1. Enables TLS client certificate validation.
2. Specifies how the client certificate will be validated (i.e. validation required or skipped).

Note: Setting client certificate validation to be skipped should be only used in conjunction with an external authorization server that performs client validation as Contour will ensure client certificates are passed along.

EnableFallbackCertificate defines if the vhost should allow a default certificate to be applied which handles all requests which don’t match the SNI defined in this vhost.

Conditions contains information about the current status of the HTTPProxy, in an upstream-friendly container.

Contour will update a single condition, Valid, that is in normal-true polarity. That is, when currentStatus is valid, the Valid condition will be status: true, and vice versa.

Contour will leave untouched any other Conditions set in this block, in case some other controller wants to add a Condition.

If you are another controller owner and wish to add a condition, you should namespace your condition with a label, like controller.domain.com\ConditionName.

Timeout for receiving a response from the server after processing a request from client. If not supplied, Envoy’s default value of 15s applies.

Timeout for how long the proxy should wait while there is no activity during single request/response (for HTTP/1.1) or stream (for HTTP/2). Timeout will not trigger while HTTP/1.1 connection is idle between two consecutive requests. If not specified, there is no per-route idle timeout, though a connection manager-wide stream_idle_timeout default of 5m still applies.

Timeout for how long connection from the proxy to the upstream service is kept when there are no active requests. If not supplied, Envoy’s default value of 1h applies.

Name or namespaced name of the Kubernetes secret used to validate the certificate presented by the backend. The secret must contain key named ca.crt.

Key which is expected to be present in the ‘subjectAltName’ of the presented certificate.

The fully qualified domain name of the root of the ingress tree all leaves of the DAG rooted at this object relate to the fqdn.

If present the fields describes TLS properties of the virtual host. The SNI names that will be matched on are described in fqdn, the tls.secretName secret must contain a certificate that itself contains a name that matches the FQDN.

This field configures an extension service to perform authorization for this virtual host. Authorization can only be configured on virtual hosts that have TLS enabled. If the TLS configuration requires client certificate validation, the client certificate is always included in the authentication check request.

Specifies the cross-origin policy to apply to the VirtualHost.

The policy for rate limiting on the virtual host.

Providers to use for verifying JSON Web Tokens (JWTs) on the virtual host.

"disabled"

Disable the access log.

"error"

Log only requests that result in an error.

"info"

Log all requests. This is the default.

"envoy"

DefaultAccessLogType is the default access log format.

"envoy"

Set the Envoy access logging to Envoy’s standard format. Can be customized using accessLogFormatString.

"json"

Set the Envoy access logging to a JSON format. Can be customized using jsonFields.

"all"

DNS lookups will attempt both v4 and v6 queries.

"auto"

DNS lookups will do a v6 lookup first, followed by a v4 if that fails.

"v4"

DNS lookups will only attempt v4 queries.

"v6"

DNS lookups will only attempt v6 queries.

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.

XDSServer contains parameters for the xDS server.

Ingress contains parameters for ingress options.

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

Health defines the endpoints Contour uses to serve health checks.

Contour’s default is { address: “0.0.0.0”, port: 8000 }.

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

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

HTTPProxy defines parameters on HTTPProxy.

EnableExternalNameService allows processing of ExternalNameServices

Contour’s default is false for security reasons.

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

Policy specifies default policy applied if not overridden by the user

Metrics defines the endpoint Contour uses to serve metrics.

Contour’s default is { address: “0.0.0.0”, port: 8000 }.

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.

Contour specifies deployment-time settings for the Contour part of the installation, i.e. the xDS server/control plane and associated resources, including things like replica count for the Deployment, and node placement constraints for the pods.

Envoy specifies deployment-time settings for the Envoy part of the installation, i.e. the xDS client/data plane and associated resources, including things like the workload type to use (DaemonSet or Deployment), node placement constraints for the pods, and various options for the Envoy service.

RuntimeSettings is a ContourConfiguration spec to be used when provisioning a Contour instance that will influence aspects of the Contour instance’s runtime behavior.

ResourceLabels is a set of labels to add to the provisioned Contour resources.

Conditions describe the current conditions of the ContourDeployment resource.

Deprecated: Use DeploymentSettings.Replicas instead.

Replicas is the desired number of Contour replicas. If if unset, defaults to 2.

if both DeploymentSettings.Replicas and this one is set, use DeploymentSettings.Replicas.

NodePlacement describes node scheduling configuration of Contour pods.

KubernetesLogLevel Enable Kubernetes client debug logging with log level. If unset, defaults to 0.

LogLevel sets the log level for Contour Allowed values are “info”, “debug”.

Compute Resources required by contour container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Deployment describes the settings for running contour as a Deployment.

Strategy describes the deployment strategy to use to replace existing DaemonSet pods with new pods.

Defines the Contour debug address interface.

Contour’s default is “127.0.0.1”.

Defines the Contour debug address port.

Contour’s default is 6060.

Replicas is the desired number of replicas.

Strategy describes the deployment strategy to use to replace existing pods with new pods.

Listener hold various configurable Envoy listener values.

Service holds Envoy service parameters for setting Ingress status.

Contour’s default is { namespace: “projectcontour”, name: “envoy” }.

Defines the HTTP Listener for Envoy.

Contour’s default is { address: “0.0.0.0”, port: 8080, accessLog: “/dev/stdout” }.

Defines the HTTPS Listener for Envoy.

Contour’s default is { address: “0.0.0.0”, port: 8443, accessLog: “/dev/stdout” }.

Health defines the endpoint Envoy uses to serve health checks.

Contour’s default is { address: “0.0.0.0”, port: 8002 }.

Metrics defines the endpoint Envoy uses to serve metrics.

Contour’s default is { address: “0.0.0.0”, port: 8002 }.

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.

Logging defines how Envoy’s logs can be configured.

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.

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

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

Network holds various configurable Envoy network values.

Defines an Envoy Listener Address.

Defines an Envoy listener Port.

AccessLog defines where Envoy logs are outputted for this listener.

Use PROXY protocol for all listeners.

Contour’s default is false.

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 disables Envoy’s non-standard merge_slashes path transformation option which strips duplicate slashes from request URL paths.

Contour’s default is false.

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.

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.

TLS holds various configurable Envoy TLS listener values.

AccessLogFormat sets the global access log format.

Values: envoy (default), json.

Other values will produce an error.

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

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

AccessLogLevel sets the verbosity level of the access log.

Values: info (default, meaning all requests are logged), error and disabled.

Other values will produce an error.

WorkloadType is the type of workload to install Envoy as. Choices are DaemonSet and Deployment. If unset, defaults to DaemonSet.

Deprecated: Use DeploymentSettings.Replicas instead.

Replicas is the desired number of Envoy replicas. If WorkloadType is not “Deployment”, this field is ignored. Otherwise, if unset, defaults to 2.

if both DeploymentSettings.Replicas and this one is set, use DeploymentSettings.Replicas.

NetworkPublishing defines how to expose Envoy to a network.

NodePlacement describes node scheduling configuration of Envoy pods.

ExtraVolumes holds the extra volumes to add.

ExtraVolumeMounts holds the extra volume mounts to add (normally used with extraVolumes).

PodAnnotations defines annotations to add to the Envoy pods.

Compute Resources required by envoy container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

LogLevel sets the log level for Envoy. Allowed values are “trace”, “debug”, “info”, “warn”, “error”, “critical”, “off”.

DaemonSet describes the settings for running envoy as a DaemonSet. if WorkloadType is Deployment,it’s must be nil

Deployment describes the settings for running envoy as a Deployment. if WorkloadType is DaemonSet,it’s must be nil

MinimumProtocolVersion is the minimum TLS version this vhost should negotiate.

Values: 1.2 (default), 1.3.

Other values will produce an error.

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.

"v2"

SupportProtocolVersion2 requests the “v2” support protocol version.

Deprecated: this protocol version is no longer supported and the constant is retained for backwards compatibility only.

"v3"

SupportProtocolVersion3 requests the “v3” support protocol version.

Services specifies the set of Kubernetes Service resources that receive GRPC extension API requests. If no weights are specified for any of the entries in this array, traffic will be spread evenly across all the services. Otherwise, traffic is balanced proportionally to the Weight field in each entry.

UpstreamValidation defines how to verify the backend service’s certificate

Protocol may be used to specify (or override) the protocol used to reach this Service. Values may be h2 or h2c. If omitted, protocol-selection falls back on Service annotations.

The policy for load balancing GRPC service requests. Note that the Cookie and RequestHash load balancing strategies cannot be used here.

The timeout policy for requests to the services.

This field sets the version of the GRPC protocol that Envoy uses to send requests to the extension service. Since Contour always uses the v3 Envoy API, this is currently fixed at “v3”. However, other protocol options will be available in future.

Conditions contains the current status of the ExtensionService 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.

Name is the name of Kubernetes service that will accept service traffic.

Port (defined as Integer) to proxy traffic to since a service can have multiple defined.

Weight defines proportion of traffic to balance to the Kubernetes Service.

ControllerName is used to determine whether Contour should reconcile a GatewayClass. The string takes the form of “projectcontour.io//contour”. If unset, the gatewayclass controller will not be started. Exactly one of ControllerName or GatewayRef must be set.

GatewayRef defines a specific Gateway that this Contour instance corresponds to. If set, Contour will reconcile only this gateway, and will not reconcile any gateway classes. Exactly one of ControllerName or GatewayRef must be set.

DisablePermitInsecure disables the use of the permitInsecure field in HTTPProxy.

Contour’s default is false.

Restrict Contour to searching these namespaces for root ingress routes.

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

"HTTP/1.1"

HTTPVersion1 is the name of the HTTP/1.1 version.

"HTTP/2"

HTTPVersion2 is the name of the HTTP/2 version.

Defines the health address interface.

Defines the health port.

Ingress Class Names Contour should use.

Address to set in Ingress object status.

"critical"

CriticalLog sets the log level for Envoy to critical.

"debug"

DebugLog sets the log level for Contour/Envoy to debug.

"error"

ErrorLog sets the log level for Envoy to error.

"info"

InfoLog sets the log level for Contour/Envoy to info.

"off"

OffLog disable logging for Envoy.

"trace"

TraceLog sets the log level for Envoy to trace.

"warn"

WarnLog sets the log level for Envoy to warn.

Defines the metrics address interface.

Defines the metrics port.

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

CA filename.

Client certificate filename.

Client key filename.

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.

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.

NetworkPublishingType is the type of publishing strategy to use. Valid values are:

• LoadBalancerService

In this configuration, network endpoints for Envoy use container networking. A Kubernetes LoadBalancer Service is created to publish Envoy network endpoints.

See: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer

• NodePortService

Publishes Envoy network endpoints using a Kubernetes NodePort Service.

In this configuration, Envoy network endpoints use container networking. A Kubernetes NodePort Service is created to publish the network endpoints.

See: https://kubernetes.io/docs/concepts/services-networking/service/#nodeport

NOTE: When provisioning an Envoy NodePortService, use Gateway Listeners’ port numbers to populate the Service’s node port values, there’s no way to auto-allocate them.

See: https://github.com/projectcontour/contour/issues/4499

• ClusterIPService

Publishes Envoy network endpoints using a Kubernetes ClusterIP Service.

In this configuration, Envoy network endpoints use container networking. A Kubernetes ClusterIP Service is created to publish the network endpoints.

See: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types

If unset, defaults to LoadBalancerService.

ExternalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service’s “externally-facing” addresses (NodePorts, ExternalIPs, and LoadBalancer IPs).

If unset, defaults to “Local”.

ServiceAnnotations is the annotations to add to the provisioned Envoy service.

"ClusterIPService"

ClusterIPServicePublishingType publishes a network endpoint using a Kubernetes ClusterIP Service.

"LoadBalancerService"

LoadBalancerServicePublishingType publishes a network endpoint using a Kubernetes LoadBalancer Service.

"NodePortService"

NodePortServicePublishingType publishes a network endpoint using a Kubernetes NodePort Service.

NodeSelector is the simplest recommended form of node selection constraint and specifies a map of key-value pairs. For the pod to be eligible to run on a node, the node must have each of the indicated key-value pairs as labels (it can have additional labels as well).

If unset, the pod(s) will be scheduled to any available node.

Tolerations work with taints to ensure that pods are not scheduled onto inappropriate nodes. One or more taints are applied to a node; this marks that the node should not accept any pods that do not tolerate the taints.

The default is an empty list.

See https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ for additional details.

RequestHeadersPolicy defines the request headers set/removed on all routes

ResponseHeadersPolicy defines the response headers set/removed on all routes

ApplyToIngress determines if the Policies will apply to ingress objects

Contour’s default is false.

ExtensionService identifies the extension service defining the RLS.

Domain is passed to the Rate Limit Service.

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.

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

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

"append_if_absent"

If no Server header is present, set it to “envoy”. If a Server header is present, pass it through.

"overwrite"

Overwrite any Server header with “envoy”. This is the default value.

"pass_through"

Pass through the value of the Server header, and do not append a header if none is present.

CA filename.

Client certificate filename.

Client key filename.

Allow serving the xDS gRPC API without TLS.

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.

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.

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.

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.

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.

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.

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.

Defines the XDSServer to use for contour serve.

Values: contour (default), envoy.

Other values will produce an error.

Defines the xDS gRPC API address which Contour will serve.

Contour’s default is “0.0.0.0”.

Defines the xDS gRPC API port which Contour will serve.

Contour’s default is 8001.

TLS holds TLS file config details.

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

"contour"

Use Contour’s xDS server.

"envoy"

Use the upstream go-control-plane-based xDS server.