Browse Source

[Manila Unity/VNX] add 'snapshot support' related Doc for Unity/VNX driver

Change-Id: I76c8b31c890e5f8d7beeddc6b8ab1a3a0731bcfb
dingd 5 months ago
parent
commit
734ffeac85
2 changed files with 97 additions and 0 deletions
  1. 48
    0
      doc/source/admin/emc_unity_driver.rst
  2. 49
    0
      doc/source/admin/emc_vnx_driver.rst

+ 48
- 0
doc/source/admin/emc_unity_driver.rst View File

@@ -163,6 +163,54 @@ settings of Unity GUI for Unity and specify the address in `/etc/manila/manila.c
163 163
 
164 164
     emc_nas_server = <IPv6 address>
165 165
 
166
+Snapshot support
167
+----------------
168
+
169
+In the Mitaka and Newton release of OpenStack, Snapshot support is enabled by default for a newly created share type.
170
+Starting with the Ocata release, the snapshot_support extra spec must be set to True in order to allow snapshots for
171
+a share type. If the 'snapshot_support' extra_spec is omitted or if it is set to False, users would not be able to
172
+create snapshots on shares of this share type. The feature is divided into two parts:
173
+
174
+1. The driver is able to create/delete snapshot of share.
175
+2. The driver is able to create share from snapshot.
176
+
177
+Pre-Configurations for Snapshot support
178
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
179
+
180
+The following extra specifications need to be configured with share type.
181
+
182
+- snapshot_support = True
183
+- create_share_from_snapshot_support = True
184
+
185
+For new share type, these extra specifications can be set directly when creating share type:
186
+
187
+.. code-block:: console
188
+
189
+    manila type-create --snapshot_support True --create_share_from_snapshot_support True ${share_type_name} True
190
+
191
+Or you can update already existing share type with command:
192
+
193
+.. code-block:: console
194
+
195
+    manila type-key ${share_type_name} set snapshot_support=True
196
+    manila type-key ${share_type_name} set create_share_from_snapshot_support=True
197
+
198
+To snapshot a share and create share from the snapshot
199
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
200
+
201
+Firstly, you need create a share from share type that has extra specifications(snapshot_support=True, create_share_from_snapshot_support=True).
202
+Then snapshot the share with command:
203
+
204
+.. code-block:: console
205
+
206
+    manila snapshot-create ${source_share_name} --name ${target_snapshot_name} --description " "
207
+
208
+After creating the snapshot from previous step, you can create share from that snapshot.
209
+Use command:
210
+
211
+.. code-block:: console
212
+
213
+    manila create nfs 1 --name ${target_share_name} --metadata source=snapshot --description " " --snapshot-id ${source_snapshot_id}
166 214
 
167 215
 Restrictions
168 216
 ------------

+ 49
- 0
doc/source/admin/emc_vnx_driver.rst View File

@@ -235,6 +235,55 @@ by `nas_cs` command for VNX and specify the address in `/etc/manila/manila.conf`
235 235
 
236 236
     emc_nas_server = <IPv6 address>
237 237
 
238
+Snapshot support
239
+----------------
240
+
241
+In the Mitaka and Newton release of OpenStack, Snapshot support is enabled by default for a newly created share type.
242
+Starting with the Ocata release, the snapshot_support extra spec must be set to True in order to allow snapshots for
243
+a share type. If the 'snapshot_support' extra_spec is omitted or if it is set to False, users would not be able to
244
+create snapshots on shares of this share type. The feature is divided into two parts:
245
+
246
+1. The driver is able to create/delete snapshot of share.
247
+2. The driver is able to create share from snapshot.
248
+
249
+Pre-Configurations for Snapshot support
250
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
251
+
252
+The following extra specifications need to be configured with share type.
253
+
254
+- snapshot_support = True
255
+- create_share_from_snapshot_support = True
256
+
257
+For new share type, these extra specifications can be set directly when creating share type:
258
+
259
+.. code-block:: console
260
+
261
+    manila type-create --snapshot_support True --create_share_from_snapshot_support True ${share_type_name} True
262
+
263
+Or you can update already existing share type with command:
264
+
265
+.. code-block:: console
266
+
267
+    manila type-key ${share_type_name} set snapshot_support=True
268
+    manila type-key ${share_type_name} set create_share_from_snapshot_support=True
269
+
270
+To snapshot a share and create share from the snapshot
271
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
272
+
273
+Firstly, you need create a share from share type that has extra specifications(snapshot_support=True, create_share_from_snapshot_support=True).
274
+Then snapshot the share with command:
275
+
276
+.. code-block:: console
277
+
278
+    manila snapshot-create ${source_share_name} --name ${target_snapshot_name} --description " "
279
+
280
+After creating the snapshot from previous step, you can create share from that snapshot.
281
+Use command:
282
+
283
+.. code-block:: console
284
+
285
+    manila create nfs 1 --name ${target_share_name} --metadata source=snapshot --description " " --snapshot-id ${source_snapshot_id}
286
+
238 287
 Restrictions
239 288
 ------------
240 289
 

Loading…
Cancel
Save