public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-15 21:44:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3377 from briandowns/k3s-issue-2917

Browse Source 
add etcd subcommand info
This commit is contained in:
Catherine Luse
2021-07-01 21:35:46 -07:00
committed by GitHub
parent 40015403ca caae0f63b5
commit db37f47a80
1 changed files with 38 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/k3s/latest/en/backup-restore/_index.md
+38
View File
@@ -101,3 +101,41 @@ k3s server \
--etcd-s3-access-key=<S3-ACCESS-KEY> \
--etcd-s3-secret-key=<S3-SECRET-KEY>
```
### Etcd Snapshot and Restore Subcommands
k3s supports a set of subcommands for working with your etcd snapshots.
| Subcommand | Description |
| ----------- | --------------- |
| delete | Delete given snapshot(s) |
| ls, list, l | List snapshots |
| prune | Remove snapshots that exceed the configured retention count |
| save | Trigger an immediate etcd snapshot |
*note* The `save` subcommand is the same as `k3s etcd-snapshot`. The latter will eventually be deprecated in favor of the former.
These commands will perform as expected whether the etcd snapshots are stored locally or in an S3 compatible object store.
For additional information on the etcd snapshot subcommands, run `k3s etcd-snapshot`.
Delete a snapshot from S3.
```
k3s etcd-snapshot delete \
--s3 \
--s3-bucket=<S3-BUCKET-NAME> \
--s3-access-key=<S3-ACCESS-KEY> \
--s3-secret-key=<S3-SECRET-KEY> \
<SNAPSHOT-NAME>
```
Prune local snapshots with the default retention policy (5). The `prune` subcommand takes an additional flag `--snapshot-retention` that allows for overriding the default retention policy.
```
k3s etcd-snapshot prune
```
```
k3s etcd-snapshot prune --snapshot-retention 10
```