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