Skip to content

Commit cfcb6e1

Browse files
committed
move content to partial and active voice rewrites
1 parent de0854d commit cfcb6e1

File tree

6 files changed

+53
-102
lines changed

6 files changed

+53
-102
lines changed

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

Lines changed: 8 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -36,34 +36,9 @@ Load the snapshot holding the secret you want to recover:
3636

3737
<Tabs>
3838

39-
<Tab heading="Web UI" group="ui">
39+
<Tab heading="GUI" group="gui">
4040

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)
41+
@include 'sysadmin/snapshots/load-snapshot/gui/gui.mdx'
6742

6843
</Tab>
6944

@@ -135,12 +110,9 @@ You can check for a loaded snapshot by listing the loaded snapshots:
135110

136111
<Tabs>
137112

138-
<Tab heading="Web UI" group="ui">
113+
<Tab heading="GUI" group="gui">
139114

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)
115+
@include 'sysadmin/snapshots/list-snapshots/gui.mdx'
144116

145117
</Tab>
146118

@@ -170,20 +142,9 @@ storage.
170142

171143
<Tabs>
172144

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)
145+
<Tab heading="GUI" group="gui">
180146

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)
147+
@include 'sysadmin/snapshots/secret-restore/recover/gui.mdx'
187148

188149
</Tab>
189150

@@ -207,13 +168,9 @@ storage.
207168

208169
<Tabs>
209170

210-
<Tab heading="Web UI" group="ui">
211-
<Tip title="Permissions Required">
212-
This requires recover permissions specific to the resource.
213-
</Tip>
171+
<Tab heading="GUI" group="gui">
214172

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)
173+
@include 'sysadmin/snapshots/secret-restore/verify/gui.mdx'
217174

218175
</Tab>
219176

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

Lines changed: 8 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -31,34 +31,9 @@ Load the snapshot holding the secret you want to recover.
3131

3232
<Tabs>
3333

34-
<Tab heading="Web UI" group="ui">
34+
<Tab heading="GUI" group="gui">
3535

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)
36+
@include 'sysadmin/snapshots/load-snapshot/gui/gui.mdx'
6237

6338
</Tab>
6439

@@ -131,12 +106,9 @@ You can check for a loaded snapshot by listing the loaded snapshots:
131106

132107
<Tabs>
133108

134-
<Tab heading="Web UI" group="ui">
135-
136-
1. Select **Secrets Recovery** from the left navigation menu.
109+
<Tab heading="GUI" group="gui">
137110

138-
2. If a snapshot has been loaded, it will appear here.
139-
![Loaded snapshot card emphasized](/img/ui-secret-recovery-loaded-snapshot.png)
111+
@include 'sysadmin/snapshots/list-snapshots/gui.mdx'
140112

141113
</Tab>
142114

@@ -166,20 +138,9 @@ storage.
166138

167139
<Tabs>
168140

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>
141+
<Tab heading="GUI" group="gui">
173142

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)
143+
@include 'sysadmin/snapshots/secret-restore/recover/gui.mdx'
183144

184145
</Tab>
185146

@@ -203,13 +164,9 @@ storage.
203164

204165
<Tabs>
205166

206-
<Tab heading="Web UI" group="ui">
207-
<Tip title="Permissions Required">
208-
This requires recover permissions specific to the resource.
209-
</Tip>
167+
<Tab heading="GUI" group="gui">
210168

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)
169+
@include 'sysadmin/snapshots/secret-restore/verify/gui.mdx'
213170

214171
</Tab>
215172

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: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
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+
![Load snapshot button location emphasized](/img/ui-secret-recovery-upload.png)
12+
13+
1. Select your upload method. To use an automated snapshot you must provide an
14+
[automated snapshot config](/vault/api-docs/system/storage/raftautosnapshots#load-a-snapshot-from-an-automated-snapshot-configuration).
15+
![Load snapshot form](/img/ui-secret-recovery-upload-form.png)
16+
17+
1. Click **Load snapshot** to complete the upload.
18+
19+
1. Monitor the upload until the status says "Ready" and the expiration date
20+
populates.
21+
![Snapshot overview card with status and details link emphasized](/img/ui-secret-recovery-overview-details.png)
22+
23+
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)

0 commit comments

Comments
 (0)