Skip to content

Commit 7f0a067

Browse files
authored
Snapshot Single Item Recovery Docs (#1096)
Add documentation for snapshot single item recovery flow. RFC: https://go.hashi.co/rfc/vlt-358
2 parents 3c0d677 + dca1f71 commit 7f0a067

File tree

10 files changed

+83
-0
lines changed

10 files changed

+83
-0
lines changed

content/vault/v1.21.x (rc)/content/docs/sysadmin/snapshots/recover-a-secret/replicated-cluster.mdx

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ Load the snapshot holding the secret you want to recover:
3636

3737
<Tabs>
3838

39+
<Tab heading="GUI" group="gui">
40+
41+
@include 'sysadmin/snapshots/load-snapshot/gui/gui.mdx'
42+
43+
</Tab>
44+
3945
<Tab heading="CLI" group="cli">
4046

4147
<Tabs>
@@ -104,6 +110,12 @@ You can check for a loaded snapshot by listing the loaded snapshots:
104110

105111
<Tabs>
106112

113+
<Tab heading="GUI" group="gui">
114+
115+
@include 'sysadmin/snapshots/list-snapshots/gui.mdx'
116+
117+
</Tab>
118+
107119
<Tab heading="CLI" group="cli">
108120

109121
@include 'sysadmin/snapshots/list-snapshots/cli.mdx'
@@ -130,6 +142,12 @@ storage.
130142

131143
<Tabs>
132144

145+
<Tab heading="GUI" group="gui">
146+
147+
@include 'sysadmin/snapshots/secret-restore/recover/gui.mdx'
148+
149+
</Tab>
150+
133151
<Tab heading="CLI" group="cli">
134152

135153
@include 'sysadmin/snapshots/secret-restore/recover/cli.mdx'
@@ -150,6 +168,12 @@ storage.
150168

151169
<Tabs>
152170

171+
<Tab heading="GUI" group="gui">
172+
173+
@include 'sysadmin/snapshots/secret-restore/verify/gui.mdx'
174+
175+
</Tab>
176+
153177
<Tab heading="CLI" group="cli">
154178

155179
@include 'sysadmin/snapshots/secret-restore/verify/cli.mdx'

content/vault/v1.21.x (rc)/content/docs/sysadmin/snapshots/recover-a-secret/single-cluster.mdx

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ Load the snapshot holding the secret you want to recover.
3131

3232
<Tabs>
3333

34+
<Tab heading="GUI" group="gui">
35+
36+
@include 'sysadmin/snapshots/load-snapshot/gui/gui.mdx'
37+
38+
</Tab>
39+
3440
<Tab heading="CLI" group="cli">
3541

3642
<Tabs>
@@ -99,6 +105,12 @@ updating the loaded snapshot as new automated snapshots are created.
99105
You can check for a loaded snapshot by listing the loaded snapshots:
100106

101107
<Tabs>
108+
109+
<Tab heading="GUI" group="gui">
110+
111+
@include 'sysadmin/snapshots/list-snapshots/gui.mdx'
112+
113+
</Tab>
102114

103115
<Tab heading="CLI" group="cli">
104116

@@ -126,6 +138,12 @@ storage.
126138

127139
<Tabs>
128140

141+
<Tab heading="GUI" group="gui">
142+
143+
@include 'sysadmin/snapshots/secret-restore/recover/gui.mdx'
144+
145+
</Tab>
146+
129147
<Tab heading="CLI" group="cli">
130148

131149
@include 'sysadmin/snapshots/secret-restore/recover/cli.mdx'
@@ -146,6 +164,12 @@ storage.
146164

147165
<Tabs>
148166

167+
<Tab heading="GUI" group="gui">
168+
169+
@include 'sysadmin/snapshots/secret-restore/verify/gui.mdx'
170+
171+
</Tab>
172+
149173
<Tab heading="CLI" group="cli">
150174

151175
@include 'sysadmin/snapshots/secret-restore/verify/cli.mdx'
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
![Loaded snapshot card emphasized](/img/ui-secret-recovery-loaded-snapshot.png)
2+
3+
Select **Secrets Recovery** from the navigation menu to view currently loaded snapshots.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Snapshot load and unload operations are restricted to the root namespace. All other snapshot operations
2+
can be performed in other namespaces.
3+
4+
1. Open the Vault GUI and sign in to the root namespace. While you can perform
5+
other snapshot operations from any namespace, you must perform load and
6+
unload operations under the `root` namespace.
7+
8+
1. Select **Secrets Recovery** from the left navigation menu.
9+
10+
1. Select **Upload snapshot**.
11+
12+
1. Select your upload method. To use an automated snapshot you must provide an
13+
[automated snapshot config](/vault/api-docs/system/storage/raftautosnapshots#load-a-snapshot-from-an-automated-snapshot-configuration).
14+
15+
1. Click **Load snapshot** to complete the upload.
16+
17+
1. Monitor the upload until the status says "Ready" and the expiration date
18+
populates.
19+
![Snapshot overview card with status and details link emphasized](/img/ui-secret-recovery-overview-details.png)
20+
21+
1. Click "View details &rarr; to open the snapshot details view
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
![Snapshot read and recover form fields](/img/ui-secret-recovery-fields.png)
2+
3+
Use the available selectors and input fields to find the secret you want to read or recover. Once
4+
you selected, you can:
5+
6+
- view the snapshot data as key/value pairs or as a JSON object
7+
- recover to the original resource path
8+
- recover the original resource to a new path
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
If the recovery operation succeeds, the GUI displays a success message with a
2+
link to the recovered resource.
3+
![Snapshot recovery operation](/img/ui-secret-recovery-recover-message.png)
136 KB
Loading
200 KB
Loading
179 KB
Loading
119 KB
Loading

0 commit comments

Comments
 (0)