Add command to inspect vault snapshots (#23457)

* add vault operator inspect command * tidy * add tests * add changelog * Update command/operator_raft_snapshot_inspect.go Co-authored-by: Jason O'Donnell <[email protected]> * Update command/operator_raft_snapshot_inspect.go Co-authored-by: Jason O'Donnell <[email protected]> * Update command/operator_raft_snapshot_inspect.go Co-authored-by: Jason O'Donnell <[email protected]> * Update command/operator_raft_snapshot_inspect.go Co-authored-by: Jason O'Donnell <[email protected]> * Update command/operator_raft_snapshot_inspect.go Co-authored-by: Jason O'Donnell <[email protected]> * remove test.snapshot file and create snapshot during test * fix help text and add custom format flag * Update changelog/23457.txt Co-authored-by: Jason O'Donnell <[email protected]> * add check that kvdepth is not less than zero * remove kvprefix from flag names * set details flag to default to true * remove total size, we don't use it * fix test that referenced old flag names * add size calculations * return all keys if depth set to 0 * Update command/operator_raft_snapshot_inspect.go Co-authored-by: Jason O'Donnell <[email protected]> * Update command/operator_raft_snapshot_inspect.go Co-authored-by: Jason O'Donnell <[email protected]> * Update command/operator_raft_snapshot_inspect.go * revert go.mod * update comment on temp file * update comment on closing writer * remove temporary file, and process state.bin in memory * return metadata like info * remove unnused function * remove ReadSnapshot func, and unnecessary goroutine * remove handler, and zero values * move defer, and return error instead of logging * add subcommand doc * remove -format flag * remove comments * change copy to copyN * remove formatters * remove formatters * remove duplicate check * fix error checks * remove unused consts --------- Co-authored-by: Jason O'Donnell <[email protected]>
hashicorp · Oct 31, 2023 · 63ab253 · 63ab253
1 parent 30a8435
commit 63ab253
Show file tree

Hide file tree

Showing 7 changed files with 735 additions and 6 deletions.
diff --git a/changelog/23457.txt b/changelog/23457.txt
@@ -0,0 +1,3 @@
+```release-note:feature
+cli/snapshot: Add CLI tool to inspect Vault snapshots
+```
diff --git a/command/commands.go b/command/commands.go
@@ -482,6 +482,11 @@ func initCommands(ui, serverCmdUi cli.Ui, runOpts *RunOptions) map[string]cli.Co
 				BaseCommand: getBaseCommand(),
 			}, nil
 		},
+		"operator raft snapshot inspect": func() (cli.Command, error) {
+			return &OperatorRaftSnapshotInspectCommand{
+				BaseCommand: getBaseCommand(),
+			}, nil
+		},
 		"operator raft snapshot restore": func() (cli.Command, error) {
 			return &OperatorRaftSnapshotRestoreCommand{
 				BaseCommand: getBaseCommand(),

diff --git a/command/operator_raft_snapshot.go b/command/operator_raft_snapshot.go
@@ -35,6 +35,10 @@ Usage: vault operator raft snapshot <subcommand> [options] [args]
 
       $ vault operator raft snapshot save raft.snap
 
+  Inspects a snapshot based on a file:
+
+      $ vault operator raft snapshot inspect raft.snap
+
   Please see the individual subcommand help for detailed usage information.
 `