From 6b8f416e1b20b82617ecd4feff9cbc1c5d914c25 Mon Sep 17 00:00:00 2001 From: Douglas Viroel Date: Tue, 12 May 2020 19:12:30 +0000 Subject: [PATCH] Update docs for create share from snapshot in another back end This patch add some notes regarding the use of scheduler when creating share from snapshot in another pool or backend. Change-Id: I8d904cb3aab4d653178948284571f471bd59ac1b Closes-Bug: #1878244 --- ...hare_back_ends_feature_support_mapping.rst | 128 +++++++++--------- .../admin/shared-file-systems-snapshots.rst | 31 ++++- 2 files changed, 94 insertions(+), 65 deletions(-) diff --git a/doc/source/admin/share_back_ends_feature_support_mapping.rst b/doc/source/admin/share_back_ends_feature_support_mapping.rst index a2078b2b95..579ea0b43c 100644 --- a/doc/source/admin/share_back_ends_feature_support_mapping.rst +++ b/doc/source/admin/share_back_ends_feature_support_mapping.rst @@ -14,6 +14,8 @@ License for the specific language governing permissions and limitations under the License. +.. _share_back_ends_feature_support_mapping: + Manila share features support mapping ===================================== @@ -30,69 +32,69 @@ Column value "-" means that this feature is not currently supported. Mapping of share drivers and share features support --------------------------------------------------- -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| Driver name | create delete share | manage unmanage share | extend share | shrink share | create delete snapshot | create share from snapshot | manage unmanage snapshot | revert to snapshot | mountable snapshot | -+========================================+=======================+=======================+==========================+==========================+========================+============================+==========================+====================+====================+ -| ZFSonLinux | M | N | M | M | M | M | N | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| Container | N | \- | N | \- | \- | \- | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| Generic (Cinder as back-end) | J | K | L | L | J | J | M | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| NetApp Clustered Data ONTAP | J | L | L | L | J | J | N | O | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| EMC VMAX | O | \- | O | \- | O | O | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| EMC VNX | J | \- | \- | \- | J | J | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| EMC Unity | N | U | N | S | N | N | U | S | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| EMC Isilon | K | \- | M | \- | K | K | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| GlusterFS | J | \- | directory layout (T) | directory layout (T) | volume layout (L) | volume layout (L) | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| GlusterFS-Native | J | \- | \- | \- | K | L | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| HDFS | K | \- | M | \- | K | K | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| Hitachi HNAS | L | L | L | M | L | L | O | O | O | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| Hitachi HSP | N | N | N | N | \- | \- | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| HPE 3PAR | K | \- | \- | \- | K | K | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| Huawei | K | L | L | L | K | M | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| IBM GPFS | K | O | L | \- | K | K | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| INFINIDAT | Q | \- | Q | \- | Q | Q | \- | Q | Q | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| INSPUR AS13000 | R | \- | R | \- | R | R | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| INSPUR InStorage | T | \- | T | \- | \- | \- | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| Infortrend | T | T | T | T | \- | \- | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| LVM | M | \- | M | \- | M | M | \- | O | O | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| Quobyte | K | \- | M | M | \- | \- | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| Windows SMB | L | L | L | L | L | L | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| Oracle ZFSSA | K | N | M | M | K | K | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| CephFS | M | \- | M | M | M | \- | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| Tegile | M | \- | M | M | M | M | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| NexentaStor4 | N | \- | N | \- | N | N | \- | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| NexentaStor5 | N | T | N | N | N | N | \- | T | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| MapRFS | O | O | O | O | O | O | O | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ -| QNAP | O | O | O | \- | O | O | O | \- | \- | -+----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+----------------------------+--------------------------+--------------------+--------------------+ ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| Driver name | create delete share | manage unmanage share | extend share | shrink share | create delete snapshot | create share from snapshot | manage unmanage snapshot | revert to snapshot | mountable snapshot | ++========================================+=======================+=======================+==========================+==========================+========================+===================================+==========================+====================+====================+ +| ZFSonLinux | M | N | M | M | M | M | N | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| Container | N | \- | N | \- | \- | \- | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| Generic (Cinder as back-end) | J | K | L | L | J | J | M | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| NetApp Clustered Data ONTAP | J | L | L | L | J |same pool (J), across back ends (U)| N | O | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| EMC VMAX | O | \- | O | \- | O | O | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| EMC VNX | J | \- | \- | \- | J | J | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| EMC Unity | N | U | N | S | N | N | U | S | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| EMC Isilon | K | \- | M | \- | K | K | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| GlusterFS | J | \- | directory layout (T) | directory layout (T) | volume layout (L) | volume layout (L) | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| GlusterFS-Native | J | \- | \- | \- | K | L | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| HDFS | K | \- | M | \- | K | K | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| Hitachi HNAS | L | L | L | M | L | L | O | O | O | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| Hitachi HSP | N | N | N | N | \- | \- | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| HPE 3PAR | K | \- | \- | \- | K | K | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| Huawei | K | L | L | L | K | M | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| IBM GPFS | K | O | L | \- | K | K | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| INFINIDAT | Q | \- | Q | \- | Q | Q | \- | Q | Q | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| INSPUR AS13000 | R | \- | R | \- | R | R | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| INSPUR InStorage | T | \- | T | \- | \- | \- | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| Infortrend | T | T | T | T | \- | \- | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| LVM | M | \- | M | \- | M | M | \- | O | O | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| Quobyte | K | \- | M | M | \- | \- | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| Windows SMB | L | L | L | L | L | L | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| Oracle ZFSSA | K | N | M | M | K | K | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| CephFS | M | \- | M | M | M | \- | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| Tegile | M | \- | M | M | M | M | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| NexentaStor4 | N | \- | N | \- | N | N | \- | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| NexentaStor5 | N | T | N | N | N | N | \- | T | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| MapRFS | O | O | O | O | O | O | O | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ +| QNAP | O | O | O | \- | O | O | O | \- | \- | ++----------------------------------------+-----------------------+-----------------------+--------------------------+--------------------------+------------------------+-----------------------------------+--------------------------+--------------------+--------------------+ Mapping of share drivers and share access rules support ------------------------------------------------------- diff --git a/doc/source/admin/shared-file-systems-snapshots.rst b/doc/source/admin/shared-file-systems-snapshots.rst index f64e88e690..533873b71d 100644 --- a/doc/source/admin/shared-file-systems-snapshots.rst +++ b/doc/source/admin/shared-file-systems-snapshots.rst @@ -68,8 +68,8 @@ Check that status of a snapshot is ``available``: To create a copy of your data from a snapshot, use :command:`manila create` with key ``--snapshot-id``. This creates a new share from an -existing snapshot. Create a share from a snapshot and check whether -it is available: +existing snapshot. Create a share from a snapshot and check whether it is +available: .. code-block:: console @@ -128,6 +128,33 @@ it is available: | metadata | {u'source': u'snapshot'} | +-----------------------------+-------------------------------------------+ +By default, the Shared File Systems service will place the new share in the +source share's pool, unless a different destination availability zone is +provided by the user, using the key ``--availability-zone``. + +Starting from Ussuri release, a new filter and weigher were added to the +scheduler to enhance the selection of a destination pool when creating shares +from snapshot. Drivers that support creating shares from snapshots across back +ends also need the back end configuration option ``replication_domain`` to be +specified. This option can be an arbitrary string. As an administrator, you are +expected to determine which back ends are compatible to copy data between each +other. Once you have identified these back ends, configure +``replication_domain`` in their respective configuration sections to the same +string. Refer to the +:ref:`feature support mapping ` +for identifying which back ends support this feature. The use of scheduler when +creating share from a snapshot must be enabled using the configuration flag +``[DEFAULT]/use_scheduler_creating_share_from_snapshot``. This option is +disabled by default. + +.. note:: + + When combining both ``--snapshot-id`` and ``--availability-zone`` keys, + you'll need to make sure that the configuration flag + ``[DEFAULT]/use_scheduler_creating_share_from_snapshot`` is enabled, or the + operation will be denied when source and destination availability zones are + different. + You can soft-delete a snapshot using :command:`manila snapshot-delete `. If a snapshot is in busy state, and during the delete an ``error_deleting`` status appeared, administrator can