From 8f9e74f3c0d54c147b8fb37992d60ab202cad4f8 Mon Sep 17 00:00:00 2001 From: Carlos da Silva Date: Fri, 28 Mar 2025 15:25:40 -0300 Subject: [PATCH] Add mount snapshot support to user guide Adds the user documentation to the mount snapshot feature, detailing how to create and delete access, as well as necessary information for the feature. Closes-Bug: #1659148 Change-Id: I61902030efa9ba48be7d911039eb911ce512635a --- doc/source/user/create-and-manage-shares.rst | 43 ++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/doc/source/user/create-and-manage-shares.rst b/doc/source/user/create-and-manage-shares.rst index 2e80774a92..542ac8db46 100644 --- a/doc/source/user/create-and-manage-shares.rst +++ b/doc/source/user/create-and-manage-shares.rst @@ -724,6 +724,49 @@ Create snapshot | 7861eed0-8634-41e0-a57e-a1d87ad48a1b | mysnap | +--------------------------------------+--------+ + +Mount a snapshot +---------------- + +* Allow access to the snapshot. + + .. note:: + + To mount a snapshot, the share type of the parent share must contain the + capability extra-spec ``mount_snapshot_support=True``. + + .. code-block:: console + + $ openstack share snapshot access create mysnap ip 192.168.1.0/24 + +-------------+--------------------------------------+ + | Field | Value | + +-------------+--------------------------------------+ + | id | 89e36a97-19d8-430c-b920-6d930ea27464 | + | access_type | ip | + | access_to | 192.168.1.0/24 | + | state | queued_to_apply | + +-------------+--------------------------------------+ + +* List snapshot access. + + .. code-block:: console + + $ openstack share snapshot access list mysnap + +--------------------------------------+-------------+----------------+--------+ + | ID | Access Type | Access To | State | + +--------------------------------------+-------------+----------------+--------+ + | 89e36a97-19d8-430c-b920-6d930ea27464 | ip | 192.168.1.0/24 | active | + +--------------------------------------+-------------+----------------+--------+ + +Then proceed to mounting the snapshot on the clients whose access was created. + +* Delete snapshot access rule. + + .. code-block:: console + + $ openstack share snapshot access delete mysnap 89e36a97-19d8-430c-b920-6d930ea27464 + + Create share from snapshot --------------------------