github.com/projectcontour/contour@v1.28.2/site/content/docs/v1.8.0/configuration.md (about) 1 # Contour Configuration Reference 2 3 - [Configuration File](#configuration-file) 4 - [Environment Variables](#environment-variables) 5 6 ## Configuration File 7 8 A configuration file can be passed to the `--config-path` argument of the `contour serve` command to specify additional configuration to Contour. 9 In most deployments, this file is passed to Contour via a ConfigMap which is mounted as a volume to the Contour pod. 10 11 The Contour configuration file is optional. 12 In its absence, Contour will operate with reasonable defaults. 13 Where Contour settings can also be specified with command-line flags, the command-line value takes precedence over the configuration file. 14 15 | Field Name | Type | Default | Description | 16 |------------|------|---------|-------------| 17 | accesslog-format | string | `envoy` | This key sets the global [access log format][2] for Envoy. Valid options are `envoy` or `json`. | 18 | debug | boolean | `false` | Enables debug logging. | 19 | default-http-versions | string array | <code style="white-space:nowrap">HTTP/1.1</code> <br> <code style="white-space:nowrap">HTTP/2</code> | This array specifies the HTTP versions that Contour should program Envoy to serve. HTTP versions are specified as strings of the form "HTTP/x", where "x" represents the version number. | 20 | disablePermitInsecure | boolean | `false` | If this field is true, Contour will ignore `PermitInsecure` field in HTTPProxy documents. | 21 | envoy-service-name | string | `envoy` | This sets the service name that will be inspected for address details to be applied to Ingress objects. | 22 | envoy-service-namespace | string | `projectcontour` | This sets the namespace of the service that will be inspected for address details to be applied to Ingress objects. If the `CONTOUR_NAMESPACE` environment variable is present, Contour will populate this field with its value. | 23 | 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 `envoy-service-name` and `envoy-service-namespace`.| 24 | incluster | boolean | `false` | This field specifies that Contour is running in a Kubernetes cluster and should use the in-cluster client access configuration. | 25 | json-fields | string array | [fields][5]| This is the list the field names to include in the JSON [access log format][2]. | 26 | kubeconfig | string | `$HOME/.kube/config` | Path to a Kubernetes [kubeconfig file][3] for when Contour is executed outside a cluster. | 27 | leaderelection | leaderelection | | The [leader election configuration](#leader-election-configuration). | 28 | request-timeout | [duration][4] | `0s` | **Deprecated and will be removed in a future release. Use [timeouts.request-timeout](#timeout-configuration) instead.**<br /><br /> This field specifies the default request timeout as a Go duration string. Zero means there is no timeout. | 29 | tls | TLS | | The default [TLS configuration](#tls-configuration). | 30 | timeouts | TimeoutConfig | | The [timeout configuration](#timeout-configuration). | 31 32 33 ### TLS Configuration 34 35 The TLS configuration block can be used to configure default values for how 36 Contour should provision TLS hosts. 37 38 | Field Name | Type| Default | Description | 39 |------------|-----|----------|-------------| 40 | minimum-protocol-version| string | `""` | This field specifies the minimum TLS protocol version that is allowed. Valid options are `1.2` and `1.3`. Any other value defaults to TLS 1.1. | 41 | fallback-certificate | | | [Fallback certificate configuration](#fallback-certificate). | 42 43 44 ### Fallback Certificate 45 46 | Field Name | Type| Default | Description | 47 |------------|-----|----------|-------------| 48 | name | string | `""` | This field specifies the name of the Kubernetes secret to use as the fallback certificate. | 49 | namespace | string | `""` | This field specifies the namespace of the Kubernetes secret to use as the fallback certificate. | 50 51 52 ### Leader Election Configuration 53 54 The leader election configuration block configures how a deployment with more than one Contour pod elects a leader. 55 The Contour leader is responsible for updating the status field on Ingress and HTTPProxy documents. 56 In the vast majority of deployments, only the `configmap-name` and `configmap-namespace` fields should require any configuration. 57 58 | Field Name | Type | Default | Description | 59 |------------|------|---------|-------------| 60 | configmap-name | string | `leader-elect` | The name of the ConfigMap that Contour leader election will lease. | 61 | configmap-namespace | string | `projectcontour` | The namespace of the ConfigMap that Contour leader election will lease. If the `CONTOUR_NAMESPACE` environment variable is present, Contour will populate this field with its value. | 62 | lease-duration | [duration][4] | `15s` | The duration of the leadership lease. | 63 | renew-deadline | [duration][4] | `10s` | The length of time that the leader will retry refreshing leadership before giving up. | 64 | retry-period | [duration][4] | `2s` | The interval at which Contour will attempt to the acquire leadership lease. | 65 66 67 ### Timeout Configuration 68 69 The timeout configuration block can be used to configure various timeouts for the proxies. All fields are optional; Contour/Envoy defaults apply if a field is not specified. 70 71 | Field Name | Type| Default | Description | 72 |------------|-----|----------|-------------| 73 | request-timeout | string | none* | This field specifies the default request timeout. Note that this is a timeout for the entire request, not an idle timeout. Must be a [valid Go duration string][4], or omitted or set to `infinity` to disable the timeout entirely. See [the Envoy documentation][12] for more information.<br /><br />_Note: A value of `0s` previously disabled this timeout entirely. This is no longer the case. Use `infinity` or omit this field to disable the timeout._ | 74 | connection-idle-timeout| string | `60s` | This field 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. Must be a [valid Go duration string][4], or `infinity` to disable the timeout entirely. See [the Envoy documentation][8] for more information. | 75 | stream-idle-timeout| string | `5m`* |This field 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. Must be a [valid Go duration string][4], or `infinity` to disable the timeout entirely. See [the Envoy documentation][9] for more information. | 76 | max-connection-duration | string | none* | This field 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. Must be a [valid Go duration string][4], or omitted or set to `infinity` for no max duration. See [the Envoy documentation][10] for more information. | 77 | connection-shutdown-grace-period | string | `5s`* | This field 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. Must be a [valid Go duration string][4]. See [the Envoy documentation][11] for more information. | 78 79 80 _* This is Envoy's default setting value and is not explicitly configured by Contour._ 81 82 ### Configuration Example 83 84 The following is an example ConfigMap with configuration file included: 85 86 ```yaml 87 apiVersion: v1 88 kind: ConfigMap 89 metadata: 90 name: contour 91 namespace: projectcontour 92 data: 93 contour.yaml: | 94 # should contour expect to be running inside a k8s cluster 95 # incluster: true 96 # 97 # path to kubeconfig (if not running inside a k8s cluster) 98 # kubeconfig: /path/to/.kube/config 99 # 100 # disable httpproxy permitInsecure field 101 # disablePermitInsecure: false 102 tls: 103 # minimum TLS version that Contour will negotiate 104 # minimumProtocolVersion: "1.1" 105 fallback-certificate: 106 # name: fallback-secret-name 107 # namespace: projectcontour 108 # The following config shows the defaults for the leader election. 109 # leaderelection: 110 # configmap-name: leader-elect 111 # configmap-namespace: projectcontour 112 # Default HTTP versions. 113 # default-http-versions: 114 # - "HTTP/1.1" 115 # - "HTTP/2" 116 # The following shows the default proxy timeout settings. 117 # timeouts: 118 # request-timeout: infinity 119 # connection-idle-timeout: 60s 120 # stream-idle-timeout: 5m 121 # max-connection-duration: infinity 122 # connection-shutdown-grace-period: 5s 123 ``` 124 125 _Note:_ The default example `contour` includes this [file][1] for easy deployment of Contour. 126 127 ## Environment Variables 128 129 ### CONTOUR_NAMESPACE 130 131 If present, the value of the `CONTOUR_NAMESPACE` environment variable is used as: 132 133 1. The value for the `contour bootstrap --namespace` flag unless otherwise specified. 134 1. The value for the `contour certgen --namespace` flag unless otherwise specified. 135 1. The value for the `contour serve --envoy-service-namespace` flag unless otherwise specified. 136 1. The value for the `leaderelection.configmap-namespace` config file setting for `contour serve` unless otherwise specified. 137 138 The `CONTOUR_NAMESPACE` environment variable is set via the [Downward API][6] in the Contour [example manifests][7]. 139 140 141 [1]: {{< param github_url >}}/tree/{{page.version}}/examples/contour/01-contour-config.yaml 142 [2]: /guides/structured-logs 143 [3]: https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/ 144 [4]: https://golang.org/pkg/time/#ParseDuration 145 [5]: https://godoc.org/github.com/projectcontour/contour/internal/envoy#DefaultFields 146 [6]: https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/ 147 [7]: {{< param github_url >}}/tree/{{page.version}}/examples/contour 148 [8]: https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/protocol.proto#envoy-api-field-core-httpprotocoloptions-idle-timeout 149 [9]: https://www.envoyproxy.io/docs/envoy/latest/api-v2/config/filter/network/http_connection_manager/v2/http_connection_manager.proto#envoy-api-field-config-filter-network-http-connection-manager-v2-httpconnectionmanager-stream-idle-timeout 150 [10]: https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/protocol.proto#envoy-api-field-core-httpprotocoloptions-max-connection-duration 151 [11]: https://www.envoyproxy.io/docs/envoy/latest/api-v2/config/filter/network/http_connection_manager/v2/http_connection_manager.proto#envoy-api-field-config-filter-network-http-connection-manager-v2-httpconnectionmanager-drain-timeout 152 [12]: https://www.envoyproxy.io/docs/envoy/latest/api-v2/config/filter/network/http_connection_manager/v2/http_connection_manager.proto#envoy-api-field-config-filter-network-http-connection-manager-v2-httpconnectionmanager-request-timeout