Skip to content

projectcontour.v1alpha1.contourConfiguration

"ContourConfiguration is the schema for a Contour instance."

Index

Fields

fn new

new(name)

new returns an instance of ContourConfiguration

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"ContourConfigurationSpec represents a configuration of a Contour controller.\nIt contains most of all the options that can be customized, the\nother remaining options being command line flags."

fn spec.withEnableExternalNameService

withEnableExternalNameService(enableExternalNameService)

"EnableExternalNameService allows processing of ExternalNameServices\nContour's default is false for security reasons."

fn spec.withFeatureFlags

withFeatureFlags(featureFlags)

"FeatureFlags defines toggle to enable new contour features.\nAvailable toggles are:\nuseEndpointSlices - configures contour to fetch endpoint data\nfrom k8s endpoint slices. defaults to false and reading endpoint\ndata from the k8s endpoints."

fn spec.withFeatureFlagsMixin

withFeatureFlagsMixin(featureFlags)

"FeatureFlags defines toggle to enable new contour features.\nAvailable toggles are:\nuseEndpointSlices - configures contour to fetch endpoint data\nfrom k8s endpoint slices. defaults to false and reading endpoint\ndata from the k8s endpoints."

Note: This function appends passed data to existing values

obj spec.debug

"Debug contains parameters to enable debug logging\nand debug interfaces inside Contour."

fn spec.debug.withAddress

withAddress(address)

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

fn spec.debug.withPort

withPort(port)

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

obj spec.envoy

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

fn spec.envoy.withDefaultHTTPVersions

withDefaultHTTPVersions(defaultHTTPVersions)

"DefaultHTTPVersions defines the default set of HTTPS\nversions the proxy should accept. HTTP versions are\nstrings of the form \"HTTP/xx\". Supported versions are\n\"HTTP/1.1\" and \"HTTP/2\".\nValues: HTTP/1.1, HTTP/2 (default: both).\nOther values will produce an error."

fn spec.envoy.withDefaultHTTPVersionsMixin

withDefaultHTTPVersionsMixin(defaultHTTPVersions)

"DefaultHTTPVersions defines the default set of HTTPS\nversions the proxy should accept. HTTP versions are\nstrings of the form \"HTTP/xx\". Supported versions are\n\"HTTP/1.1\" and \"HTTP/2\".\nValues: HTTP/1.1, HTTP/2 (default: both).\nOther values will produce an error."

Note: This function appends passed data to existing values

obj spec.envoy.clientCertificate

"ClientCertificate defines the namespace/name of the Kubernetes\nsecret containing the client certificate and private key\nto be used when establishing TLS connection to upstream\ncluster."

fn spec.envoy.clientCertificate.withName

withName(name)

fn spec.envoy.clientCertificate.withNamespace

withNamespace(namespace)

obj spec.envoy.cluster

"Cluster holds various configurable Envoy cluster values that can\nbe set in the config file."

fn spec.envoy.cluster.withDnsLookupFamily

withDnsLookupFamily(dnsLookupFamily)

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

fn spec.envoy.cluster.withMaxRequestsPerConnection

withMaxRequestsPerConnection(maxRequestsPerConnection)

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

fn spec.envoy.cluster.withPer-Connection-Buffer-Limit-Bytes

withPer-Connection-Buffer-Limit-Bytes(per_connection_buffer_limit_bytes)

"Defines the soft limit on size of the cluster’s new connection read and write buffers in bytes.\nIf unspecified, an implementation defined default is applied (1MiB).\nsee 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\nfor more information."

obj spec.envoy.cluster.circuitBreakers

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

fn spec.envoy.cluster.circuitBreakers.withMaxConnections

withMaxConnections(maxConnections)

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

fn spec.envoy.cluster.circuitBreakers.withMaxPendingRequests

withMaxPendingRequests(maxPendingRequests)

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

fn spec.envoy.cluster.circuitBreakers.withMaxRequests

withMaxRequests(maxRequests)

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

fn spec.envoy.cluster.circuitBreakers.withMaxRetries

withMaxRetries(maxRetries)

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

obj spec.envoy.cluster.upstreamTLS

"UpstreamTLS contains the TLS policy parameters for upstream connections"

fn spec.envoy.cluster.upstreamTLS.withCipherSuites

withCipherSuites(cipherSuites)

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

fn spec.envoy.cluster.upstreamTLS.withCipherSuitesMixin

withCipherSuitesMixin(cipherSuites)

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

Note: This function appends passed data to existing values

fn spec.envoy.cluster.upstreamTLS.withMaximumProtocolVersion

withMaximumProtocolVersion(maximumProtocolVersion)

"MaximumProtocolVersion is the maximum TLS version this vhost should\nnegotiate.\nValues: 1.2, 1.3(default).\nOther values will produce an error."

fn spec.envoy.cluster.upstreamTLS.withMinimumProtocolVersion

withMinimumProtocolVersion(minimumProtocolVersion)

"MinimumProtocolVersion is the minimum TLS version this vhost should\nnegotiate.\nValues: 1.2 (default), 1.3.\nOther values will produce an error."

obj spec.envoy.health

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

fn spec.envoy.health.withAddress

withAddress(address)

"Defines the health address interface."

fn spec.envoy.health.withPort

withPort(port)

"Defines the health port."

obj spec.envoy.http

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

fn spec.envoy.http.withAccessLog

withAccessLog(accessLog)

"AccessLog defines where Envoy logs are outputted for this listener."

fn spec.envoy.http.withAddress

withAddress(address)

"Defines an Envoy Listener Address."

fn spec.envoy.http.withPort

withPort(port)

"Defines an Envoy listener Port."

obj spec.envoy.https

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

fn spec.envoy.https.withAccessLog

withAccessLog(accessLog)

"AccessLog defines where Envoy logs are outputted for this listener."

fn spec.envoy.https.withAddress

withAddress(address)

"Defines an Envoy Listener Address."

fn spec.envoy.https.withPort

withPort(port)

"Defines an Envoy listener Port."

obj spec.envoy.listener

"Listener hold various configurable Envoy listener values."

fn spec.envoy.listener.withConnectionBalancer

withConnectionBalancer(connectionBalancer)

"ConnectionBalancer. If the value is exact, the listener will use the exact connection balancer\nSee https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/listener.proto#envoy-api-msg-listener-connectionbalanceconfig\nfor more information.\nValues: (empty string): use the default ConnectionBalancer, exact: use the Exact ConnectionBalancer.\nOther values will produce an error."

fn spec.envoy.listener.withDisableAllowChunkedLength

withDisableAllowChunkedLength(disableAllowChunkedLength)

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

fn spec.envoy.listener.withDisableMergeSlashes

withDisableMergeSlashes(disableMergeSlashes)

"DisableMergeSlashes disables Envoy's non-standard merge_slashes path transformation option\nwhich strips duplicate slashes from request URL paths.\nContour's default is false."

fn spec.envoy.listener.withHttpMaxConcurrentStreams

withHttpMaxConcurrentStreams(httpMaxConcurrentStreams)

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

fn spec.envoy.listener.withMaxConnectionsPerListener

withMaxConnectionsPerListener(maxConnectionsPerListener)

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

fn spec.envoy.listener.withMaxRequestsPerConnection

withMaxRequestsPerConnection(maxRequestsPerConnection)

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

fn spec.envoy.listener.withMaxRequestsPerIOCycle

withMaxRequestsPerIOCycle(maxRequestsPerIOCycle)

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

fn spec.envoy.listener.withPer-Connection-Buffer-Limit-Bytes

withPer-Connection-Buffer-Limit-Bytes(per_connection_buffer_limit_bytes)

"Defines the soft limit on size of the listener’s new connection read and write buffers in bytes.\nIf unspecified, an implementation defined default is applied (1MiB).\nsee 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\nfor more information."

fn spec.envoy.listener.withServerHeaderTransformation

withServerHeaderTransformation(serverHeaderTransformation)

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

fn spec.envoy.listener.withUseProxyProtocol

withUseProxyProtocol(useProxyProtocol)

"Use PROXY protocol for all listeners.\nContour's default is false."

obj spec.envoy.listener.socketOptions

"SocketOptions defines configurable socket options for the listeners.\nSingle set of options are applied to all listeners."

fn spec.envoy.listener.socketOptions.withTos

withTos(tos)

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

fn spec.envoy.listener.socketOptions.withTrafficClass

withTrafficClass(trafficClass)

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

obj spec.envoy.listener.tls

"TLS holds various configurable Envoy TLS listener values."

fn spec.envoy.listener.tls.withCipherSuites

withCipherSuites(cipherSuites)

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

fn spec.envoy.listener.tls.withCipherSuitesMixin

withCipherSuitesMixin(cipherSuites)

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

Note: This function appends passed data to existing values

fn spec.envoy.listener.tls.withMaximumProtocolVersion

withMaximumProtocolVersion(maximumProtocolVersion)

"MaximumProtocolVersion is the maximum TLS version this vhost should\nnegotiate.\nValues: 1.2, 1.3(default).\nOther values will produce an error."

fn spec.envoy.listener.tls.withMinimumProtocolVersion

withMinimumProtocolVersion(minimumProtocolVersion)

"MinimumProtocolVersion is the minimum TLS version this vhost should\nnegotiate.\nValues: 1.2 (default), 1.3.\nOther values will produce an error."

obj spec.envoy.logging

"Logging defines how Envoy's logs can be configured."

fn spec.envoy.logging.withAccessLogFormat

withAccessLogFormat(accessLogFormat)

"AccessLogFormat sets the global access log format.\nValues: envoy (default), json.\nOther values will produce an error."

fn spec.envoy.logging.withAccessLogFormatString

withAccessLogFormatString(accessLogFormatString)

"AccessLogFormatString sets the access log format when format is set to envoy.\nWhen empty, Envoy's default format is used."

fn spec.envoy.logging.withAccessLogJSONFields

withAccessLogJSONFields(accessLogJSONFields)

"AccessLogJSONFields sets the fields that JSON logging will\noutput when AccessLogFormat is json."

fn spec.envoy.logging.withAccessLogJSONFieldsMixin

withAccessLogJSONFieldsMixin(accessLogJSONFields)

"AccessLogJSONFields sets the fields that JSON logging will\noutput when AccessLogFormat is json."

Note: This function appends passed data to existing values

fn spec.envoy.logging.withAccessLogLevel

withAccessLogLevel(accessLogLevel)

"AccessLogLevel sets the verbosity level of the access log.\nValues: 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.\nOther values will produce an error."

obj spec.envoy.metrics

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

fn spec.envoy.metrics.withAddress

withAddress(address)

"Defines the metrics address interface."

fn spec.envoy.metrics.withPort

withPort(port)

"Defines the metrics port."

obj spec.envoy.metrics.tls

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

fn spec.envoy.metrics.tls.withCaFile

withCaFile(caFile)

"CA filename."

fn spec.envoy.metrics.tls.withCertFile

withCertFile(certFile)

"Client certificate filename."

fn spec.envoy.metrics.tls.withKeyFile

withKeyFile(keyFile)

"Client key filename."

obj spec.envoy.network

"Network holds various configurable Envoy network values."

fn spec.envoy.network.withAdminPort

withAdminPort(adminPort)

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

fn spec.envoy.network.withNumTrustedHops

withNumTrustedHops(numTrustedHops)

"XffNumTrustedHops defines the number of additional ingress proxy hops from the\nright side of the x-forwarded-for HTTP header to trust when determining the origin\nclient’s IP address.\nSee 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\nfor more information.\nContour's default is 0."

obj spec.envoy.service

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

fn spec.envoy.service.withName

withName(name)

fn spec.envoy.service.withNamespace

withNamespace(namespace)

obj spec.envoy.timeouts

"Timeouts holds various configurable timeouts that can\nbe set in the config file."

fn spec.envoy.timeouts.withConnectTimeout

withConnectTimeout(connectTimeout)

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

fn spec.envoy.timeouts.withConnectionIdleTimeout

withConnectionIdleTimeout(connectionIdleTimeout)

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

fn spec.envoy.timeouts.withConnectionShutdownGracePeriod

withConnectionShutdownGracePeriod(connectionShutdownGracePeriod)

"ConnectionShutdownGracePeriod defines how long the proxy will wait between sending an\ninitial GOAWAY frame and a second, final GOAWAY frame when terminating an HTTP/2 connection.\nDuring this grace period, the proxy will continue to respond to new streams. After the final\nGOAWAY frame has been sent, the proxy will refuse new streams.\nSee 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\nfor more information."

fn spec.envoy.timeouts.withDelayedCloseTimeout

withDelayedCloseTimeout(delayedCloseTimeout)

"DelayedCloseTimeout defines how long envoy will wait, once connection\nclose processing has been initiated, for the downstream peer to close\nthe connection before Envoy closes the socket associated with the connection.\nSetting this timeout to 'infinity' will disable it, equivalent to setting it to '0'\nin Envoy. Leaving it unset will result in the Envoy default value being used.\nSee 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\nfor more information."

fn spec.envoy.timeouts.withMaxConnectionDuration

withMaxConnectionDuration(maxConnectionDuration)

"MaxConnectionDuration defines the maximum period of time after an HTTP connection\nhas been established from the client to the proxy before it is closed by the proxy,\nregardless of whether there has been activity or not. Omit or set to \"infinity\" for\nno max duration.\nSee 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\nfor more information."

fn spec.envoy.timeouts.withRequestTimeout

withRequestTimeout(requestTimeout)

"RequestTimeout sets the client request timeout globally for Contour. Note that\nthis is a timeout for the entire request, not an idle timeout. Omit or set to\n\"infinity\" to disable the timeout entirely.\nSee 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\nfor more information."

fn spec.envoy.timeouts.withStreamIdleTimeout

withStreamIdleTimeout(streamIdleTimeout)

"StreamIdleTimeout defines how long the proxy should wait while there is no\nrequest activity (for HTTP/1.1) or stream activity (for HTTP/2) before\nterminating the HTTP request or stream. Set to \"infinity\" to disable the\ntimeout entirely.\nSee 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\nfor more information."

obj spec.gateway

"Gateway contains parameters for the gateway-api Gateway that Contour\nis configured to serve traffic."

fn spec.gateway.withControllerName

withControllerName(controllerName)

"ControllerName is used to determine whether Contour should reconcile a\nGatewayClass. The string takes the form of \"projectcontour.io//contour\".\nIf unset, the gatewayclass controller will not be started.\nExactly one of ControllerName or GatewayRef must be set.\nDeprecated: users should use GatewayRef, or the Gateway provisioner,\nin place of this field. This field will be removed in a future release."

obj spec.gateway.gatewayRef

"GatewayRef defines a specific Gateway that this Contour\ninstance corresponds to. If set, Contour will reconcile\nonly this gateway, and will not reconcile any gateway\nclasses.\nExactly one of ControllerName or GatewayRef must be set."

fn spec.gateway.gatewayRef.withName

withName(name)

fn spec.gateway.gatewayRef.withNamespace

withNamespace(namespace)

obj spec.globalExtAuth

"GlobalExternalAuthorization allows envoys external authorization filter\nto be enabled for all virtual hosts."

fn spec.globalExtAuth.withFailOpen

withFailOpen(failOpen)

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

fn spec.globalExtAuth.withResponseTimeout

withResponseTimeout(responseTimeout)

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

obj spec.globalExtAuth.authPolicy

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

fn spec.globalExtAuth.authPolicy.withContext

withContext(context)

"Context is a set of key/value pairs that are sent to the\nauthentication server in the check request. If a context\nis provided at an enclosing scope, the entries are merged\nsuch that the inner scope overrides matching keys from the\nouter scope."

fn spec.globalExtAuth.authPolicy.withContextMixin

withContextMixin(context)

"Context is a set of key/value pairs that are sent to the\nauthentication server in the check request. If a context\nis provided at an enclosing scope, the entries are merged\nsuch that the inner scope overrides matching keys from the\nouter scope."

Note: This function appends passed data to existing values

fn spec.globalExtAuth.authPolicy.withDisabled

withDisabled(disabled)

"When true, this field disables client request authentication\nfor the scope of the policy."

obj spec.globalExtAuth.extensionRef

"ExtensionServiceRef specifies the extension resource that will authorize client requests."

fn spec.globalExtAuth.extensionRef.withApiVersion

withApiVersion(apiVersion)

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

fn spec.globalExtAuth.extensionRef.withName

withName(name)

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

fn spec.globalExtAuth.extensionRef.withNamespace

withNamespace(namespace)

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

obj spec.globalExtAuth.withRequestBody

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

fn spec.globalExtAuth.withRequestBody.withAllowPartialMessage

withAllowPartialMessage(allowPartialMessage)

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

fn spec.globalExtAuth.withRequestBody.withMaxRequestBytes

withMaxRequestBytes(maxRequestBytes)

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

fn spec.globalExtAuth.withRequestBody.withPackAsBytes

withPackAsBytes(packAsBytes)

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

obj spec.health

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

fn spec.health.withAddress

withAddress(address)

"Defines the health address interface."

fn spec.health.withPort

withPort(port)

"Defines the health port."

obj spec.httpproxy

"HTTPProxy defines parameters on HTTPProxy."

fn spec.httpproxy.withDisablePermitInsecure

withDisablePermitInsecure(disablePermitInsecure)

"DisablePermitInsecure disables the use of the\npermitInsecure field in HTTPProxy.\nContour's default is false."

fn spec.httpproxy.withRootNamespaces

withRootNamespaces(rootNamespaces)

"Restrict Contour to searching these namespaces for root ingress routes."

fn spec.httpproxy.withRootNamespacesMixin

withRootNamespacesMixin(rootNamespaces)

"Restrict Contour to searching these namespaces for root ingress routes."

Note: This function appends passed data to existing values

obj spec.httpproxy.fallbackCertificate

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

fn spec.httpproxy.fallbackCertificate.withName

withName(name)

fn spec.httpproxy.fallbackCertificate.withNamespace

withNamespace(namespace)

obj spec.ingress

"Ingress contains parameters for ingress options."

fn spec.ingress.withClassNames

withClassNames(classNames)

"Ingress Class Names Contour should use."

fn spec.ingress.withClassNamesMixin

withClassNamesMixin(classNames)

"Ingress Class Names Contour should use."

Note: This function appends passed data to existing values

fn spec.ingress.withStatusAddress

withStatusAddress(statusAddress)

"Address to set in Ingress object status."

obj spec.metrics

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

fn spec.metrics.withAddress

withAddress(address)

"Defines the metrics address interface."

fn spec.metrics.withPort

withPort(port)

"Defines the metrics port."

obj spec.metrics.tls

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

fn spec.metrics.tls.withCaFile

withCaFile(caFile)

"CA filename."

fn spec.metrics.tls.withCertFile

withCertFile(certFile)

"Client certificate filename."

fn spec.metrics.tls.withKeyFile

withKeyFile(keyFile)

"Client key filename."

obj spec.policy

"Policy specifies default policy applied if not overridden by the user"

fn spec.policy.withApplyToIngress

withApplyToIngress(applyToIngress)

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

obj spec.policy.requestHeaders

"RequestHeadersPolicy defines the request headers set/removed on all routes"

fn spec.policy.requestHeaders.withRemove

withRemove(remove)

fn spec.policy.requestHeaders.withRemoveMixin

withRemoveMixin(remove)

Note: This function appends passed data to existing values

fn spec.policy.requestHeaders.withSet

withSet(set)

fn spec.policy.requestHeaders.withSetMixin

withSetMixin(set)

Note: This function appends passed data to existing values

obj spec.policy.responseHeaders

"ResponseHeadersPolicy defines the response headers set/removed on all routes"

fn spec.policy.responseHeaders.withRemove

withRemove(remove)

fn spec.policy.responseHeaders.withRemoveMixin

withRemoveMixin(remove)

Note: This function appends passed data to existing values

fn spec.policy.responseHeaders.withSet

withSet(set)

fn spec.policy.responseHeaders.withSetMixin

withSetMixin(set)

Note: This function appends passed data to existing values

obj spec.rateLimitService

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

fn spec.rateLimitService.withDomain

withDomain(domain)

"Domain is passed to the Rate Limit Service."

fn spec.rateLimitService.withEnableResourceExhaustedCode

withEnableResourceExhaustedCode(enableResourceExhaustedCode)

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

fn spec.rateLimitService.withEnableXRateLimitHeaders

withEnableXRateLimitHeaders(enableXRateLimitHeaders)

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

fn spec.rateLimitService.withFailOpen

withFailOpen(failOpen)

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

obj spec.rateLimitService.defaultGlobalRateLimitPolicy

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

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.withDescriptors

withDescriptors(descriptors)

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

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.withDescriptorsMixin

withDescriptorsMixin(descriptors)

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

Note: This function appends passed data to existing values

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.withDisabled

withDisabled(disabled)

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

obj spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors

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

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.withEntries

withEntries(entries)

"Entries is the list of key-value pair generators."

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.withEntriesMixin

withEntriesMixin(entries)

"Entries is the list of key-value pair generators."

Note: This function appends passed data to existing values

obj spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries

"Entries is the list of key-value pair generators."

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.withRemoteAddress

withRemoteAddress(remoteAddress)

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

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.withRemoteAddressMixin

withRemoteAddressMixin(remoteAddress)

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

Note: This function appends passed data to existing values

obj spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.genericKey

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

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.genericKey.withKey

withKey(key)

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

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.genericKey.withValue

withValue(value)

"Value defines the value of the descriptor entry."

obj spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeader

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

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeader.withDescriptorKey

withDescriptorKey(descriptorKey)

"DescriptorKey defines the key to use on the descriptor entry."

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeader.withHeaderName

withHeaderName(headerName)

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

obj spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeaderValueMatch

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

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeaderValueMatch.withExpectMatch

withExpectMatch(expectMatch)

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

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeaderValueMatch.withHeaders

withHeaders(headers)

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

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeaderValueMatch.withHeadersMixin

withHeadersMixin(headers)

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

Note: This function appends passed data to existing values

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeaderValueMatch.withValue

withValue(value)

"Value defines the value of the descriptor entry."

obj spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeaderValueMatch.headers

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

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeaderValueMatch.headers.withContains

withContains(contains)

"Contains specifies a substring that must be present in\nthe header value."

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeaderValueMatch.headers.withExact

withExact(exact)

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

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeaderValueMatch.headers.withIgnoreCase

withIgnoreCase(ignoreCase)

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

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeaderValueMatch.headers.withName

withName(name)

"Name is the name of the header to match against. Name is required.\nHeader names are case insensitive."

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeaderValueMatch.headers.withNotcontains

withNotcontains(notcontains)

"NotContains specifies a substring that must not be present\nin the header value."

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeaderValueMatch.headers.withNotexact

withNotexact(notexact)

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

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeaderValueMatch.headers.withNotpresent

withNotpresent(notpresent)

"NotPresent specifies that condition is true when the named header\nis not present. Note that setting NotPresent to false does not\nmake the condition true if the named header is present."

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeaderValueMatch.headers.withPresent

withPresent(present)

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

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeaderValueMatch.headers.withRegex

withRegex(regex)

"Regex specifies a regular expression pattern that must match the header\nvalue."

fn spec.rateLimitService.defaultGlobalRateLimitPolicy.descriptors.entries.requestHeaderValueMatch.headers.withTreatMissingAsEmpty

withTreatMissingAsEmpty(treatMissingAsEmpty)

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

obj spec.rateLimitService.extensionService

"ExtensionService identifies the extension service defining the RLS."

fn spec.rateLimitService.extensionService.withName

withName(name)

fn spec.rateLimitService.extensionService.withNamespace

withNamespace(namespace)

obj spec.tracing

"Tracing defines properties for exporting trace data to OpenTelemetry."

fn spec.tracing.withCustomTags

withCustomTags(customTags)

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

fn spec.tracing.withCustomTagsMixin

withCustomTagsMixin(customTags)

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

Note: This function appends passed data to existing values

fn spec.tracing.withIncludePodDetail

withIncludePodDetail(includePodDetail)

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

fn spec.tracing.withMaxPathTagLength

withMaxPathTagLength(maxPathTagLength)

"MaxPathTagLength defines maximum length of the request path\nto extract and include in the HttpUrl tag.\ncontour's default is 256."

fn spec.tracing.withOverallSampling

withOverallSampling(overallSampling)

"OverallSampling defines the sampling rate of trace data.\ncontour's default is 100."

fn spec.tracing.withServiceName

withServiceName(serviceName)

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

obj spec.tracing.customTags

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

fn spec.tracing.customTags.withLiteral

withLiteral(literal)

"Literal is a static custom tag value.\nPrecisely one of Literal, RequestHeaderName must be set."

fn spec.tracing.customTags.withRequestHeaderName

withRequestHeaderName(requestHeaderName)

"RequestHeaderName indicates which request header\nthe label value is obtained from.\nPrecisely one of Literal, RequestHeaderName must be set."

fn spec.tracing.customTags.withTagName

withTagName(tagName)

"TagName is the unique name of the custom tag."

obj spec.tracing.extensionService

"ExtensionService identifies the extension service defining the otel-collector."

fn spec.tracing.extensionService.withName

withName(name)

fn spec.tracing.extensionService.withNamespace

withNamespace(namespace)

obj spec.xdsServer

"XDSServer contains parameters for the xDS server."

fn spec.xdsServer.withAddress

withAddress(address)

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

fn spec.xdsServer.withPort

withPort(port)

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

fn spec.xdsServer.withType

withType(type)

"Defines the XDSServer to use for contour serve.\nValues: contour (default), envoy.\nOther values will produce an error."

obj spec.xdsServer.tls

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

fn spec.xdsServer.tls.withCaFile

withCaFile(caFile)

"CA filename."

fn spec.xdsServer.tls.withCertFile

withCertFile(certFile)

"Client certificate filename."

fn spec.xdsServer.tls.withInsecure

withInsecure(insecure)

"Allow serving the xDS gRPC API without TLS."

fn spec.xdsServer.tls.withKeyFile

withKeyFile(keyFile)

"Client key filename."