status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Fix formatting issues on built-in proxy page (#8005) 

Fix markdown formatting and display issues on built-in proxy page.
This commit is contained in:
Blake Covarrubias 2020-07-02 09:39:50 -07:00 committed by GitHub
parent 421b9e8ef1
commit 08c92ba880
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
website/pages/docs/connect/proxies/built-in.mdx
View File

@ -53,34 +53,29 @@ for the built-in proxy.
All fields are optional with a sane default. All fields are optional with a sane default.
- <a name="bind_address"></a> - `bind_address` - The address the proxy will bind it's
<a href="#bind_address">`bind_address`</a> - The address the proxy will bind it's
_public_ mTLS listener to. It defaults to the same address the agent binds to. _public_ mTLS listener to. It defaults to the same address the agent binds to.
- <a name="bind_port"></a> - `bind_port` - The port the proxy will bind it's _public_
<a href="#bind_port">`bind_port`</a> - The port the proxy will bind it's _public_
mTLS listener to. If not provided, the agent will attempt to assign one from its mTLS listener to. If not provided, the agent will attempt to assign one from its
[configured proxy port range](/docs/agent/options#proxy_min_port) if available. [configured proxy port range](/docs/agent/options#proxy_min_port) if available.
By default the range is [20000, 20255] and the port is selected at random from By default the range is [20000, 20255] and the port is selected at random from
that range. that range.
- <a name="tcp_check_address"></a> - `tcp_check_address` - The address the agent will
<a href="#tcp_check_address">`tcp_check_address`</a> - The address the agent will
run a [TCP health check](/docs/agent/checks) against. By default this is the same run a [TCP health check](/docs/agent/checks) against. By default this is the same
as the proxy's [bind address](#bind_address) except if the bind*address is `0.0.0.0` as the proxy's [bind address](#bind_address) except if the bind address is `0.0.0.0`
or `[::]` in which case this defaults to `127.0.0.1` and assumes the agent can or `[::]` in which case this defaults to `127.0.0.1` and assumes the agent can
dial the proxy over loopback. For more complex configurations where agent and proxy dial the proxy over loopback. For more complex configurations where agent and proxy
communicate over a bridge for example, this configuration can be used to specify communicate over a bridge for example, this configuration can be used to specify
a different \_address* (but not port) for the agent to use for health checks if a different *address* (but not port) for the agent to use for health checks if
it can't talk to the proxy over localhost or it's publicly advertised port. The it can't talk to the proxy over localhost or it's publicly advertised port. The
check always uses the same port that the proxy is bound to. check always uses the same port that the proxy is bound to.
- <a name="disable_tcp_check"></a> - `disable_tcp_check` - If true, this disables a
<a href="#disable_tcp_check">`disable_tcp_check`</a> - If true, this disables a
TCP check being setup for the proxy. Default is false. TCP check being setup for the proxy. Default is false.
- <a name="local_service_address"></a> - `local_service_address`- The `[address]:port`
<a href="#local_service_address">`local_service_address`</a> - The `[address]:port`
that the proxy should use to connect to the local application instance. By default that the proxy should use to connect to the local application instance. By default
it assumes `127.0.0.1` as the address and takes the port from the service definition's it assumes `127.0.0.1` as the address and takes the port from the service definition's
`port` field. Note that allowing the application to listen on any non-loopback `port` field. Note that allowing the application to listen on any non-loopback
@ -89,18 +84,15 @@ All fields are optional with a sane default.
known-private IP is available for example when using internal networking between known-private IP is available for example when using internal networking between
containers. containers.
- <a name="local_connect_timeout_ms"></a> - `local_connect_timeout_ms` - The number
<a href="#local_connect_timeout_ms">`local_connect_timeout_ms`</a> - The number
of milliseconds the proxy will wait to establish a connection to the _local application_ of milliseconds the proxy will wait to establish a connection to the _local application_
before giving up. Defaults to `1000` or 1 second. before giving up. Defaults to `1000` or 1 second.
- <a name="handshake_timeout_ms"></a> - `handshake_timeout_ms` - The number of milliseconds
<a href="#handshake_timeout_ms">`handshake_timeout_ms`</a> - The number of milliseconds
the proxy will wait for _incoming_ mTLS connections to complete the TLS handshake. the proxy will wait for _incoming_ mTLS connections to complete the TLS handshake.
Defaults to `10000` or 10 seconds. Defaults to `10000` or 10 seconds.
- <a name="upstreams"></a> - `upstreams`- **Deprecated** Upstreams are now specified
<a href="#upstreams">`upstreams`</a> - **Deprecated** Upstreams are now specified
in the `connect.proxy` definition. Upstreams specified in the opaque config map in the `connect.proxy` definition. Upstreams specified in the opaque config map
here will continue to work for compatibility but it's strongly recommended that here will continue to work for compatibility but it's strongly recommended that
you move to using the higher level [upstream configuration](/docs/connect/registration/service-registration#upstream-configuration-reference). you move to using the higher level [upstream configuration](/docs/connect/registration/service-registration#upstream-configuration-reference).
@ -109,7 +101,6 @@ All fields are optional with a sane default.
All fields are optional with a sane default. All fields are optional with a sane default.
- <a name="connect_timeout_ms"></a> - `connect_timeout_ms` - The number of milliseconds
<a href="#connect_timeout_ms">`connect_timeout_ms`</a> - The number of milliseconds
the proxy will wait to establish a TLS connection to the discovered upstream instance the proxy will wait to establish a TLS connection to the discovered upstream instance
before giving up. Defaults to `10000` or 10 seconds. before giving up. Defaults to `10000` or 10 seconds.