Skip to content

Commit 47a8bfa

Browse files
lane-wetmorelane-wetmore
committed
move new docs into previous doc pages
1 parent 4931381 commit 47a8bfa

File tree

6 files changed

+134
-217
lines changed

6 files changed

+134
-217
lines changed

‎content/vault/v1.21.x (rc)/content/docs/concepts/data-recovery/index.mdx‎

Lines changed: 0 additions & 208 deletions
This file was deleted.

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

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

3737
<Tabs>
3838

39+
<Tab heading="Web UI" group="ui">
40+
41+
1. Open a web browser to access the Vault UI and sign in to the root namespace.
42+
<Tip title="Namespace restriction">
43+
44+
Snapshot load and unload operations are restricted to the root namespace. All other snapshot operations
45+
can be performed in other namespaces.
46+
47+
</Tip>
48+
49+
<Tip title="Permissions Required">
50+
This requires snapshot management permissions.
51+
</Tip>
52+
53+
2. Select **Secrets Recovery** from the left navigation menu.
54+
55+
3. Select **Upload snapshot**.
56+
![Load snapshot button location emphasized](/img/ui-secret-recovery-upload.png)
57+
58+
4. Select the method of upload. If loading from **automated** snapshots, an automated snapshot config is required.
59+
Refer to the [automated snapshot API](https://developer.hashicorp.com/vault/api-docs/system/storage/raftautosnapshots#load-a-snapshot-from-an-automated-snapshot-configuration)
60+
to learn more about automated snapshots.
61+
![Load snapshot form](/img/ui-secret-recovery-upload-form.png)
62+
63+
5. Click **Load snapshot** to complete the upload.
64+
6. The status of the snapshot and the expiration date is shown. This also allows
65+
navigation to the snapshot details view.
66+
![Snapshot overview card with status and details link emphasized](/img/ui-secret-recovery-overview-details.png)
67+
68+
</Tab>
69+
3970
<Tab heading="CLI" group="cli">
4071

4172
<Tabs>
@@ -104,6 +135,15 @@ You can check for a loaded snapshot by listing the loaded snapshots:
104135

105136
<Tabs>
106137

138+
<Tab heading="Web UI" group="ui">
139+
140+
1. Select **Secrets Recovery** from the left navigation menu.
141+
142+
2. If a snapshot has been loaded, it will appear here.
143+
![Loaded snapshot card emphasized](/img/ui-secret-recovery-loaded-snapshot.png)
144+
145+
</Tab>
146+
107147
<Tab heading="CLI" group="cli">
108148

109149
@include 'sysadmin/snapshots/list-snapshots/cli.mdx'
@@ -130,6 +170,23 @@ storage.
130170

131171
<Tabs>
132172

173+
<Tab heading="Web UI" group="ui">
174+
<Tip title="Permissions Required">
175+
This requires read and/or recover permissions specific to the resource.
176+
</Tip>
177+
178+
1. A namespace selector will show when in the root namespace. Fill in the available fields to locate the secret to read or recover.
179+
![Snapshot read and recover form fields](/img/ui-secret-recovery-fields.png)
180+
181+
2. Upon a successful read operation, the resource can be viewed as key value pairs or as JSON.
182+
![Snapshot read view in key value format](/img/ui-secret-recovery-read-kv.png)
183+
![Snapshot read view in JSON format](/img/ui-secret-recovery-read-json.png)
184+
185+
3. In addition to recovering to the original resource path, recovering a copy to a new path is possible. The original resource will be unaffected.
186+
![Snapshot recovery to copy operation](/img/ui-secret-recovery-recover-copy.png)
187+
188+
</Tab>
189+
133190
<Tab heading="CLI" group="cli">
134191

135192
@include 'sysadmin/snapshots/secret-restore/recover/cli.mdx'
@@ -150,6 +207,16 @@ storage.
150207

151208
<Tabs>
152209

210+
<Tab heading="Web UI" group="ui">
211+
<Tip title="Permissions Required">
212+
This requires recover permissions specific to the resource.
213+
</Tip>
214+
215+
Upon a successful recovery operation, a success message with a link to the recovered resource will be shown.
216+
![Snapshot recovery operation](/img/ui-secret-recovery-recover-message.png)
217+
218+
</Tab>
219+
153220
<Tab heading="CLI" group="cli">
154221

155222
@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: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,37 @@ Load the snapshot holding the secret you want to recover.
3131

3232
<Tabs>
3333

34+
<Tab heading="Web UI" group="ui">
35+
36+
1. Open a web browser to access the Vault UI and sign in to the root namespace.
37+
<Tip title="Namespace restriction">
38+
39+
Snapshot load and unload operations are restricted to the root namespace. All other snapshot operations
40+
can be performed in other namespaces.
41+
42+
</Tip>
43+
44+
<Tip title="Permissions Required">
45+
This requires snapshot management permissions.
46+
</Tip>
47+
48+
2. Select **Secrets Recovery** from the left navigation menu.
49+
50+
3. Select **Upload snapshot**.
51+
![Load snapshot button location emphasized](/img/ui-secret-recovery-upload.png)
52+
53+
4. Select the method of upload. If loading from **automated** snapshots, an automated snapshot config is required.
54+
Refer to the [automated snapshot API](https://developer.hashicorp.com/vault/api-docs/system/storage/raftautosnapshots#load-a-snapshot-from-an-automated-snapshot-configuration)
55+
to learn more about automated snapshots.
56+
![Load snapshot form](/img/ui-secret-recovery-upload-form.png)
57+
58+
5. Click **Load snapshot** to complete the upload.
59+
6. The status of the snapshot and the expiration date is shown. This also allows
60+
navigation to the snapshot details view.
61+
![Snapshot overview card with status and details link emphasized](/img/ui-secret-recovery-overview-details.png)
62+
63+
</Tab>
64+
3465
<Tab heading="CLI" group="cli">
3566

3667
<Tabs>
@@ -99,6 +130,15 @@ updating the loaded snapshot as new automated snapshots are created.
99130
You can check for a loaded snapshot by listing the loaded snapshots:
100131

101132
<Tabs>
133+
134+
<Tab heading="Web UI" group="ui">
135+
136+
1. Select **Secrets Recovery** from the left navigation menu.
137+
138+
2. If a snapshot has been loaded, it will appear here.
139+
![Loaded snapshot card emphasized](/img/ui-secret-recovery-loaded-snapshot.png)
140+
141+
</Tab>
102142

103143
<Tab heading="CLI" group="cli">
104144

@@ -126,6 +166,23 @@ storage.
126166

127167
<Tabs>
128168

169+
<Tab heading="Web UI" group="ui">
170+
<Tip title="Permissions Required">
171+
This requires read and/or recover permissions specific to the resource.
172+
</Tip>
173+
174+
1. A namespace selector will show when in the root namespace. Fill in the available fields to locate the secret to read or recover.
175+
![Snapshot read and recover form fields](/img/ui-secret-recovery-fields.png)
176+
177+
2. Upon a successful read operation, the resource can be viewed as key value pairs or as JSON.
178+
![Snapshot read view in key value format](/img/ui-secret-recovery-read-kv.png)
179+
![Snapshot read view in JSON format](/img/ui-secret-recovery-read-json.png)
180+
181+
3. In addition to recovering to the original resource path, recovering a copy to a new path is possible. The original resource will be unaffected.
182+
![Snapshot recovery to copy operation](/img/ui-secret-recovery-recover-copy.png)
183+
184+
</Tab>
185+
129186
<Tab heading="CLI" group="cli">
130187

131188
@include 'sysadmin/snapshots/secret-restore/recover/cli.mdx'
@@ -146,6 +203,16 @@ storage.
146203

147204
<Tabs>
148205

206+
<Tab heading="Web UI" group="ui">
207+
<Tip title="Permissions Required">
208+
This requires recover permissions specific to the resource.
209+
</Tip>
210+
211+
Upon a successful recovery operation, a success message with a link to the recovered resource will be shown.
212+
![Snapshot recovery operation](/img/ui-secret-recovery-recover-message.png)
213+
214+
</Tab>
215+
149216
<Tab heading="CLI" group="cli">
150217

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

0 commit comments

Comments
 (0)