Skip to content

tsh updates: include db in tsh play and consistent command descriptions #26803

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stevenGravy merged 2 commits into from
May 24, 2023
Merged

tsh updates: include db in tsh play and consistent command descriptions #26803

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f5f94ed
include db in tsh play and consistent description ends
stevenGravy May 23, 2023
75d6d05
Merge branch 'master' into stevenGravy/tshcommands
stevenGravy May 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tool/tsh/device.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ func newDeviceCommand(app *kingpin.Application) *deviceCommand {

// "tsh device enroll" command.
root.enroll.CmdClause = parentCmd.Command(
"enroll", "Enroll this device as a trusted device. Requires Teleport Enterprise")
"enroll", "Enroll this device as a trusted device. Requires Teleport Enterprise.")
root.enroll.Flag("token", "Device enrollment token").
Required().
StringVar(&root.enroll.token)
Expand Down
6 changes: 3 additions & 3 deletions tool/tsh/kube.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,7 @@ type kubeExecCommand struct {

func newKubeExecCommand(parent *kingpin.CmdClause) *kubeExecCommand {
c := &kubeExecCommand{
CmdClause: parent.Command("exec", "Execute a command in a Kubernetes pod"),
CmdClause: parent.Command("exec", "Execute a command in a Kubernetes pod."),
}

c.Flag("container", "Container name. If omitted, use the kubectl.kubernetes.io/default-container annotation for selecting the container to be attached or the first container in the pod will be chosen").Short('c').StringVar(&c.container)
Expand Down Expand Up @@ -771,7 +771,7 @@ type kubeLSCommand struct {

func newKubeLSCommand(parent *kingpin.CmdClause) *kubeLSCommand {
c := &kubeLSCommand{
CmdClause: parent.Command("ls", "Get a list of Kubernetes clusters"),
CmdClause: parent.Command("ls", "Get a list of Kubernetes clusters."),
}
c.Flag("cluster", clusterHelp).Short('c').StringVar(&c.siteName)
c.Flag("search", searchHelp).StringVar(&c.searchKeywords)
Expand Down Expand Up @@ -1002,7 +1002,7 @@ type kubeLoginCommand struct {

func newKubeLoginCommand(parent *kingpin.CmdClause) *kubeLoginCommand {
c := &kubeLoginCommand{
CmdClause: parent.Command("login", "Login to a Kubernetes cluster"),
CmdClause: parent.Command("login", "Login to a Kubernetes cluster."),
}
c.Flag("cluster", clusterHelp).Short('c').StringVar(&c.siteName)
c.Arg("kube-cluster", "Name of the Kubernetes cluster to login to. Check 'tsh kube ls' for a list of available clusters.").StringVar(&c.kubeCluster)
Expand Down
6 changes: 3 additions & 3 deletions tool/tsh/mfa.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ type mfaLSCommand struct {

func newMFALSCommand(parent *kingpin.CmdClause) *mfaLSCommand {
c := &mfaLSCommand{
CmdClause: parent.Command("ls", "Get a list of registered MFA devices"),
CmdClause: parent.Command("ls", "Get a list of registered MFA devices."),
}
c.Flag("verbose", "Print more information about MFA devices").Short('v').BoolVar(&c.verbose)
c.Flag("format", defaults.FormatFlagDescription(defaults.DefaultFormats...)).Short('f').Default(teleport.Text).EnumVar(&c.format, defaults.DefaultFormats...)
Expand Down Expand Up @@ -202,7 +202,7 @@ type mfaAddCommand struct {

func newMFAAddCommand(parent *kingpin.CmdClause) *mfaAddCommand {
c := &mfaAddCommand{
CmdClause: parent.Command("add", "Add a new MFA device"),
CmdClause: parent.Command("add", "Add a new MFA device."),
}
c.Flag("name", "Name of the new MFA device").StringVar(&c.devName)
c.Flag("type", fmt.Sprintf("Type of the new MFA device (%s)", strings.Join(defaultDeviceTypes, ", "))).
Expand Down Expand Up @@ -542,7 +542,7 @@ type mfaRemoveCommand struct {

func newMFARemoveCommand(parent *kingpin.CmdClause) *mfaRemoveCommand {
c := &mfaRemoveCommand{
CmdClause: parent.Command("rm", "Remove a MFA device"),
CmdClause: parent.Command("rm", "Remove a MFA device."),
}
c.Arg("name", "Name or ID of the MFA device to remove").Required().StringVar(&c.name)
return c
Expand Down
56 changes: 28 additions & 28 deletions tool/tsh/tsh.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -657,7 +657,7 @@ func Run(ctx context.Context, args []string, opts ...cliOption) error {
BoolVar(&cf.clientOnlyVersionCheck)
// ssh
// Use Interspersed(false) to forward all flags to ssh.
ssh := app.Command("ssh", "Run shell or execute a command on a remote SSH node").Interspersed(false)
ssh := app.Command("ssh", "Run shell or execute a command on a remote SSH node.").Interspersed(false)
ssh.Arg("[user@]host", "Remote hostname and the login to use").Required().StringVar(&cf.UserHost)
ssh.Arg("command", "Command to execute on a remote host").StringsVar(&cf.RemoteCommand)
app.Flag("jumphost", "SSH jumphost").Short('J').StringVar(&cf.ProxyJump)
Expand All @@ -678,12 +678,12 @@ func Run(ctx context.Context, args []string, opts ...cliOption) error {
ssh.Flag("disable-access-request", "Disable automatic resource access requests").BoolVar(&cf.disableAccessRequest)

// Daemon service for teleterm client
daemon := app.Command("daemon", "Daemon is the tsh daemon service").Hidden()
daemonStart := daemon.Command("start", "Starts tsh daemon service").Hidden()
daemon := app.Command("daemon", "Daemon is the tsh daemon service.").Hidden()
daemonStart := daemon.Command("start", "Starts tsh daemon service.").Hidden()
daemonStart.Flag("addr", "Addr is the daemon listening address.").StringVar(&cf.DaemonAddr)
daemonStart.Flag("certs-dir", "Directory containing certs used to create secure gRPC connection with daemon service").StringVar(&cf.DaemonCertsDir)
daemonStart.Flag("prehog-addr", "URL where prehog events should be submitted").StringVar(&cf.DaemonPrehogAddr)
daemonStop := daemon.Command("stop", "Gracefully stops a process on Windows by sending Ctrl-Break to it").Hidden()
daemonStop := daemon.Command("stop", "Gracefully stops a process on Windows by sending Ctrl-Break to it.").Hidden()
daemonStop.Flag("pid", "PID to be stopped").IntVar(&cf.DaemonPid)

// AWS.
Expand Down Expand Up @@ -745,11 +745,11 @@ func Run(ctx context.Context, args []string, opts ...cliOption) error {
exportRecordings.Arg("session-id", "ID of the session to join").Required().StringVar(&cf.SessionID)

// Local TLS proxy.
proxy := app.Command("proxy", "Run local TLS proxy allowing connecting to Teleport in single-port mode")
proxySSH := proxy.Command("ssh", "Start local TLS proxy for ssh connections when using Teleport in single-port mode")
proxy := app.Command("proxy", "Run local TLS proxy allowing connecting to Teleport in single-port mode.")
proxySSH := proxy.Command("ssh", "Start local TLS proxy for ssh connections when using Teleport in single-port mode.")
proxySSH.Arg("[user@]host", "Remote hostname and the login to use").Required().StringVar(&cf.UserHost)
proxySSH.Flag("cluster", clusterHelp).Short('c').StringVar(&cf.SiteName)
proxyDB := proxy.Command("db", "Start local TLS proxy for database connections when using Teleport in single-port mode")
proxyDB := proxy.Command("db", "Start local TLS proxy for database connections when using Teleport in single-port mode.")
proxyDB.Arg("db", "The name of the database to start local proxy for").Required().StringVar(&cf.DatabaseService)
proxyDB.Flag("port", "Specifies the source port used by proxy db listener").Short('p').StringVar(&cf.LocalProxyPort)
// --cert-file and --key-file are deprecated in favor of --tunnel flag.
Expand All @@ -760,7 +760,7 @@ func Run(ctx context.Context, args []string, opts ...cliOption) error {
proxyDB.Flag("db-name", "Optional database name to log in to.").StringVar(&cf.DatabaseName)
proxyDB.Flag("cluster", clusterHelp).Short('c').StringVar(&cf.SiteName)

proxyApp := proxy.Command("app", "Start local TLS proxy for app connection when using Teleport in single-port mode")
proxyApp := proxy.Command("app", "Start local TLS proxy for app connection when using Teleport in single-port mode.")
proxyApp.Arg("app", "The name of the application to start local proxy for").Required().StringVar(&cf.AppName)
proxyApp.Flag("port", "Specifies the source port used by by the proxy app listener").Short('p').StringVar(&cf.LocalProxyPort)

Expand Down Expand Up @@ -817,30 +817,30 @@ func Run(ctx context.Context, args []string, opts ...cliOption) error {
dbConnect.Flag("db-name", "Optional database name to log in to.").StringVar(&cf.DatabaseName)

// join
join := app.Command("join", "Join the active SSH or Kubernetes session")
join := app.Command("join", "Join the active SSH or Kubernetes session.")
join.Flag("cluster", clusterHelp).Short('c').StringVar(&cf.SiteName)
join.Flag("mode", "Mode of joining the session, valid modes are observer, moderator and peer.").Short('m').Default("observer").EnumVar(&cf.JoinMode, "observer", "moderator", "peer")
join.Flag("reason", "The purpose of the session.").StringVar(&cf.Reason)
join.Flag("invite", "A comma separated list of people to mark as invited for the session.").StringsVar(&cf.Invited)
join.Arg("session-id", "ID of the session to join").Required().StringVar(&cf.SessionID)
// play
play := app.Command("play", "Replay the recorded session (SSH, Kubernetes, App)")
play := app.Command("play", "Replay the recorded session (SSH, Kubernetes, App, DB).")
play.Flag("cluster", clusterHelp).Short('c').StringVar(&cf.SiteName)
play.Flag("format", defaults.FormatFlagDescription(
teleport.PTY, teleport.JSON, teleport.YAML,
)).Short('f').Default(teleport.PTY).EnumVar(&cf.Format, teleport.PTY, teleport.JSON, teleport.YAML)
play.Arg("session-id", "ID of the session to play").Required().StringVar(&cf.SessionID)

// scp
scp := app.Command("scp", "Transfer files to a remote Node")
scp := app.Command("scp", "Transfer files to a remote Node.")
scp.Flag("cluster", clusterHelp).Short('c').StringVar(&cf.SiteName)
scp.Arg("from, to", "Source and destination to copy, one must be a local path and one must be a remote path").Required().StringsVar(&cf.CopySpec)
scp.Flag("recursive", "Recursive copy of subdirectories").Short('r').BoolVar(&cf.RecursiveCopy)
scp.Flag("port", "Port to connect to on the remote host").Short('P').Int32Var(&cf.NodePort)
scp.Flag("preserve", "Preserves access and modification times from the original file").Short('p').BoolVar(&cf.PreserveAttrs)
scp.Flag("quiet", "Quiet mode").Short('q').BoolVar(&cf.Quiet)
// ls
ls := app.Command("ls", "List remote SSH nodes")
ls := app.Command("ls", "List remote SSH nodes.")
ls.Flag("cluster", clusterHelp).Short('c').StringVar(&cf.SiteName)
ls.Flag("verbose", "One-line output (for text format), including node UUIDs").Short('v').BoolVar(&cf.Verbose)
ls.Flag("format", defaults.FormatFlagDescription(
Expand All @@ -851,13 +851,13 @@ func Run(ctx context.Context, args []string, opts ...cliOption) error {
ls.Flag("query", queryHelp).StringVar(&cf.PredicateExpression)
ls.Flag("all", "List nodes from all clusters and proxies.").Short('R').BoolVar(&cf.ListAll)
// clusters
clusters := app.Command("clusters", "List available Teleport clusters")
clusters := app.Command("clusters", "List available Teleport clusters.")
clusters.Flag("format", defaults.FormatFlagDescription(defaults.DefaultFormats...)).Short('f').Default(teleport.Text).EnumVar(&cf.Format, defaults.DefaultFormats...)
clusters.Flag("quiet", "Quiet mode").Short('q').BoolVar(&cf.Quiet)

// login logs in with remote proxy and obtains a "session certificate" which gets
// stored in ~/.tsh directory
login := app.Command("login", "Log in to a cluster and retrieve the session certificate")
login := app.Command("login", "Log in to a cluster and retrieve the session certificate.")
login.Flag("out", "Identity output").Short('o').AllowDuplicate().StringVar(&cf.IdentityFileOut)
login.Flag("format", fmt.Sprintf("Identity format: %s, %s (for OpenSSH compatibility) or %s (for kubeconfig)",
identityfile.DefaultFormat,
Expand All @@ -877,10 +877,10 @@ func Run(ctx context.Context, args []string, opts ...cliOption) error {
login.Alias(loginUsageFooter)

// logout deletes obtained session certificates in ~/.tsh
logout := app.Command("logout", "Delete a cluster certificate")
logout := app.Command("logout", "Delete a cluster certificate.")

// bench
bench := app.Command("bench", "Run shell or execute a command on a remote SSH node").Hidden()
bench := app.Command("bench", "Run shell or execute a command on a remote SSH node.").Hidden()
bench.Flag("cluster", clusterHelp).Short('c').StringVar(&cf.SiteName)
bench.Flag("duration", "Test duration").Default("1s").DurationVar(&cf.BenchDuration)
bench.Flag("rate", "Requests per second rate").Default("10").IntVar(&cf.BenchRate)
Expand Down Expand Up @@ -908,38 +908,38 @@ func Run(ctx context.Context, args []string, opts ...cliOption) error {
benchExecKube.Flag("interactive", "Create interactive Kube session").BoolVar(&cf.BenchInteractive)

// show key
show := app.Command("show", "Read an identity from file and print to stdout").Hidden()
show := app.Command("show", "Read an identity from file and print to stdout.").Hidden()
show.Arg("identity_file", "The file containing a public key or a certificate").Required().StringVar(&cf.IdentityFileIn)

// The status command shows which proxy the user is logged into and metadata
// about the certificate.
status := app.Command("status", "Display the list of proxy servers and retrieved certificates")
status := app.Command("status", "Display the list of proxy servers and retrieved certificates.")
status.Flag("format", defaults.FormatFlagDescription(defaults.DefaultFormats...)).Short('f').Default(teleport.Text).EnumVar(&cf.Format, defaults.DefaultFormats...)
status.Flag("verbose", "Show extra status information after successful login").Short('v').BoolVar(&cf.Verbose)

// The environment command prints out environment variables for the configured
// proxy and cluster. Can be used to create sessions "sticky" to a terminal
// even if the user runs "tsh login" again in another window.
environment := app.Command("env", "Print commands to set Teleport session environment variables")
environment := app.Command("env", "Print commands to set Teleport session environment variables.")
environment.Flag("format", defaults.FormatFlagDescription(defaults.DefaultFormats...)).Short('f').Default(teleport.Text).EnumVar(&cf.Format, defaults.DefaultFormats...)
environment.Flag("unset", "Print commands to clear Teleport session environment variables").BoolVar(&cf.unsetEnvironment)

req := app.Command("request", "Manage access requests").Alias("requests")
req := app.Command("request", "Manage access requests.").Alias("requests")

reqList := req.Command("ls", "List access requests").Alias("list")
reqList := req.Command("ls", "List access requests.").Alias("list")
reqList.Flag("format", defaults.FormatFlagDescription(defaults.DefaultFormats...)).Short('f').Default(teleport.Text).EnumVar(&cf.Format, defaults.DefaultFormats...)
reqList.Flag("reviewable", "Only show requests reviewable by current user").BoolVar(&cf.ReviewableRequests)
reqList.Flag("suggested", "Only show requests that suggest current user as reviewer").BoolVar(&cf.SuggestedRequests)
reqList.Flag("my-requests", "Only show requests created by current user").BoolVar(&cf.MyRequests)

reqShow := req.Command("show", "Show request details").Alias("details")
reqShow := req.Command("show", "Show request details.").Alias("details")
reqShow.Flag("format", defaults.FormatFlagDescription(defaults.DefaultFormats...)).Short('f').Default(teleport.Text).EnumVar(&cf.Format, defaults.DefaultFormats...)
reqShow.Arg("request-id", "ID of the target request").Required().StringVar(&cf.RequestID)

// Note: The "tsh request new" subcommand should not be used anymore. It
// will be kept around for users that built automation around it, but all
// public facing documentation should now refer to "tsh request create".
reqCreate := req.Command("create", "Create a new access request").Alias("new")
reqCreate := req.Command("create", "Create a new access request.").Alias("new")
reqCreate.Flag("roles", "Roles to be requested").StringVar(&cf.DesiredRoles)
reqCreate.Flag("reason", "Reason for requesting").StringVar(&cf.RequestReason)
reqCreate.Flag("reviewers", "Suggested reviewers").StringVar(&cf.SuggestedReviewers)
Expand All @@ -948,13 +948,13 @@ func Run(ctx context.Context, args []string, opts ...cliOption) error {
reqCreate.Flag("request-ttl", "Expiration time for the access request").DurationVar(&cf.RequestTTL)
reqCreate.Flag("session-ttl", "Expiration time for the elevated certificate").DurationVar(&cf.SessionTTL)

reqReview := req.Command("review", "Review an access request")
reqReview := req.Command("review", "Review an access request.")
reqReview.Arg("request-id", "ID of target request").Required().StringVar(&cf.RequestID)
reqReview.Flag("approve", "Review proposes approval").BoolVar(&cf.Approve)
reqReview.Flag("deny", "Review proposes denial").BoolVar(&cf.Deny)
reqReview.Flag("reason", "Review reason message").StringVar(&cf.ReviewReason)

reqSearch := req.Command("search", "Search for resources to request access to")
reqSearch := req.Command("search", "Search for resources to request access to.")
reqSearch.Flag("kind",
fmt.Sprintf("Resource kind to search for (%s)",
strings.Join(types.RequestableResourceKinds, ", ")),
Expand All @@ -971,17 +971,17 @@ func Run(ctx context.Context, args []string, opts ...cliOption) error {
approve := headless.Command("approve", "Approve a headless authentication request.").Interspersed(true)
approve.Arg("request id", "Headless authentication request ID").StringVar(&cf.HeadlessAuthenticationID)

reqDrop := req.Command("drop", "Drop one more access requests from current identity")
reqDrop := req.Command("drop", "Drop one more access requests from current identity.")
reqDrop.Arg("request-id", "IDs of requests to drop (default drops all requests)").Default("*").StringsVar(&cf.RequestIDs)
kubectl := app.Command("kubectl", "Runs a kubectl command on a Kubernetes cluster").Interspersed(false)
kubectl := app.Command("kubectl", "Runs a kubectl command on a Kubernetes cluster.").Interspersed(false)
// This hack is required in order to accept any args for tsh kubectl.
kubectl.Arg("", "").StringsVar(new([]string))
// Kubernetes subcommands.
kube := newKubeCommand(app)
// MFA subcommands.
mfa := newMFACommand(app)

config := app.Command("config", "Print OpenSSH configuration details")
config := app.Command("config", "Print OpenSSH configuration details.")

// FIDO2, TouchID and WebAuthnWin commands.
f2 := newFIDO2Command(app)
Expand Down