Skip to content
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.

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

Add description to delete cluster subcommands #3838

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

stmcginnis
Copy link
Contributor

This adds a more detailed description to the kind delete cluster and kind delete clusters commands explaining expected delete behavior.

Hopefully this reduces some of the regular confusion from users submitting issues due to expecting an error deleting a cluster that does not exist.

Updated command output:

$ kind delete cluster --help
Deletes a Kind cluster from the system.

This is an idempotent operation, meaning it may be called multiple times without
failing. If the cluster exists it will be deleted, and if the cluster is already
gone it will just return success. Errors will only occur if the cluster exists
and was not able to be deleted.

Usage:
  kind delete cluster [flags]

Flags:
  -h, --help                help for cluster
      --kubeconfig string   sets kubeconfig path instead of $KUBECONFIG or $HOME/.kube/config
  -n, --name string         the cluster name (default "kind")

Global Flags:
  -q, --quiet             silence all stderr output
  -v, --verbosity int32   info log verbosity, higher value produces more output

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 5, 2025
@k8s-ci-robot k8s-ci-robot requested a review from aojea January 5, 2025 15:59
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jan 5, 2025
Copy link
Member

@BenTheElder BenTheElder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks! some suggestions + gofmt is required

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]>
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: stmcginnis
Once this PR has been reviewed and has the lgtm label, please assign bentheelder for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants