Skip to content

Commit

Permalink
Add description to delete cluster subcommands
Browse files Browse the repository at this point in the history
This adds a more detailed description to the `kind delete cluster` and
`kind delete clusters` commands explaining expected delete behavior.

Signed-off-by: Sean McGinnis <[email protected]>
  • Loading branch information
stmcginnis committed Jan 7, 2025
1 parent 1c5a56b commit 2a329ee
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 6 deletions.
12 changes: 9 additions & 3 deletions pkg/cmd/kind/delete/cluster/deletecluster.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
12 changes: 9 additions & 3 deletions pkg/cmd/kind/delete/clusters/deleteclusters.go
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down

0 comments on commit 2a329ee

Please sign in to comment.