github.com/projectcontour/contour@v1.28.2/site/content/docs/v1.17.2/configuration.md (about)

     1  # Contour Configuration Reference
     2  
     3  - [Serve Flags](#serve-flags)
     4  - [Configuration File](#configuration-file)
     5  - [Environment Variables](#environment-variables)
     6  - [Bootstrap Config File](#bootstrap-config-file)
     7  
     8  ## Overview
     9  
    10  There are various ways to configure Contour, flags, the configuration file, as well as environment variables.
    11  Contour has a precedence of configuration for contour serve, meaning anything configured in the config file is overridden by environment vars which are overridden by cli flags.
    12  
    13  ## Serve Flags
    14  
    15  The `contour serve` command is the main command which is used to watch for Kubernetes resource and process them into Envoy configuration which is then streamed to any Envoy via its xDS gRPC connection.
    16  There are a number of flags that can be passed to this command which further configures how Contour operates. 
    17  Many of these flags are mirrored in the [Contour Configuration File](#configuration-file).
    18  
    19  | Flag Name         | Description        |
    20  |-------------------|--------------------|
    21  | `--config-path`       | Path to base configuration |
    22  | `--incluster`         | Use in cluster configuration |
    23  | `--kubeconfig=</path/to/file>` |    Path to kubeconfig (if not in running inside a cluster) |
    24  | `--xds-address=<ipaddr>` | xDS gRPC API address |
    25  | `--xds-port=<port>`       | xDS gRPC API port |
    26  | `--stats-address=<ipaddr>` | Envoy /stats interface address |
    27  | `--stats-port=<port>`  |  Envoy /stats interface port |
    28  | `--debug-http-address=<address>` | Address the debug http endpoint will bind to. |
    29  | `--debug-http-port=<port>`  | Port the debug http endpoint will bind to |
    30  | `--http-address=<ipaddr>`  | Address the metrics HTTP endpoint will bind to |
    31  | `--http-port=<port>`  |    Port the metrics HTTP endpoint will bind to. |
    32  | `--health-address=<ipaddr>` |   Address the health HTTP endpoint will bind to |
    33  | `--health-port=<port>` | Port the health HTTP endpoint will bind to |
    34  | `--contour-cafile=</path/to/file\|CONTOUR_CERT_FILE>` | CA bundle file name for serving gRPC with TLS |
    35  | `--contour-cert-file=</path/to/file\|CONTOUR_CERT_FILE>`  | Contour certificate file name for serving gRPC over TLS |
    36  | `--contour-key-file=</path/to/file\|CONTOUR_KEY_FILE>` | Contour key file name for serving gRPC over TLS |
    37  | `--insecure`  |               Allow serving without TLS secured gRPC |
    38  | `--root-namespaces=<ns,ns>` | Restrict contour to searching these namespaces for root ingress routes |
    39  | `--ingress-class-name=<name>` | Contour IngressClass name |
    40  | `--ingress-status-address=<address>`  | Address to set in Ingress object status |
    41  | `--envoy-http-access-log=</path/to/file>`  | Envoy HTTP access log |
    42  | `--envoy-https-access-log=</path/to/file>`  | Envoy HTTPS access log |
    43  | `--envoy-service-http-address=<ipaddr>`  | Kubernetes Service address for HTTP requests |
    44  | `--envoy-service-https-address=<ipaddr>` | Kubernetes Service address for HTTPS requests |
    45  | `--envoy-service-http-port=<port>` | Kubernetes Service port for HTTP requests |
    46  | `--envoy-service-https-port=<port>` |  Kubernetes Service port for HTTPS requests |
    47  | `--envoy-service-name=<name>` | Name of the Envoy service to inspect for Ingress status details. |
    48  | `--envoy-service-namespace=<namespace>` | Envoy Service Namespace  |
    49  | `--use-proxy-protocol`  |     Use PROXY protocol for all listeners |
    50  | `--accesslog-format=<envoy\|json>` | Format for Envoy access logs |
    51  | `--disable-leader-election` | Disable leader election mechanism |
    52  | `-d, --debug`   |                  Enable debug logging |
    53  | `--kubernetes-debug=<log level>`  | Enable Kubernetes client debug logging |
    54  
    55  ## Configuration File
    56  
    57  A configuration file can be passed to the `--config-path` argument of the `contour serve` command to specify additional configuration to Contour.
    58  In most deployments, this file is passed to Contour via a ConfigMap which is mounted as a volume to the Contour pod.
    59  
    60  The Contour configuration file is optional.
    61  In its absence, Contour will operate with reasonable defaults.
    62  Where Contour settings can also be specified with command-line flags, the command-line value takes precedence over the configuration file.
    63  
    64  | Field Name | Type | Default | Description |
    65  |------------|------|---------|-------------|
    66  | accesslog-format | string | `envoy` | This key sets the global [access log format][2] for Envoy. Valid options are `envoy` or `json`. |
    67  | debug | boolean | `false` | Enables debug logging. |
    68  | 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. |
    69  | disableAllowChunkedLength | boolean | `false` | If this field is true, Contour will disable 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. |
    70  | disablePermitInsecure | boolean | `false` | If this field is true, Contour will ignore `PermitInsecure` field in HTTPProxy documents. |
    71  | envoy-service-name | string | `envoy` | This sets the service name that will be inspected for address details to be applied to Ingress objects. |
    72  | 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. |
    73  | 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`.|
    74  | incluster | boolean | `false` | This field specifies that Contour is running in a Kubernetes cluster and should use the in-cluster client access configuration.  |
    75  | json-fields | string array | [fields][5]| This is the list the field names to include in the JSON [access log format][2]. |
    76  | kubeconfig | string | `$HOME/.kube/config` | Path to a Kubernetes [kubeconfig file][3] for when Contour is executed outside a cluster. |
    77  | leaderelection | leaderelection | | The [leader election configuration](#leader-election-configuration). |
    78  | policy | PolicyConfig | | The default [policy configuration](#policy-configuration). |
    79  | tls | TLS | | The default [TLS configuration](#tls-configuration). |
    80  | timeouts | TimeoutConfig | | The [timeout configuration](#timeout-configuration). |
    81  | cluster | ClusterConfig | | The [cluster configuration](#cluster-configuration). |
    82  | network | NetworkConfig | | The [network configuration](#network-configuration). |
    83  | listener | ListenerConfig | | The [listener configuration](#listener-configuration). |
    84  | server | ServerConfig |  | The [server configuration](#server-configuration) for `contour serve` command. |
    85  | gateway | GatewayConfig |  | The [gateway-api Gateway configuration](#gateway-configuration). |
    86  | rateLimitService | RateLimitServiceConfig | | The [rate limit service configuration](#rate-limit-service-configuration). |
    87  | enableExternalNameService | boolean | `false` | Enable ExternalName Service processing. Enabling this has security implications. Please see the [advisory](https://github.com/projectcontour/contour/security/advisories/GHSA-5ph6-qq5x-7jwc) for more details. |
    88  
    89  ### TLS Configuration
    90  
    91  The TLS configuration block can be used to configure default values for how
    92  Contour should provision TLS hosts.
    93  
    94  | Field Name | Type| Default  | Description |
    95  |------------|-----|----------|-------------|
    96  | minimum-protocol-version| string | `1.2` | This field specifies the minimum TLS protocol version that is allowed. Valid options are `1.2` (default) and `1.3`. Any other value defaults to TLS 1.2. |
    97  | fallback-certificate | | | [Fallback certificate configuration](#fallback-certificate). |
    98  | envoy-client-certificate | | | [Client certificate configuration for Envoy](#envoy-client-certificate). |
    99  | cipher-suites | []string | See [config package documentation](https://pkg.go.dev/github.com/projectcontour/contour/pkg/config#pkg-variables) | This field specifies the TLS ciphers to be supported by TLS listeners when negotiating TLS 1.2. This parameter should only be used by advanced users. Note that this is ignored when TLS 1.3 is in use. The set of ciphers that are allowed is a superset of those supported by default in stock, non-FIPS Envoy builds and FIPS builds as specified [here](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/transport_sockets/tls/v3/common.proto#envoy-v3-api-field-extensions-transport-sockets-tls-v3-tlsparameters-cipher-suites). Custom ciphers not accepted by Envoy in a standard build are not supported. |
   100  
   101  ### Fallback Certificate
   102  
   103  | Field Name | Type| Default  | Description |
   104  |------------|-----|----------|-------------|
   105  | name       | string | `""` | This field specifies the name of the Kubernetes secret to use as the fallback certificate.      |
   106  | namespace  | string | `""` | This field specifies the namespace of the Kubernetes secret to use as the fallback certificate. |
   107  
   108  
   109  ### Envoy Client Certificate
   110  
   111  | Field Name | Type| Default  | Description |
   112  |------------|-----|----------|-------------|
   113  | name       | string | `""` | This field specifies the name of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. |
   114  | namespace  | string | `""` | This field specifies the namespace of the Kubernetes secret to use as the client certificate and private key when establishing TLS connections to the backend service. |
   115  
   116  ### Leader Election Configuration
   117  
   118  The leader election configuration block configures how a deployment with more than one Contour pod elects a leader.
   119  The Contour leader is responsible for updating the status field on Ingress and HTTPProxy documents.
   120  In the vast majority of deployments, only the `configmap-name` and `configmap-namespace` fields should require any configuration.
   121  
   122  | Field Name | Type | Default | Description |
   123  |------------|------|---------|-------------|
   124  | configmap-name | string | `leader-elect` | The name of the ConfigMap that Contour leader election will lease. |
   125  | 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. |
   126  | lease-duration | [duration][4] | `15s` | The duration of the leadership lease. |
   127  | renew-deadline | [duration][4] | `10s` | The length of time that the leader will retry refreshing leadership before giving up. |
   128  | retry-period | [duration][4] | `2s` | The interval at which Contour will attempt to the acquire leadership lease. |
   129  
   130  ### Timeout Configuration
   131  
   132  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.
   133  
   134  | Field Name | Type| Default  | Description |
   135  |------------|-----|----------|-------------|
   136  | 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._  |
   137  | 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. |
   138  | 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. |
   139  | 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. |
   140  | delayed-close-timeout | string | `1s`* | *Note: this is an advanced setting that should not normally need to be tuned.* <br /><br /> This field 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.  See [the Envoy documentation][13] for more information. |
   141  | 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. |
   142  
   143  _This is Envoy's default setting value and is not explicitly configured by Contour._
   144  
   145  ### Cluster Configuration
   146  
   147  The cluster configuration block can be used to configure various parameters for Envoy clusters.
   148  
   149  | Field Name | Type| Default  | Description |
   150  |------------|-----|----------|-------------|
   151  | dns-lookup-family | string | auto | This field specifies the dns-lookup-family to use for upstream requests to externalName type Kubernetes services from an HTTPProxy route. Values are: `auto`, `v4, `v6` |
   152  
   153  ### Network Configuration
   154  
   155  The network configuration block can be used to configure various parameters network connections.
   156  
   157  | Field Name | Type| Default  | Description |
   158  |------------|-----|----------|-------------|
   159  | num-trusted-hops | int | 0 | Configures the number of additional ingress proxy hops from the right side of the x-forwarded-for HTTP header to trust. |
   160  | admin-port | int | 9001 | Configures the Envoy Admin read-only listener on Envoy. Set to `0` to disable. |
   161  
   162  ### Listener Configuration
   163  
   164  The listener configuration block can be used to configure various parameters for Envoy listener.
   165  
   166  | Field Name | Type| Default  | Description |
   167  |------------|-----|----------|-------------|
   168  | connection-balancer | string | `""` | This field specifies the listener connection balancer. If the value is `exact`, the listener will use the exact connection balancer to balance connections between threads in a single Envoy process. See [the Envoy documentation][14] for more information. |
   169  
   170  ### Server Configuration
   171  
   172  The server configuration block can be used to configure various settings for the `contour serve` command.
   173  
   174  | Field Name | Type| Default  | Description |
   175  |------------|-----|----------|-------------|
   176  | xds-server-type | string | contour | This field specifies the xDS Server to use. Options are `contour` or `envoy`.  |
   177  
   178  ### Gateway Configuration
   179  
   180  The gateway configuration block is used to configure which gateway-api Gateway Contour should configure:
   181  
   182  | Field Name | Type| Default  | Description |
   183  |------------|-----|----------|-------------|
   184  | controllerName | string |  | Gateway Class controller name (i.e. projectcontour.io/projectcontour/contour).  |
   185  | name (Deprecated) | string | contour | DEPRECATED: This field specifies the name of a Gateway.  |
   186  | namespace (Deprecated) | string | projectcontour | DEPRECATED: This field specifies the namespace of a Gateway.  |
   187  
   188  ### Policy Configuration
   189  
   190  The Policy configuration block can be used to configure default policy values
   191  that are set if not overridden by the user.
   192  
   193  The `request-headers` field is used to rewrite headers on a HTTP request, and
   194  the `response-headers` field is used to rewrite headers on a HTTP response.
   195  
   196  | Field Name | Type| Default  | Description |
   197  |------------|-----|----------|-------------|
   198  | request-headers | HeaderPolicy | none | The default request headers set or removed on all service routes if not overridden in the object |
   199  | response-headers | HeaderPolicy | none | The default response headers set or removed on all service routes if not overridden in the object |
   200  
   201  #### HeaderPolicy
   202  
   203  The `set` field sets an HTTP header value, creating it if it doesn't already exist but not overwriting it if it does.
   204  The `remove` field removes an HTTP header.
   205  
   206  | Field Name | Type| Default  | Description |
   207  |------------|-----|----------|-------------|
   208  | set | map[string]string | none | Map of headers to set on all service routes if not overridden in the object |
   209  | remove | []string | none | List of headers to remove on all service routes if not overridden in the object |
   210  
   211  Note: the values of entries in the `set` and `remove` fields can be overridden in HTTPProxy objects but it it not possible to remove these entries.
   212  
   213  ### Rate Limit Service Configuration
   214  
   215  The rate limit service configuration block is used to configure an optional global rate limit service:
   216  
   217  | Field Name | Type| Default  | Description |
   218  |------------|-----|----------|-------------|
   219  | extensionService | string | <none> | This field identifies the extension service defining the rate limit service, formatted as <namespace>/<name>.  |
   220  | domain | string | contour | This field defines the rate limit domain value to pass to the rate limit service. Acts as a container for a set of rate limit definitions within the RLS.  |
   221  | failOpen | bool | false | This field 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.  |
   222  | enableXRateLimitHeaders | bool | false | This field 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 https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html), on responses to clients when the Rate Limit Service is consulted for a request. |
   223  
   224  ### Configuration Example
   225  
   226  The following is an example ConfigMap with configuration file included:
   227  
   228  ```yaml
   229  apiVersion: v1
   230  kind: ConfigMap
   231  metadata:
   232    name: contour
   233    namespace: projectcontour
   234  data:
   235    contour.yaml: |
   236      #
   237      # server:
   238      #   determine which XDS Server implementation to utilize in Contour.
   239      #   xds-server-type: contour
   240      #
   241      # specify the gateway-api Gateway Contour should configure
   242      # gateway:
   243      #   controllerName: projectcontour.io/projectcontour/contour
   244      #   name: contour
   245      #   namespace: projectcontour
   246      #
   247      # should contour expect to be running inside a k8s cluster
   248      # incluster: true
   249      #
   250      # path to kubeconfig (if not running inside a k8s cluster)
   251      # kubeconfig: /path/to/.kube/config
   252      #
   253      # Disable RFC-compliant behavior to strip "Content-Length" header if
   254      # "Tranfer-Encoding: chunked" is also set.
   255      # disableAllowChunkedLength: false
   256      # Disable HTTPProxy permitInsecure field
   257      disablePermitInsecure: false
   258      tls:
   259      # minimum TLS version that Contour will negotiate
   260      # minimum-protocol-version: "1.2"
   261      # TLS ciphers to be supported by Envoy TLS listeners when negotiating
   262      # TLS 1.2.
   263      # cipher-suites:
   264      # - '[ECDHE-ECDSA-AES128-GCM-SHA256|ECDHE-ECDSA-CHACHA20-POLY1305]'
   265      # - '[ECDHE-RSA-AES128-GCM-SHA256|ECDHE-RSA-CHACHA20-POLY1305]'
   266      # - 'ECDHE-ECDSA-AES256-GCM-SHA384'
   267      # - 'ECDHE-RSA-AES256-GCM-SHA384'
   268      # Defines the Kubernetes name/namespace matching a secret to use
   269      # as the fallback certificate when requests which don't match the
   270      # SNI defined for a vhost.
   271        fallback-certificate:
   272      #   name: fallback-secret-name
   273      #   namespace: projectcontour
   274        envoy-client-certificate:
   275      #   name: envoy-client-cert-secret-name
   276      #   namespace: projectcontour
   277      # The following config shows the defaults for the leader election.
   278      # leaderelection:
   279      #   configmap-name: leader-elect
   280      #   configmap-namespace: projectcontour
   281      ### Logging options
   282      # Default setting
   283      accesslog-format: envoy
   284      # To enable JSON logging in Envoy
   285      # accesslog-format: json
   286      # The default fields that will be logged are specified below.
   287      # To customise this list, just add or remove entries.
   288      # The canonical list is available at
   289      # https://godoc.org/github.com/projectcontour/contour/internal/envoy#JSONFields
   290      # json-fields:
   291      #   - "@timestamp"
   292      #   - "authority"
   293      #   - "bytes_received"
   294      #   - "bytes_sent"
   295      #   - "downstream_local_address"
   296      #   - "downstream_remote_address"
   297      #   - "duration"
   298      #   - "method"
   299      #   - "path"
   300      #   - "protocol"
   301      #   - "request_id"
   302      #   - "requested_server_name"
   303      #   - "response_code"
   304      #   - "response_flags"
   305      #   - "uber_trace_id"
   306      #   - "upstream_cluster"
   307      #   - "upstream_host"
   308      #   - "upstream_local_address"
   309      #   - "upstream_service_time"
   310      #   - "user_agent"
   311      #   - "x_forwarded_for"
   312      #
   313      # default-http-versions:
   314      # - "HTTP/2"
   315      # - "HTTP/1.1"
   316      #
   317      # The following shows the default proxy timeout settings.
   318      # timeouts:
   319      #   request-timeout: infinity
   320      #   connection-idle-timeout: 60s
   321      #   stream-idle-timeout: 5m
   322      #   max-connection-duration: infinity
   323      #   connection-shutdown-grace-period: 5s
   324      #
   325      # Envoy cluster settings.
   326      # cluster:
   327      #   configure the cluster dns lookup family
   328      #   valid options are: auto (default), v4, v6
   329      #   dns-lookup-family: auto   
   330      #
   331      # network:
   332      #   Configure the number of additional ingress proxy hops from the
   333      #   right side of the x-forwarded-for HTTP header to trust.
   334      #   num-trusted-hops: 0
   335      #   Configure the port used to access the Envoy Admin interface.
   336      #   admin-port: 9001
   337      #
   338      # Configure an optional global rate limit service.
   339      # rateLimitService:
   340      #   Identifies the extension service defining the rate limit service,
   341      #   formatted as <namespace>/<name>.
   342      #   extensionService: projectcontour/ratelimit
   343      #   Defines the rate limit domain to pass to the rate limit service.
   344      #   Acts as a container for a set of rate limit definitions within
   345      #   the RLS.
   346      #   domain: contour
   347      #   Defines whether to allow requests to proceed when the rate limit
   348      #   service fails to respond with a valid rate limit decision within
   349      #   the timeout defined on the extension service.
   350      #   failOpen: false
   351      # Defines whether to include the X-RateLimit headers X-RateLimit-Limit,
   352      # X-RateLimit-Remaining, and X-RateLimit-Reset (as defined by the IETF
   353      # Internet-Draft linked below), on responses to clients when the Rate
   354      # Limit Service is consulted for a request.
   355      # ref. https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html
   356      #   enableXRateLimitHeaders: false
   357      #
   358      # Global Policy settings.
   359      # policy:
   360      #   # Default headers to set on all requests (unless set/removed on the HTTPProxy object itself)
   361      #   request-headers:
   362      #     set:
   363      #       # example: the hostname of the Envoy instance that proxied the request
   364      #       X-Envoy-Hostname: %HOSTNAME%
   365      #       # example: add a l5d-dst-override header to instruct Linkerd what service the request is destined for
   366      #       l5d-dst-override: %CONTOUR_SERVICE_NAME%.%CONTOUR_NAMESPACE%.svc.cluster.local:%CONTOUR_SERVICE_PORT%
   367      #   # default headers to set on all responses (unless set/removed on the HTTPProxy object itself)
   368      #   response-headers:
   369      #     set:
   370      #       # example: Envoy flags that provide additional details about the response or connection
   371      #       X-Envoy-Response-Flags: %RESPONSE_FLAGS%
   372      #
   373  ```
   374  
   375  _Note:_ The default example `contour` includes this [file][1] for easy deployment of Contour.
   376  
   377  ## Environment Variables
   378  
   379  ### CONTOUR_NAMESPACE
   380  
   381  If present, the value of the `CONTOUR_NAMESPACE` environment variable is used as:
   382  
   383  1. The value for the `contour bootstrap --namespace` flag unless otherwise specified.
   384  1. The value for the `contour certgen --namespace` flag unless otherwise specified.
   385  1. The value for the `contour serve --envoy-service-namespace` flag unless otherwise specified.
   386  1. The value for the `leaderelection.configmap-namespace` config file setting for `contour serve` unless otherwise specified.
   387  
   388  The `CONTOUR_NAMESPACE` environment variable is set via the [Downward API][6] in the Contour [example manifests][7].
   389  
   390  ## Bootstrap Config File
   391  
   392  The bootstrap configuration file is generated by an initContainer in the Envoy daemonset which runs the `contour bootstrap` command to generate the file.
   393  This configuration file configures the Envoy container to connect to Contour and receive configuration via xDS.
   394  
   395  The next section outlines all the available flags that can be passed to the `contour bootstrap` command which are used to customize
   396  the configuration file to match the environment in which Envoy is deployed. 
   397  
   398  ### Flags
   399  
   400  There are flags that can be passed to `contour bootstrap` that help configure how Envoy
   401  connects to Contour:
   402  
   403  | Flag | Default  | Description |
   404  |------------|----------|-------------|
   405  | <nobr>--resources-dir</nobr> | "" | Directory where resource files will be written.  |
   406  | <nobr>--admin-address</nobr> | /admin/admin.sock | Path to Envoy admin unix domain socket.  |
   407  | <nobr>--admin-port (Deprecated)</nobr> | 9001 | Deprecated: Port is now configured as a Contour flag.  |
   408  | <nobr>--xds-address</nobr> | 127.0.0.1 | Address to connect to Contour xDS server on.  |
   409  | <nobr>--xds-port</nobr> | 8001 | Port to connect to Contour xDS server on. |
   410  | <nobr>--envoy-cafile</nobr> | "" | CA filename for Envoy secure xDS gRPC communication.  |
   411  | <nobr>--envoy-cert-file</nobr> | "" | Client certificate filename for Envoy secure xDS gRPC communication.  |
   412  | <nobr>--envoy-key-file</nobr> | "" | Client key filename for Envoy secure xDS gRPC communication.  |
   413  | <nobr>--namespace</nobr> | projectcontour | Namespace the Envoy container will run, also configured via ENV variable "CONTOUR_NAMESPACE". Namespace is used as part of the metric names on static resources defined in the bootstrap configuration file.    |
   414  | <nobr>--xds-resource-version</nobr> | v3 | Currently, the only valid xDS API resource version is `v3`.  |
   415  | <nobr>--dns-lookup-family</nobr> | auto | Defines what DNS Resolution Policy to use for Envoy -> Contour cluster name lookup. Either v4, v6 or auto.  |
   416  
   417  
   418  [1]: {{< param github_url>}}/tree/{{< param version >}}/examples/contour/01-contour-config.yaml
   419  [2]: /guides/structured-logs
   420  [3]: https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/
   421  [4]: https://golang.org/pkg/time/#ParseDuration
   422  [5]: https://godoc.org/github.com/projectcontour/contour/internal/envoy#DefaultFields
   423  [6]: https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/
   424  [7]: {{< param github_url>}}/tree/{{< param version >}}/examples/contour
   425  [8]: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-idle-timeout
   426  [9]: 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
   427  [10]: 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
   428  [11]: 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
   429  [12]: 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
   430  [13]: 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
   431  [14]: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/listener/v3/listener.proto#config-listener-v3-listener-connectionbalanceconfig