docs: expand help for 'talosctl get'

Make it more obvious how to get list of all resources.

Signed-off-by: Andrey Smirnov <andrey.smirnov@talos-systems.com>
This commit is contained in:
Andrey Smirnov 2022-12-05 14:32:21 +04:00
parent fcffc88790
commit f0dddca2a3
No known key found for this signature in database
GPG Key ID: 7B26396447AB6DFD
2 changed files with 3 additions and 3 deletions

View File

@ -37,7 +37,7 @@ var getCmd = &cobra.Command{
Use: "get <type> [<id>]",
Aliases: []string{"g"},
SuggestFor: []string{},
Short: "Get a specific resource or list of resources.",
Short: "Get a specific resource or list of resources (use 'talosctl get rd' to see all available resource types).",
Long: `Similar to 'kubectl get', 'talosctl get' returns a set of resources from the OS.
To get a list of all available resource definitions, issue 'talosctl get rd'`,
Example: "",

View File

@ -1350,7 +1350,7 @@ Generate CAs, certificates, and private keys
## talosctl get
Get a specific resource or list of resources.
Get a specific resource or list of resources (use 'talosctl get rd' to see all available resource types).
### Synopsis
@ -2482,7 +2482,7 @@ A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl etcd](#talosctl-etcd) - Manage etcd
* [talosctl events](#talosctl-events) - Stream runtime events
* [talosctl gen](#talosctl-gen) - Generate CAs, certificates, and private keys
* [talosctl get](#talosctl-get) - Get a specific resource or list of resources.
* [talosctl get](#talosctl-get) - Get a specific resource or list of resources (use 'talosctl get rd' to see all available resource types).
* [talosctl health](#talosctl-health) - Check cluster health
* [talosctl images](#talosctl-images) - List the default images used by Talos
* [talosctl inject](#talosctl-inject) - Inject Talos API resources into Kubernetes manifests