docs: Document supported `consul connect` env vars (#10667)

Document the ability to specify `-sidecar-for` and `-proxy-id` flags
via environment variables.
This commit is contained in:
Blake Covarrubias 2021-08-02 12:50:51 -07:00 committed by GitHub
parent e1c4088ba3
commit 17e18df81e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 2 deletions

View File

@ -54,7 +54,8 @@ proxy configuration needed.
- `-proxy-id` - The [proxy service](/docs/connect/registration/service-registration) ID. - `-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 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 - `-envoy-binary` - The full path to a specific Envoy binary to exec. By
default the current `$PATH` is searched for `envoy`. default the current `$PATH` is searched for `envoy`.
@ -110,6 +111,8 @@ proxy configuration needed.
`proxy.destination_service_id` equal to the passed value must be present. If `proxy.destination_service_id` equal to the passed value must be present. If
multiple proxy registrations targeting the same local service instance are multiple proxy registrations targeting the same local service instance are
present the command will error and `-proxy-id` should be used instead. present the command will error and `-proxy-id` should be used instead.
As of Consul 1.8.0, this can also be specified via the `CONNECT_SIDECAR_FOR`
environment variable.
-> **Note:** If ACLs are enabled, a token granting `service:write` for the -> **Note:** If ACLs are enabled, a token granting `service:write` for the
_target_ service (configured in `proxy.destination_service_name`) must be _target_ service (configured in `proxy.destination_service_name`) must be

View File

@ -34,10 +34,12 @@ Usage: `consul connect proxy [options]`
`proxy.destination_service_id` equal to the passed value must be present. If `proxy.destination_service_id` equal to the passed value must be present. If
multiple proxy registrations targeting the same local service instance are multiple proxy registrations targeting the same local service instance are
present the command will error and `-proxy-id` should be used instead. present the command will error and `-proxy-id` should be used instead.
This can also be specified via the `CONNECT_SIDECAR_FOR` environment variable.
- `-proxy-id` - The [proxy - `-proxy-id` - The [proxy
service](/docs/connect/registration/service-registration) ID on the 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 option
can also be specified via the `CONNECT_PROXY_ID` environment variable.
- `-log-level` - Specifies the log level. - `-log-level` - Specifies the log level.