Align etcd-snapshot-dir default path description #11571
Merged
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.
Proposed Changes
The CLI documentation (i.e.
--help
output) should be a reliable source of truth for the end user. This PR ensures that the default etcd snapshot location matches the expectations that are being set by the CLI. It updates the--etcd-snapshot-dir
option's description to match the effective default snapshot path (one that will be used by theserver
).Types of Changes
Bugfix, a simple update to the
--etcd-snapshot-dir
option descriptions for theserver
andetcd-snapshot
commands.Verification
This section is mostly based on the reproduction steps from #11570
k3s server --help | grep '\-dir'
.--etcd-snapshot-dir
matches${data-dir}/server/db/snapshots
. That's been confirmed to be the actual path in the issue's analysis.k3s etcd-snapshot --help | grep '\-dir'
.Testing
Test coverage updates are not applicable to this PR, since it introduces no changes to the logic.
Linked Issues
#11570
User-Facing Change
Further Comments
No further comments.