docs: Document supported `consul connect` env vars

Document the ability to specify `-sidecar-for` and `-proxy-id` flags
via environment variables.
This commit is contained in:
Blake Covarrubias 2021-07-21 11:51:22 -07:00
parent c89287dc77
commit 337dd93604
2 changed files with 8 additions and 4 deletions

View File

@ -54,7 +54,8 @@ proxy configuration needed.
- `-proxy-id` - The [proxy service](/docs/connect/registration/service-registration) ID.
This service ID must already be registered with the local agent unless a gateway is being
registered with the `-register` flag.
registered with the `-register` flag. As of Consul 1.8.0, this can also be
specified via the CONNECT_PROXY_ID environment variable.
- `-envoy-binary` - The full path to a specific Envoy binary to exec. By
default the current `$PATH` is searched for `envoy`.
@ -104,7 +105,8 @@ proxy configuration needed.
#### Envoy Sidecar Proxy Options
- `-sidecar-for` - The _ID_ (not name if they differ) of the service instance
this proxy will represent. The target service doesn't need to exist on the
this proxy will represent. As of Consul 1.8.0, this can also be specified via
the CONNECT_SIDECAR_FOR environment variable. The target service doesn't need to exist on the
local agent yet but a [sidecar proxy
registration](/docs/connect/registration/service-registration) with
`proxy.destination_service_id` equal to the passed value must be present. If

View File

@ -28,7 +28,8 @@ Usage: `consul connect proxy [options]`
#### Proxy Options
- `-sidecar-for` - The _ID_ (not name if they differ) of the service instance
this proxy will represent. The target service doesn't need to exist on the
this proxy will represent. This can also be specified via the CONNECT_SIDECAR_FOR
environment variable. The target service doesn't need to exist on the
local agent yet but a [sidecar proxy
registration](/docs/connect/registration/service-registration) with
`proxy.destination_service_id` equal to the passed value must be present. If
@ -37,7 +38,8 @@ Usage: `consul connect proxy [options]`
- `-proxy-id` - The [proxy
service](/docs/connect/registration/service-registration) ID on the
local agent. This must already be present on the local agent.
local agent. This must already be present on the local agent. This can also be
specified via the CONNECT_PROXY_ID environment variable.
- `-log-level` - Specifies the log level.