Documentation for version v1.5.0 is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the latest version.
A configuration file can be passed to the
--config-path argument of the
contour serve command to specify additional configuration to Contour.
In most deployments, this file is passed to Contour via a ConfigMap which is mounted as a volume to the Contour pod.
The Contour configuration file is optional. In its absence, Contour will operate with reasonable defaults. Where Contour settings can also be specified with command-line flags, the command-line value takes precedence over the configuration file.
||This key sets the global access log format for Envoy. Valid options are
||Enables debug logging.|
||If this field is true, Contour will ignore
||This sets the service name that will be inspected for address details to be applied to Ingress objects.|
||This sets the namespace of the service that will be inspected for address details to be applied to Ingress objects.|
|ingress-status-address||string||None||If present, this specifies the address that will be copied into the Ingress status for each Ingress that Contour manages. It is exclusive with
||This field specifies that Contour is running in a Kubernetes cluster and should use the in-cluster client access configuration.|
|json-fields||string array||fields||This is the list the field names to include in the JSON access log format.|
||Path to a Kubernetes kubeconfig file for when Contour is executed outside a cluster.|
|leaderelection||leaderelection||The leader election configuration.|
||This field specifies the default request timeout as a Go duration string. Zero means there is no timeout.|
|tls||TLS||The default TLS configuration.|
The TLS configuration block can be used to configure default values for how Contour should provision TLS hosts.
||This field specifies the minimum TLS protocol version that is allowed. Valid options are
|fallback-certificate||Fallback certificate configuration.|
||This field specifies the name of the Kubernetes secret to use as the fallback certificate.|
||This field specifies the namespace of the Kubernetes secret to use as the fallback certificate.|
The leader election configuration block configures how a deployment with more than one Contour pod elects a leader.
The Contour leader is responsible for updating the status field on Ingress and HTTPProxy documents.
In the vast majority of deployments, only the
configmap-namespace fields should require any configuration.
||The name of the ConfigMap that Contour leader election will lease.|
||The namespace of the ConfigMap that Contour leader election will lease. If the
||The duration of the leadership lease.|
||The length of time that the leader will retry refreshing leadership before giving up.|
||The interval at which Contour will attempt to the acquire leadership lease.|
The following is an example ConfigMap with configuration file included:
apiVersion: v1 kind: ConfigMap metadata: name: contour namespace: projectcontour data: contour.yaml: | # should contour expect to be running inside a k8s cluster # incluster: true # # path to kubeconfig (if not running inside a k8s cluster) # kubeconfig: /path/to/.kube/config # # disable ingressroute permitInsecure field # disablePermitInsecure: false tls: # minimum TLS version that Contour will negotiate # minimumProtocolVersion: "1.1" fallback-certificate: # name: fallback-secret-name # namespace: projectcontour # The following config shows the defaults for the leader election. # leaderelection: # configmap-name: leader-elect # configmap-namespace: projectcontour
Note: The default example
contour includes this file for easy deployment of Contour.