Network addresses

    path

    (string, REQUIRED) Unix Domain Socket path. On Linux, paths starting with ‘@’ will use the abstract namespace. The starting ‘@’ is replaced by a null byte by Envoy. Paths starting with ‘@’ will result in an error in environments other than Linux.

    core.SocketAddress

    [core.SocketAddress proto]

    1.   "protocol": "...",
    2.   "address": "...",
    3.   "port_value": "...",
    4.   "named_port": "...",
    5.   "resolver_name": "...",
    6.   "ipv4_compat": "..."

    protocol

    ()

    address

    (string, REQUIRED) The address for this socket. will bind to the address. An empty address is not allowed. Specify 0.0.0.0 or :: to bind to any address. When used within an upstream BindConfig, the address controls the source address of outbound connections. For , the cluster type determines whether the address must be an IP (STATIC or EDS clusters) or a hostname resolved by DNS (STRICT_DNS or LOGICAL_DNS clusters). Address resolution can be customized via resolver_name.

    port_value

    ()

    Precisely one of port_value, must be set.

    named_port

    (string) This is only valid if is specified below and the named resolver is capable of named port resolution.

    Precisely one of port_value, must be set.

    resolver_name

    (string) The name of the custom resolver. This must have been registered with Envoy. If this is empty, a context dependent default applies. If the address is a concrete IP address, no resolution will occur. If address is a hostname this should be set for resolution other than DNS. Specifying a custom resolver with STRICT_DNS or LOGICAL_DNS will generate an error at runtime.

    ipv4_compat

    TCP

    (DEFAULT) ⁣

    UDP

    ⁣

    core.TcpKeepalive

    keepalive_probes

    (UInt32Value) Maximum number of keepalive probes to send without response before deciding the connection is dead. Default is to use the OS level configuration (unless overridden, Linux defaults to 9.)

    keepalive_time

    () The number of seconds a connection needs to be idle before keep-alive probes start being sent. Default is to use the OS level configuration (unless overridden, Linux defaults to 7200s (ie 2 hours.)

    keepalive_interval

    (UInt32Value) The number of seconds between keep-alive probes. Default is to use the OS level configuration (unless overridden, Linux defaults to 75s.)

    1.   "source_address": "{...}",
    3.   "socket_options": []
    4. }

    source_address

    (core.SocketAddress, REQUIRED) The address to bind to when creating a socket.

    freebind

    socket_options

    () Additional socket options that may not be present in Envoy source code or precompiled binaries.

    core.Address

    Addresses specify either a logical or physical address and port, which are used to tell Envoy where to bind/listen, connect to upstream and find management servers.

    socket_address

    (core.SocketAddress)

    Precisely one of , pipe must be set.

    pipe

    ()

    Precisely one of socket_address, must be set.

    [core.CidrRange proto]

    CidrRange specifies an IP Address and a prefix length to construct the subnet mask for a range.

    1. {
    2.   "address_prefix": "...",
    3.   "prefix_len": "{...}"

    address_prefix

    (string, REQUIRED) IPv4 or IPv6 address, e.g. or 2001:db8::.

    prefix_len

    () Length of prefix, e.g. 0, 32.