From f0dddca2a3d2e976cee543ab57816a6395fe3d65 Mon Sep 17 00:00:00 2001 From: Andrey Smirnov Date: Mon, 5 Dec 2022 14:32:21 +0400 Subject: [PATCH] docs: expand help for 'talosctl get' Make it more obvious how to get list of all resources. Signed-off-by: Andrey Smirnov --- cmd/talosctl/cmd/talos/get.go | 2 +- website/content/v1.3/reference/cli.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/cmd/talosctl/cmd/talos/get.go b/cmd/talosctl/cmd/talos/get.go index 451f21e1e9..d219ff0498 100644 --- a/cmd/talosctl/cmd/talos/get.go +++ b/cmd/talosctl/cmd/talos/get.go @@ -37,7 +37,7 @@ var getCmd = &cobra.Command{ Use: "get []", 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: "", diff --git a/website/content/v1.3/reference/cli.md b/website/content/v1.3/reference/cli.md index 42e9c7fad3..4c23f3beb0 100644 --- a/website/content/v1.3/reference/cli.md +++ b/website/content/v1.3/reference/cli.md @@ -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