openstack
/
openstack-manuals
Code Issues Proposed changes

Add doc for manage unmanage share snapshot 

This patch adds doc for managing and unmanaging share snapshot
in manila.

Change-Id: Iddfa2d4bd713fa3e88809f73ca5efd5ede93feba
Closes-Bug: #1550868
This commit is contained in:
xing-yang 2016-07-25 01:03:30 -04:00
parent b52a302144
commit 5610d8e8e7
2 changed files with 107 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

106
doc/admin-guide/source/shared-file-systems-manage-and-unmanage-snapshot.rst Normal file
View File

@ -0,0 +1,106 @@
.. _shared_file_systems_manage_and_unmanage_snapshot:
==================================
Manage and unmanage share snapshot
==================================
To ``manage`` a share snapshot means that an administrator, rather than a
share driver, manages the storage lifecycle. This approach is appropriate
when an administrator manages share snapshots outside of the Shared File
Systems service and wants to register it with the service.
To ``unmanage`` a share snapshot means to unregister a specified share
snapshot from the Shared File Systems service. Administrators can revert an
unmanaged share snapshot to managed status if needed.
.. _unmanage_share_snapshot:
Unmanage a share snapshot
-------------------------
The ``unmanage`` operation is not supported for shares that were
created on top of share servers and created with share networks.
The Share service should have the option
``driver_handles_share_servers = False`` set in the ``manila.conf`` file.
To unmanage managed share snapshot, run the :command:
`manila snapshot-unmanage <share_snapshot>` command. Then try to print the
information about the share snapshot. The returned result should indicate that
Shared File Systems service won't find the share snapshot:
.. code-block:: console
$ manila snapshot-unmanage my_test_share_snapshot
$ manila snapshot-show my_test_share_snapshot
ERROR: No sharesnapshot with a name or ID of 'my_test_share_snapshot'
exists.
.. _manage_share_snapshot:
Manage a share snapshot
-----------------------
To register the non-managed share snapshot in the File System service, run the
:command:`manila snapshot-manage` command:
.. code-block:: console
manila snapshot-manage [--name <name>] [--description <description>]
[--driver_options [<key=value> [<key=value> ...]]]
<share> <provider_location>
The positional arguments are:
- share. Name or ID of the share.
- provider_location. Provider location of the share snapshot on the backend.
The ``driver_options`` is an optional set of one or more key and value pairs
that describe driver options.
To manage share snapshot, run:
.. code-block:: console
$ manila snapshot-manage \
9ba52cc6-c97e-4b40-8653-4bcbaaf9628d \
4d1e2863-33dd-4243-bf39-f7354752097d \
--name my_test_share_snapshot \
--description "My test share snapshot" \
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
| status | manage_starting |
| share_id | 9ba52cc6-c97e-4b40-8653-4bcbaaf9628d |
| user_id | d9f4003655c94db5b16c591920be1f91 |
| description | My test share snapshot |
| created_at | 2016-07-25T04:49:42.600980 |
| size | None |
| share_proto | NFS |
| provider_location | 4d1e2863-33dd-4243-bf39-f7354752097d |
| id | 89c663b5-026d-45c7-a43b-56ef0ba0faab |
| project_id | aaa33a0ca4324965a3e65ae47e864e94 |
| share_size | 1 |
| name | my_test_share_snapshot |
+-------------------+--------------------------------------+
Check that the share snapshot is available:
.. code-block:: console
$ manila snapshot-show my_test_share_snapshot
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
| status | available |
| share_id | 9ba52cc6-c97e-4b40-8653-4bcbaaf9628d |
| user_id | d9f4003655c94db5b16c591920be1f91 |
| description | My test share snapshot |
| created_at | 2016-07-25T04:49:42.000000 |
| size | 1 |
| share_proto | NFS |
| provider_location | 4d1e2863-33dd-4243-bf39-f7354752097d |
| id | 89c663b5-026d-45c7-a43b-56ef0ba0faab |
| project_id | aaa33a0ca4324965a3e65ae47e864e94 |
| share_size | 1 |
| name | my_test_share_snapshot |
+-------------------+--------------------------------------+

1
doc/admin-guide/source/shared-file-systems-share-management.rst
View File

@ -28,5 +28,6 @@ is the real purpose of the Shared File Systems service in production.
shared-file-systems-crud-share.rst
shared-file-systems-manage-and-unmanage-share.rst
shared-file-systems-manage-and-unmanage-snapshot.rst
shared-file-systems-share-resize.rst
shared-file-systems-quotas.rst