61c744c2c5
After the technical review the Shared File Systems service documentation in the Cloud Admin Guide needs to be updated. Read and fixed some typos and incorrect English constructions in the sentences of all sections. Fixed indentations in code, tip and note directives. Also updated the following info: * Removed references to the Generic driver, because it is default only on Devstack. And even for Devstack the default driver is going to be changed. * Divided 'Create share' subsection on 3 subsections: added general concepts and info of creating a share in 2 back end modes. * Added info that with StandaloneNetworkPlugin the Shared File Systems service can be configured without Networking and Compute services. * Added export paths for GlusterFS and HDFS. * Added notes what driver in what mode you use in examples and a noted what modes exist and can be configured. * Added a console sample for "manila rate-limits" command and described how to add API rate limits. * Removed information and samples about a quota classes because they are not used in the Shared File Systems service and are not working properly for the current moment (in Liberty release). * Added second purpose of the share types. * Removed '/etc/manila/' in manila.conf file, because its path can be customly changed. * Said that consistency groups is the experimental part of API starting with Liberty release. * Updated a sample in shared_file_systems_multi_backend.html file. * Removed 'Storage' from the Shared File Systems service official name according to [1] document. [1] http://git.openstack.org/cgit/openstack/governance/tree/reference/projects.yaml Change-Id: I0530ea3c6bf74311e271cdabca26cd10afcddc92 Closes-Bug: #1508457
137 lines
7.4 KiB
ReStructuredText
137 lines
7.4 KiB
ReStructuredText
.. _shared_file_systems_snapshots:
|
|
|
|
===============
|
|
Share snapshots
|
|
===============
|
|
|
|
The Shared File Systems service provides a snapshot mechanism to help users
|
|
restore data by running the `manila snapshot-create` command.
|
|
|
|
To export a snapshot, you can create shares from it, then mount new share to
|
|
instance and then directly copy files from attached share into archive.
|
|
|
|
To import a snapshot, create a new share with appropriate size, attach it to
|
|
instance and then copy file from archive to attached file system.
|
|
|
|
.. note::
|
|
You cannot delete a share while it has saved dependent snapshots.
|
|
|
|
Create a snapshot from the share:
|
|
|
|
.. code:: console
|
|
|
|
$ manila snapshot-create Share1 --name Snapshot1 --description "Snapshot of Share1"
|
|
+-------------+--------------------------------------+
|
|
| Property | Value |
|
|
+-------------+--------------------------------------+
|
|
| status | creating |
|
|
| share_id | aca648eb-8c03-4394-a5cc-755066b7eb66 |
|
|
| name | Snapshot1 |
|
|
| created_at | 2015-09-25T05:27:38.862040 |
|
|
| share_proto | NFS |
|
|
| id | 962e8126-35c3-47bb-8c00-f0ee37f42ddd |
|
|
| size | 1 |
|
|
| share_size | 1 |
|
|
| description | Snapshot of Share1 |
|
|
+-------------+--------------------------------------+
|
|
|
|
Update name or description of a snapshot if it is needed:
|
|
|
|
.. code:: console
|
|
|
|
$ manila snapshot-rename Snapshot1 Snapshot_1 --description "Snapshot of Share1. Updated."
|
|
|
|
Check that status of a snapshot is ``available``:
|
|
|
|
.. code:: console
|
|
|
|
$ manila snapshot-show Snapshot1
|
|
+-------------+--------------------------------------+
|
|
| Property | Value |
|
|
+-------------+--------------------------------------+
|
|
| status | available |
|
|
| share_id | aca648eb-8c03-4394-a5cc-755066b7eb66 |
|
|
| name | Snapshot1 |
|
|
| created_at | 2015-09-25T05:27:38.000000 |
|
|
| share_proto | NFS |
|
|
| id | 962e8126-35c3-47bb-8c00-f0ee37f42ddd |
|
|
| size | 1 |
|
|
| share_size | 1 |
|
|
| description | Snapshot of Share1 |
|
|
+-------------+--------------------------------------+
|
|
|
|
To restore your data from snapshot, use :command:`manila create` with key
|
|
``--snapshot-id``. This creates a new share from exiting snapshot.
|
|
Create a share from a snapshot and check whether it is available:
|
|
|
|
.. code:: console
|
|
|
|
$ manila create nfs 1 --name Share2 --metadata source=snapshot --description "Share from a snapshot." --snapshot-id 962e8126-35c3-47bb-8c00-f0ee37f42ddd
|
|
+-----------------------------+--------------------------------------+
|
|
| Property | Value |
|
|
+-----------------------------+--------------------------------------+
|
|
| status | None |
|
|
| share_type_name | default |
|
|
| description | Share from a snapshot. |
|
|
| availability_zone | None |
|
|
| share_network_id | None |
|
|
| export_locations | [] |
|
|
| share_server_id | None |
|
|
| host | None |
|
|
| snapshot_id | 962e8126-35c3-47bb-8c00-f0ee37f42ddd |
|
|
| is_public | False |
|
|
| task_state | None |
|
|
| snapshot_support | True |
|
|
| id | b6b0617c-ea51-4450-848e-e7cff69238c7 |
|
|
| size | 1 |
|
|
| name | Share2 |
|
|
| share_type | c0086582-30a6-4060-b096-a42ec9d66b86 |
|
|
| created_at | 2015-09-25T06:25:50.240417 |
|
|
| export_location | None |
|
|
| share_proto | NFS |
|
|
| consistency_group_id | None |
|
|
| source_cgsnapshot_member_id | None |
|
|
| project_id | 20787a7ba11946adad976463b57d8a2f |
|
|
| metadata | {u'source': u'snapshot'} |
|
|
+-----------------------------+--------------------------------------+
|
|
|
|
$ manila show Share2
|
|
+-----------------------------+-------------------------------------------+
|
|
| Property | Value |
|
|
+-----------------------------+-------------------------------------------+
|
|
| status | available |
|
|
| share_type_name | default |
|
|
| description | Share from a snapshot. |
|
|
| availability_zone | nova |
|
|
| share_network_id | 5c3cbabb-f4da-465f-bc7f-fadbe047b85a |
|
|
| export_locations | 10.254.0.3:/shares/share-1dc2a471-3d47-...|
|
|
| share_server_id | 41b7829d-7f6b-4c96-aea5-d106c2959961 |
|
|
| host | manila@generic1#GENERIC1 |
|
|
| snapshot_id | 962e8126-35c3-47bb-8c00-f0ee37f42ddd |
|
|
| is_public | False |
|
|
| task_state | None |
|
|
| snapshot_support | True |
|
|
| id | b6b0617c-ea51-4450-848e-e7cff69238c7 |
|
|
| size | 1 |
|
|
| name | Share2 |
|
|
| share_type | c0086582-30a6-4060-b096-a42ec9d66b86 |
|
|
| created_at | 2015-09-25T06:25:50.000000 |
|
|
| share_proto | NFS |
|
|
| consistency_group_id | None |
|
|
| source_cgsnapshot_member_id | None |
|
|
| project_id | 20787a7ba11946adad976463b57d8a2f |
|
|
| metadata | {u'source': u'snapshot'} |
|
|
+-----------------------------+-------------------------------------------+
|
|
|
|
You can soft-delete a snapshot using **manila snapshot-delete
|
|
<snapshot_name_or_ID>**. If a snapshot is in busy state and during deleting
|
|
got the ``error_deleting`` status, administrator can force-delete it or
|
|
explicitly reset the state.
|
|
Use **snapshot-reset-state [--state <state>] <snapshot>** to update the state
|
|
of a snapshot explicitly. A valid value of a status are ``available``,
|
|
``error``, ``creating``, ``deleting``, ``error_deleting``. If no state is
|
|
provided, available will be used.
|
|
|
|
Use **manila snapshot-force-delete <snapshot>** to force-delete a specified
|
|
share snapshot in any state.
|