Skip to content

Commit

Permalink
[v14] update teleport configure -o/--output description (#44665)
Browse files Browse the repository at this point in the history
* update teleport configure -o description

* for abs path show the --output instead of -o

* use --output instead of -o for abs path for service location

* update -o description for configure

Co-authored-by: rosstimothy <39066650+rosstimothy@users.noreply.github.com>

* update -o=stdout to -o stdout for install systemd

* update command to use -o required parameters

* updated -o to --output for output description consistency

* update to consistently use --output= in command descriptions

---------

Co-authored-by: Steven Martin <stevenmartin@stevens-mbp.lan>
Co-authored-by: rosstimothy <39066650+rosstimothy@users.noreply.github.com>
Co-authored-by: Steven Martin <stevenmartin@Stevens-MBP.fios-router.home>
  • Loading branch information
4 people authored Jul 25, 2024
1 parent 572c3f9 commit 0bb651b
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions tool/teleport/common/teleport.go
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ func Run(options Options) (app *kingpin.Application, executedCommand string, con
dbConfigureCreate.Flag("gcp-instance-id", "(Only for Cloud SQL) GCP Cloud SQL instance identifier.").StringVar(&dbConfigCreateFlags.DatabaseGCPInstanceID)
dbConfigureCreate.Flag("ca-cert-file", "Database CA certificate path.").StringVar(&dbConfigCreateFlags.DatabaseCACertFile)
dbConfigureCreate.Flag("output",
"Write to stdout with -o=stdout, default config file with -o=file or custom path with -o=file:///path").Short('o').Default(
`Write to stdout with "--output=stdout", default config file with "--output=file" or custom path with --output=file:///path`).Short('o').Default(
teleport.SchemeStdout).StringVar(&dbConfigCreateFlags.output)
dbConfigureCreate.Flag("dynamic-resources-labels", "Comma-separated list(s) of labels to match dynamic resources, for example env=dev,dept=it. Required to enable dynamic resources matching.").StringsVar(&dbConfigCreateFlags.DynamicResourcesRawLabels)
dbConfigureCreate.Alias(dbCreateConfigExamples) // We're using "alias" section to display usage examples.
Expand Down Expand Up @@ -367,7 +367,7 @@ func Run(options Options) (app *kingpin.Application, executedCommand string, con
systemdInstall.Flag("pid-file", "Full path to the PID file.").Default(config.SystemdDefaultPIDFile).StringVar(&systemdInstallFlags.PIDFile)
systemdInstall.Flag("fd-limit", "Maximum number of open file descriptors.").Default(fmt.Sprintf("%v", config.SystemdDefaultFileDescriptorLimit)).IntVar(&systemdInstallFlags.FileDescriptorLimit)
systemdInstall.Flag("teleport-path", "Full path to the Teleport binary.").StringVar(&systemdInstallFlags.TeleportInstallationFile)
systemdInstall.Flag("output", "Write to stdout with -o=stdout or custom path with -o=file:///path").Short('o').Default(teleport.SchemeStdout).StringVar(&systemdInstallFlags.output)
systemdInstall.Flag("output", `Write to stdout with "--output=stdout" or custom path with --output=file:///path`).Short('o').Default(teleport.SchemeStdout).StringVar(&systemdInstallFlags.output)
systemdInstall.Alias(systemdInstallExamples) // We're using "alias" section to display usage examples.

// define a hidden 'scp' command (it implements server-side implementation of handling
Expand All @@ -386,7 +386,7 @@ func Run(options Options) (app *kingpin.Application, executedCommand string, con
dump.Flag("cluster-name",
"Unique cluster name, e.g. example.com.").StringVar(&dumpFlags.ClusterName)
dump.Flag("output",
"Write to stdout with -o=stdout, default config file with -o=file or custom path with -o=file:///path").Short('o').Default(
`Write to stdout with "--output=stdout", default config file with "--output=file" or custom path with --output=file:///path`).Short('o').Default(
teleport.SchemeStdout).StringVar(&dumpFlags.output)
dump.Flag("acme",
"Get automatic certificate from Letsencrypt.org using ACME.").BoolVar(&dumpFlags.ACMEEnabled)
Expand Down Expand Up @@ -414,7 +414,7 @@ func Run(options Options) (app *kingpin.Application, executedCommand string, con
dumpNodeConfigure.Flag("cluster-name",
"Unique cluster name, e.g. example.com.").StringVar(&dumpFlags.ClusterName)
dumpNodeConfigure.Flag("output",
"Write to stdout with -o=stdout, default config file with -o=file or custom path with -o=file:///path").Short('o').Default(
`Write to stdout with "--output=stdout", default config file with "--output=file" or custom path with --output=file:///path`).Short('o').Default(
teleport.SchemeStdout).StringVar(&dumpFlags.output)
dumpNodeConfigure.Flag("version", "Teleport configuration version.").Default(defaults.TeleportConfigVersionV3).StringVar(&dumpFlags.Version)
dumpNodeConfigure.Flag("public-addr", "The hostport that the node advertises for the SSH endpoint.").StringVar(&dumpFlags.PublicAddr)
Expand Down

0 comments on commit 0bb651b

Please sign in to comment.