cli: Document pass-through option for `consul connect envoy` (#10666)

Update help text of `consul connect envoy` command to mention the
ability to provide pass-through options.
This commit is contained in:
Blake Covarrubias 2021-07-21 10:43:10 -07:00 committed by GitHub
parent e515c9d449
commit 6c462d399b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions

View File

@ -662,7 +662,7 @@ func (c *cmd) Help() string {
const synopsis = "Runs or Configures Envoy as a Connect proxy" const synopsis = "Runs or Configures Envoy as a Connect proxy"
const help = ` const help = `
Usage: consul connect envoy [options] Usage: consul connect envoy [options] [-- pass-through options]
Generates the bootstrap configuration needed to start an Envoy proxy instance Generates the bootstrap configuration needed to start an Envoy proxy instance
for use as a Connect sidecar for a particular service instance. By default it for use as a Connect sidecar for a particular service instance. By default it
@ -684,4 +684,8 @@ Usage: consul connect envoy [options]
$ consul connect envoy -sidecar-for web $ consul connect envoy -sidecar-for web
Additional arguments may be passed directly to Envoy by specifying a double
dash followed by a list of options.
$ consul connect envoy -sidecar-for web -- --log-level debug
` `