summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordingd <dong.ding@dell.com>2018-12-19 15:57:12 +0800
committerdingd <dong.ding@dell.com>2018-12-24 10:07:58 +0800
commit734ffeac8528250bba362de0a844319d11811287 (patch)
tree2e19c9a6669b7e7ef897a749029f9f661e4396db
parent4f22d0b19e782800b06deba74e6ec15708e5db33 (diff)
[Manila Unity/VNX] add 'snapshot support' related Doc for Unity/VNX driver
Notes
Notes (review): Code-Review+2: Tom Barron <tpb@dyncloud.net> Code-Review+2: Rodrigo Barbieri <rodrigo.barbieri2010@gmail.com> Workflow+1: Rodrigo Barbieri <rodrigo.barbieri2010@gmail.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Thu, 27 Dec 2018 12:38:55 +0000 Reviewed-on: https://review.openstack.org/626111 Project: openstack/manila Branch: refs/heads/master
-rw-r--r--doc/source/admin/emc_unity_driver.rst48
-rw-r--r--doc/source/admin/emc_vnx_driver.rst49
2 files changed, 97 insertions, 0 deletions
diff --git a/doc/source/admin/emc_unity_driver.rst b/doc/source/admin/emc_unity_driver.rst
index 92a3c13..7b2d40f 100644
--- a/doc/source/admin/emc_unity_driver.rst
+++ b/doc/source/admin/emc_unity_driver.rst
@@ -163,6 +163,54 @@ settings of Unity GUI for Unity and specify the address in `/etc/manila/manila.c
163 163
164 emc_nas_server = <IPv6 address> 164 emc_nas_server = <IPv6 address>
165 165
166Snapshot support
167----------------
168
169In the Mitaka and Newton release of OpenStack, Snapshot support is enabled by default for a newly created share type.
170Starting with the Ocata release, the snapshot_support extra spec must be set to True in order to allow snapshots for
171a share type. If the 'snapshot_support' extra_spec is omitted or if it is set to False, users would not be able to
172create snapshots on shares of this share type. The feature is divided into two parts:
173
1741. The driver is able to create/delete snapshot of share.
1752. The driver is able to create share from snapshot.
176
177Pre-Configurations for Snapshot support
178~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
179
180The following extra specifications need to be configured with share type.
181
182- snapshot_support = True
183- create_share_from_snapshot_support = True
184
185For 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
191Or 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
198To snapshot a share and create share from the snapshot
199~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
200
201Firstly, you need create a share from share type that has extra specifications(snapshot_support=True, create_share_from_snapshot_support=True).
202Then snapshot the share with command:
203
204.. code-block:: console
205
206 manila snapshot-create ${source_share_name} --name ${target_snapshot_name} --description " "
207
208After creating the snapshot from previous step, you can create share from that snapshot.
209Use 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
167Restrictions 215Restrictions
168------------ 216------------
diff --git a/doc/source/admin/emc_vnx_driver.rst b/doc/source/admin/emc_vnx_driver.rst
index d75ede3..82bdbf4 100644
--- a/doc/source/admin/emc_vnx_driver.rst
+++ b/doc/source/admin/emc_vnx_driver.rst
@@ -235,6 +235,55 @@ by `nas_cs` command for VNX and specify the address in `/etc/manila/manila.conf`
235 235
236 emc_nas_server = <IPv6 address> 236 emc_nas_server = <IPv6 address>
237 237
238Snapshot support
239----------------
240
241In the Mitaka and Newton release of OpenStack, Snapshot support is enabled by default for a newly created share type.
242Starting with the Ocata release, the snapshot_support extra spec must be set to True in order to allow snapshots for
243a share type. If the 'snapshot_support' extra_spec is omitted or if it is set to False, users would not be able to
244create snapshots on shares of this share type. The feature is divided into two parts:
245
2461. The driver is able to create/delete snapshot of share.
2472. The driver is able to create share from snapshot.
248
249Pre-Configurations for Snapshot support
250~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
251
252The following extra specifications need to be configured with share type.
253
254- snapshot_support = True
255- create_share_from_snapshot_support = True
256
257For 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
263Or 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
270To snapshot a share and create share from the snapshot
271~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
272
273Firstly, you need create a share from share type that has extra specifications(snapshot_support=True, create_share_from_snapshot_support=True).
274Then snapshot the share with command:
275
276.. code-block:: console
277
278 manila snapshot-create ${source_share_name} --name ${target_snapshot_name} --description " "
279
280After creating the snapshot from previous step, you can create share from that snapshot.
281Use 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
238Restrictions 287Restrictions
239------------ 288------------
240 289