From 6bc9b90cab18baa32cc2ead8efc2c30aca2bbe52 Mon Sep 17 00:00:00 2001
From: Helen Walsh <helen.walsh@emc.com>
Date: Mon, 11 Mar 2019 17:12:44 +0000
Subject: [PATCH] Manila VMAX docs -  clarify snapshot support

As snapshot support is disabled by default, this clarifies how to enable
it for both create snapshot of share and create share from snapshot.

Change-Id: I40a7b8c72b8ce67689c6b9a769cdb3399a3c6242
---
 .../drivers/dell-emc-vmax-driver.rst          | 43 +++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/doc/source/configuration/shared-file-systems/drivers/dell-emc-vmax-driver.rst b/doc/source/configuration/shared-file-systems/drivers/dell-emc-vmax-driver.rst
index c9b04a6889..3127da4492 100644
--- a/doc/source/configuration/shared-file-systems/drivers/dell-emc-vmax-driver.rst
+++ b/doc/source/configuration/shared-file-systems/drivers/dell-emc-vmax-driver.rst
@@ -341,6 +341,49 @@ SSL Support
 #. Restart manila services.
 
 
+Snapshot Support
+~~~~~~~~~~~~~~~~
+
+Snapshot support is disabled by default, so in order to allow shapshots for a
+share type, the ``snapshot_support`` extra spec must be set to True.
+Creating a share from a snapshot is also disabled by default so
+``create_share_from_snapshot_support`` must also be set to True if this
+functionality is required.
+
+For a new share type:
+
+.. code-block:: console
+
+   $ manila type-create --snapshot_support True \
+                        --create_share_from_snapshot_support True \
+                        ${share_type_name} True
+
+For an existing share type:
+
+.. code-block:: console
+
+   $ manila type-key ${share_type_name} \
+                     set snapshot_support=True
+   $ manila type-key ${share_type_name} \
+                     set create_share_from_snapshot_support=True
+
+To create a snapshot from a share where snapshot_support=True:
+
+.. code-block:: console
+
+   $ manila snapshot-create ${source_share_name} --name ${target_snapshot_name}
+
+To create a target share from a shapshot where create_share_from_snapshot_support=True:
+
+.. code-block:: console
+
+   $ manila create cifs 3 --name ${target_share_name} \
+                          --share-network ${share_network} \
+                          --share-type ${share_type_name} \
+                          --metadata source=snapshot \
+                          --snapshot-id ${snapshot_id}
+
+
 IPv6 support
 ~~~~~~~~~~~~
 IPv6 support for VMAX Manila driver is introduced in Rocky release. The feature is