Add note to quick start about idempotent deletes #2646
Conversation
While reviewing kind issues, I noticed there seems to be a regularly recurring problem with users expecting `kind delete cluster foo` to fail if there is not a cluster named `foo` present. We intentionally do not fail in this case. The delete command is idempotent, and should be able to be run repeatedly without erroring. This is very useful in clean up scripts, and many users rely on this behavior. It also makes things somewhat declarative in that you are saying "I don't want a cluster named foo", and `kind` helpfully confirms that there is no cluster named "foo". To try to avoid some of these repeated issues being filed, this adds a note to the quick start docs in the "Deleting a Cluster" section to point out that this is the expected behavior. This also helps new users to know that they can depend on this behavior if they are scripting things with kind. Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
k8s-ci-robot
added
cncf-cla: yes
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
/retest |
1 similar comment
|
/retest |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: BenTheElder, stmcginnis The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
|
/override pull-kind-e2e-kubernetes-1-23 (docs only change, override is safe) |
|
@BenTheElder: Overrode contexts on behalf of BenTheElder: pull-kind-e2e-kubernetes-1-23 In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
While reviewing kind issues, I noticed there seems to be a regularly
recurring problem with users expecting
kind delete cluster footofail if there is not a cluster named
foopresent.We intentionally do not fail in this case. The delete command is
idempotent, and should be able to be run repeatedly without erroring.
This is very useful in clean up scripts, and many users rely on this
behavior.
It also makes things somewhat declarative in that you are saying "I
don't want a cluster named foo", and
kindhelpfully confirms thatthere is no cluster named "foo".
To try to avoid some of these repeated issues being filed, this adds a
note to the quick start docs in the "Deleting a Cluster" section to
point out that this is the expected behavior. This also helps new users
to know that they can depend on this behavior if they are scripting
things with kind.