docs: Clarify what the Force sync option does #20379
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change attempts to clarify what exactly the Force sync option does.
I have a handful of issues with the current description:
--force
flag inkubectl
. If it does, then we should probably warn the user that there may be unintended consequences such as the pod being deleted from Kubernetes but the containers keep running on the node. If it does not, I think we should clarify that so users (like me) aren't too afraid to use it.Force=true
, only an example setting bothForce=true
andReplace=true
. Does it not make sense to use onlyForce=true
? I think it does! We should clarify the use-case for this.I opened a PR rather than discussing in an Issue first, because I think it's easier to reason about texts if we see the suggested change in front of us.
Checklist: