Re-org and revamp k3s etcd-snapshot docs #447
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: manuelbuil <[email protected]>
manuelbuil
force-pushed
the
etcdSnapshotRefresher
branch
from
5255ede to
5803479
Compare
dereknola
requested changes
Jul 21, 2025
brandond
requested changes
Jul 21, 2025
dereknola
approved these changes
Jul 30, 2025
brandond
requested changes
Jul 30, 2025
Member
brandond
left a comment
brandond
left a comment
There was a problem hiding this comment.
one final nit about informal language
docs/cli/etcd-snapshot.md
Outdated
| Scheduled snapshots are enabled by default, at 00:00 and 12:00 system time, with 5 snapshots retained. Scheduled snapshots have a name that starts with `etcd-snapshot`, followed by the node name and timestamp. | ||
|
|
||
| ### On-demand Snapshots | ||
| These are the configuration options that we can set for scheduled snapshots: |
Member
There was a problem hiding this comment.
this is a little informal, how about:
Suggested change
| These are the configuration options that we can set for scheduled snapshots: | |
| The following options control the operation of scheduled snapshots: |
docs/cli/etcd-snapshot.md
Outdated
|
|
||
| These flags are valid for both `k3s server` and `k3s etcd-snapshot`, however when passed to `k3s etcd-snapshot` the `--etcd-` prefix can be omitted to avoid redundancy. | ||
| Flags can be passed in with the command line, or in the [configuration file,](../installation/configuration.md#configuration-file ) which may be easier to use. | ||
| These are the configuration options that we can set for on-demand snapshots: |
Member
There was a problem hiding this comment.
Suggested change
| These are the configuration options that we can set for on-demand snapshots: | |
| The following options control the operation of on-demand snapshots: |
Contributor
Author
There was a problem hiding this comment.
yes, reads more professional
Signed-off-by: manuelbuil <[email protected]>
manuelbuil
force-pushed
the
etcdSnapshotRefresher
branch
from
8f4acee to
bc9fa77
Compare
brandond
approved these changes
Jul 31, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 PR tries to improve our current K3s etcd-snapshot docs to make it easier to read. I haven't changed a lot of text but mostly I moved it around.
The page now starts with a brief introduction, explaining the 4 different types of snapshots (local-s3, on-demand-scheduled) and showing the CLI subcommands. Then it describes how to create snapshots, separating "scheduled" and "on-demand" with tabs, as these two use options differently. Then how to delete snapshots, explaining the difference between "delete" and "prune". Once these are clear, we explain how to connect to S3 and insist on "replication" (it is not either/or). Then, it moves to the restoring of snapshots and the steps. And finally, it explains the ETCDSnapshotFile CR, which I believe is for advanced users.
I also removed the "default" key word in a couple of networking docs because all tabs had it.