From 4ce8ffefeb59d85e901444696d2017445764abba Mon Sep 17 00:00:00 2001 From: Steven Martin Date: Thu, 25 Jul 2024 19:57:10 -0400 Subject: [PATCH] [v16] update teleport configure -o/--output description (#44663) * 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 Co-authored-by: rosstimothy <39066650+rosstimothy@users.noreply.github.com> Co-authored-by: Steven Martin --- tool/teleport/common/teleport.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tool/teleport/common/teleport.go b/tool/teleport/common/teleport.go index 0a40a50b4e6a5..b1db059a97776 100644 --- a/tool/teleport/common/teleport.go +++ b/tool/teleport/common/teleport.go @@ -299,7 +299,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.Flag("trust-system-cert-pool", "Allows Teleport to trust certificate authorities available on the host system for self-hosted databases.").BoolVar(&dbConfigCreateFlags.DatabaseTrustSystemCertPool) @@ -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. // This command is hidden because it is only meant to be used by the AutoDiscover script. @@ -395,7 +395,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) @@ -423,7 +423,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)