Merge pull request #3838 from stmcginnis/delete-description

Add description to delete cluster subcommands
This commit is contained in:
Kubernetes Prow Robot
2025-01-24 17:21:21 -08:00
committed by GitHub
2 changed files with 18 additions and 6 deletions

View File

@@ -38,11 +38,17 @@ type flagpole struct {
func NewCommand(logger log.Logger, streams cmd.IOStreams) *cobra.Command {
flags := &flagpole{}
cmd := &cobra.Command{
Args: cobra.NoArgs,
// TODO(bentheelder): more detailed usage
Args: cobra.NoArgs,
Use: "cluster",
Short: "Deletes a cluster",
Long: "Deletes a resource",
Long: `Deletes a Kind cluster from the system.
This is an idempotent operation, meaning it may be called multiple times without
failing (like "rm -f"). If the cluster resources exist they will be deleted, and
if the cluster is already gone it will just return success.
Errors will only occur if the cluster resources exist and are not able to be deleted.
`,
RunE: func(cmd *cobra.Command, args []string) error {
cli.OverrideDefaultName(cmd.Flags())
return deleteCluster(logger, flags)

View File

@@ -37,11 +37,17 @@ type flagpole struct {
func NewCommand(logger log.Logger, streams cmd.IOStreams) *cobra.Command {
flags := &flagpole{}
cmd := &cobra.Command{
Args: cobra.MinimumNArgs(0),
// TODO(bentheelder): more detailed usage
Args: cobra.MinimumNArgs(0),
Use: "clusters",
Short: "Deletes one or more clusters",
Long: "Deletes a resource",
Long: `Deletes one or more Kind clusters from the system.
This is an idempotent operation, meaning it may be called multiple times without
failing (like "rm -f"). If the cluster resources exist they will be deleted, and
if the cluster is already gone it will just return success.
Errors will only occur if the cluster resources exist and are not able to be deleted.
`,
RunE: func(cmd *cobra.Command, args []string) error {
if !flags.All && len(args) == 0 {
return errors.New("no cluster names provided")