Updates the share extend and shrink documentation

The share extend and shrink documentation was still using the
manila client, so the examples were now updated to match the
command in OSC.

Closes-Bug: #2084559
Change-Id: Ic23e46b727f4673a6425cde7ed88b1219ed4a874
This commit is contained in:
Carlos Eduardo
2024-11-08 17:46:28 -03:00
parent 8f69ccbb2f
commit a0f3a36b10

View File

@@ -4,16 +4,15 @@
Resize share
============
To change file share size, use the :command:`manila extend` command and
the :command:`manila shrink` command. For most drivers it is safe
operation. If you want to be sure that your data is safe, you can make
a share back up by creating a snapshot of it.
For most drivers, resizing the share is safe operation. If you want to be sure
that your data is safe, you can make a share back up by creating a snapshot of
it.
You can extend and shrink the share with the :command:`manila extend` and
:command:`manila shrink` commands respectively, and specify the share
with the new size that does not exceed the quota. For details, see
:ref:`Quotas and Limits <shared_file_systems_quotas>`. You also cannot shrink
share size to 0 or to a greater value than the current share size.
You can extend and shrink the share with the :command:`openstack share resize`
command, and specify the share with the new size that does not exceed the
quota. For details, see :ref:`Quotas and Limits <shared_file_systems_quotas>`.
You also cannot shrink share size to 0 or to a greater value than the current
share size.
.. note::
From API version 2.53, extending a replicated share, manila quota system
@@ -30,46 +29,44 @@ To extend the share and check the result, run:
.. code-block:: console
$ manila extend docs_resize 2
$ manila show docs_resize
+----------------------+--------------------------------------------------------------------------+
| Property | Value |
+----------------------+--------------------------------------------------------------------------+
| status | available |
| share_type_name | my_type |
| description | None |
| availability_zone | nova |
| share_network_id | None |
| export_locations | |
| | path = 1.0.0.4:/shares/manila_share_b8afc508_8487_442b_b170_ea65b07074a8 |
| | preferred = False |
| | is_admin_only = False |
| | id = 3ffb76f4-92b9-4639-83fd-025bc3e302ff |
| | share_instance_id = b8afc508-8487-442b-b170-ea65b07074a8 |
| | path = 2.0.0.3:/shares/manila_share_b8afc508_8487_442b_b170_ea65b07074a8 |
| | preferred = False |
| | is_admin_only = True |
| | id = 1f0e263f-370d-47d3-95f6-1be64088b9da |
| | share_instance_id = b8afc508-8487-442b-b170-ea65b07074a8 |
| share_server_id | None |
| share_group_id | None |
| host | manila@paris#shares |
| access_rules_status | active |
| snapshot_id | None |
| is_public | False |
| task_state | None |
| snapshot_support | True |
| id | b07dbebe-a328-403c-b402-c8871c89e3d1 |
| size | 2 |
| name | docs_resize |
| share_type | 14ee8575-aac2-44af-8392-d9c9d344f392 |
| has_replicas | False |
| replication_type | None |
| created_at | 2016-03-25T15:33:18.000000 |
| share_proto | NFS |
| project_id | 907004508ef4447397ce6741a8f037c1 |
| metadata | {} |
+----------------------+--------------------------------------------------------------------------+
$ openstack share resize docs_resize 2
$ openstack share show docs_resize
+---------------------------------------+---------------------------------------+
| Property | Value |
+---------------------------------------+---------------------------------------+
| id | a3454cf1-bb1d-4e4d-a8e4-a3881c593720 |
| size | 2 |
| availability_zone | manila-zone-0 |
| created_at | 2024-09-26T14:53:18.153832 |
| status | extending |
| name | docs_resize |
| description | None |
| project_id | 1f31ee1c3e3c443bbf9aee5684456daa |
| snapshot_id | None |
| share_network_id | None |
| share_proto | NFS |
| metadata | {} |
| share_type | 303f0a73-711e-4beb-a4f7-a60acc1d588e |
| is_public | True |
| snapshot_support | True |
| task_state | None |
| share_type_name | default |
| access_rules_status | active |
| replication_type | None |
| has_replicas | False |
| user_id | b47d81c8c8c74ea3a7c13461f30ad5ed |
| create_share_from_snapshot_support | True |
| revert_to_snapshot_support | False |
| share_group_id | None |
| source_share_group_snapshot_member_id | None |
| mount_snapshot_support | False |
| progress | 100% |
| is_soft_deleted | False |
| scheduled_to_be_deleted_at | None |
| source_backup_id | None |
| share_server_id | None |
| host | host@backend1#poolA |
+---------------------------------------+---------------------------------------+
While shrinking, the share has a ``shrinking`` status. This means that the
decrease share size request was issued successfully. To shrink the share and
@@ -77,43 +74,41 @@ check the result, run:
.. code-block:: console
$ manila shrink docs_resize 1
$ manila show docs_resize
+----------------------+--------------------------------------------------------------------------+
| Property | Value |
+----------------------+--------------------------------------------------------------------------+
| status | available |
| share_type_name | my_type |
| description | None |
| availability_zone | nova |
| share_network_id | None |
| export_locations | |
| | path = 1.0.0.4:/shares/manila_share_b8afc508_8487_442b_b170_ea65b07074a8 |
| | preferred = False |
| | is_admin_only = False |
| | id = 3ffb76f4-92b9-4639-83fd-025bc3e302ff |
| | share_instance_id = b8afc508-8487-442b-b170-ea65b07074a8 |
| | path = 2.0.0.3:/shares/manila_share_b8afc508_8487_442b_b170_ea65b07074a8 |
| | preferred = False |
| | is_admin_only = True |
| | id = 1f0e263f-370d-47d3-95f6-1be64088b9da |
| | share_instance_id = b8afc508-8487-442b-b170-ea65b07074a8 |
| share_server_id | None |
| share_group_id | None |
| host | manila@paris#shares |
| access_rules_status | active |
| snapshot_id | None |
| is_public | False |
| task_state | None |
| snapshot_support | True |
| id | b07dbebe-a328-403c-b402-c8871c89e3d1 |
| size | 1 |
| name | docs_resize |
| share_type | 14ee8575-aac2-44af-8392-d9c9d344f392 |
| has_replicas | False |
| replication_type | None |
| created_at | 2016-03-25T15:33:18.000000 |
| share_proto | NFS |
| project_id | 907004508ef4447397ce6741a8f037c1 |
| metadata | {} |
+----------------------+--------------------------------------------------------------------------+
$ openstack share resize docs_resize 1
$ openstack share show docs_resize
+---------------------------------------+---------------------------------------+
| Property | Value |
+---------------------------------------+---------------------------------------+
| id | a3454cf1-bb1d-4e4d-a8e4-a3881c593720 |
| size | 1 |
| availability_zone | manila-zone-0 |
| created_at | 2024-09-26T14:53:18.153832 |
| status | shrinking |
| name | docs_resize |
| description | None |
| project_id | 1f31ee1c3e3c443bbf9aee5684456daa |
| snapshot_id | None |
| share_network_id | None |
| share_proto | NFS |
| metadata | {'__mount_options': 'fs=cephfs'} |
| share_type | 303f0a73-711e-4beb-a4f7-a60acc1d588e |
| is_public | True |
| snapshot_support | True |
| task_state | None |
| share_type_name | default |
| access_rules_status | active |
| replication_type | None |
| has_replicas | False |
| user_id | b47d81c8c8c74ea3a7c13461f30ad5ed |
| create_share_from_snapshot_support | True |
| revert_to_snapshot_support | False |
| share_group_id | None |
| source_share_group_snapshot_member_id | None |
| mount_snapshot_support | False |
| progress | 100% |
| is_soft_deleted | False |
| scheduled_to_be_deleted_at | None |
| source_backup_id | None |
| share_server_id | None |
| host | host@backend1#poolA |
+---------------------------------------+---------------------------------------+