Built-In Proxy Options

    Consul comes with a built-in L4 proxy for testing and development with Consul Connect service mesh.

    Below is a complete example of all the configuration options available for the built-in proxy.

    2.   "service": {
    3.     ...
    4.     "connect": {
    5.       "proxy": {
    6.         "config": {
    7.           "bind_address": "0.0.0.0",
    8.           "bind_port": 20000,
    9.           "local_connect_timeout_ms": 1000,
    11.           "upstreams": [...]
    12.         },
    13.         "upstreams": [
    14.           {
    15.             ...
    16.             "config": {
    17.               "connect_timeout_ms": 1000
    18.             }
    20.       }
    21.     }
    22.   }
    23. }

    • bind_address - The address the proxy will bind its public mTLS listener to. It defaults to the same address the agent binds to.

    • - The port the proxy will bind its public mTLS listener to. If not provided, the agent will assign a random port from its configured proxy port range specified by sidecar_min_port and .

    • local_connect_timeout_ms - The number of milliseconds the proxy will wait to establish a connection to the local application before giving up. Defaults to 1000 or 1 second.

    • - The number of milliseconds the proxy will wait for incoming mTLS connections to complete the TLS handshake. Defaults to 10000 or 10 seconds.

    Proxy Upstream Config Key Reference

    All fields are optional with a reasonable default.

    • - The number of milliseconds the proxy will wait to establish a TLS connection to the discovered upstream instance before giving up. Defaults to 10000 or 10 seconds.