From 9790e86b906d2e409328dac3cf43999365ca92e6 Mon Sep 17 00:00:00 2001 From: sneak Date: Tue, 17 Nov 2026 02:20:35 +0000 Subject: [PATCH] Describe snapshot remove with a remote key when the listing fails Given a remote key, `snapshot remove` lists the destination before it removes anything. When the destination cannot be listed or has no marker file, it fails and removes nothing. The README and `snapshot remove --help` said a snapshot in the local index is still removed from it. That holds only for a snapshot named by its ID. "The marker file" in `README.md` and `docs/REPOSTRUCTURE.md` now lists `snapshot remove` with the commands that fail when given a remote key, or a snapshot ID that is not in the local index. The `--local-only` sentence in the help ran to 35 words and is split in two. Model: fable-5-2 --- README.md | 12 +++++++++--- docs/REPOSTRUCTURE.md | 4 +++- internal/cli/snapshot.go | 24 ++++++++++++++++-------- 3 files changed, 28 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index c95ec4f..2295d38 100644 --- a/README.md +++ b/README.md @@ -621,14 +621,18 @@ An ID that is in neither the local index nor the destination is an error. With `--local-only`, the argument must be the ID of a snapshot in the local index. The deletion at the destination can fail, for example when the destination is -unreachable or has no marker file. What happens then depends on where the -snapshot was: +unreachable or has no marker file. Given a snapshot ID, what happens then +depends on where the snapshot was: - A snapshot in the local index is still removed from it, with a warning. Run the same command again later to delete its directory at the destination. `vaultik prune` does not delete it. - For a snapshot that is only at the destination, the failure is an error. +Given a remote key, the command lists the destination before it removes +anything. When the destination cannot be listed or has no marker file, the +command fails and removes nothing, not even from the local index. + ### `snapshot restore [paths...]` Restores files from a snapshot into ``. The first argument is a @@ -1173,8 +1177,10 @@ not exist, commands treat the destination as not present: - `snapshot files` - `snapshot verify` - `snapshot restore` + - `snapshot remove` - `snapshot list` shows the local index alone. -- `snapshot remove` deletes nothing at the destination. +- `snapshot remove` deletes nothing at the destination when given a snapshot ID + that is in the local index. To fix this, mount the volume. If you emptied the destination on purpose, run `vaultik database delete` and back up again. diff --git a/docs/REPOSTRUCTURE.md b/docs/REPOSTRUCTURE.md index 30d9bbe..8b67b23 100644 --- a/docs/REPOSTRUCTURE.md +++ b/docs/REPOSTRUCTURE.md @@ -66,8 +66,10 @@ not exist, commands treat the destination as not present: - `snapshot files` - `snapshot verify` - `snapshot restore` + - `snapshot remove` - `snapshot list` shows the local index alone. -- `snapshot remove` deletes nothing at the destination. +- `snapshot remove` deletes nothing at the destination when given a snapshot ID + that is in the local index. The check is skipped when the look-up fails for any other reason. S3 refuses the look-up to credentials that can only write. A machine with such credentials diff --git a/internal/cli/snapshot.go b/internal/cli/snapshot.go index 071f22b..6b90c3a 100644 --- a/internal/cli/snapshot.go +++ b/internal/cli/snapshot.go @@ -385,15 +385,23 @@ destination store is an error. Needs permission to list and delete objects on the destination store, unless --local-only is given. Use --local-only to skip the remote half (e.g. when you want to forget a -snapshot locally without touching the destination store); the argument -must then be the ID of a snapshot in the local index. +snapshot locally without touching the destination store). With +--local-only, the argument must be the ID of a snapshot in the local +index. -If removing the snapshot's metadata from the destination store fails (for -example because the remote is unreachable), the local-database removal -still completes and a warning is emitted; run 'vaultik snapshot remove -' again once the destination store is reachable to remove -the snapshot's metadata from it ('vaultik prune' does not). For a -snapshot that is only on the destination store, that failure is an error. +Removing the snapshot's metadata from the destination store can fail, +for example when the destination store is unreachable or has no marker +file (vaultik-destination.txt). Given a snapshot ID, what happens then +depends on where the snapshot was. A snapshot in the local index is +still removed from it, with a warning. Run 'vaultik snapshot remove +' again later to remove its metadata from the destination +store. 'vaultik prune' does not remove it. For a snapshot that is only +on the destination store, the failure is an error. + +Given a remote key, the command lists the destination store before it +removes anything. When the destination store cannot be listed or has no +marker file, the command fails and removes nothing, not even from the +local index. To wipe the entire destination store and start over, use 'vaultik remote nuke --force' — it is the single supported entry point for that.`,