use openstack cli commands

This change updates the cli commands in manage and unmanage shares
documentation to stop using the deprecated manila cli and start
using openstack cli
Signed-off-by: olamidepeterojo <peterojoolamide@gmail.com>

Closes-Bug: #2084557
Change-Id: I7f8194b53c93aad892e7fbf8d3b688e7d7865b6a
Signed-off-by: olamidepeterojo <peterojoolamide@gmail.com>
This commit is contained in:
olamidepeterojo
2025-04-02 16:39:50 +00:00
committed by Goutham Pacha Ravi
parent 5a93b39467
commit 9da6da3c94

View File

@@ -35,15 +35,15 @@ Unmanaging a share removes it from the management of the Shared File Systems
service without deleting the share. It is a non-disruptive operation and service without deleting the share. It is a non-disruptive operation and
existing clients are not disconnected, and the functionality is aimed at aiding existing clients are not disconnected, and the functionality is aimed at aiding
infrastructure operations and maintenance workflows. To unmanage a share, infrastructure operations and maintenance workflows. To unmanage a share,
run the :command:`manila unmanage <share>` command. Then try to print run the :command:`openstack share abandon` command. Then try to print
the information about the share. The returned result should indicate that the information about the share. The returned result should indicate that
Shared File Systems service won't Shared File Systems service won't
find the share: find the share:
.. code-block:: console .. code-block:: console
$ manila unmanage share_for_docs $ openstack share abandon share_for_docs
$ manila show share_for_docs $ openstack share show share_for_docs
ERROR: No share with a name or ID of 'share_for_docs' exists. ERROR: No share with a name or ID of 'share_for_docs' exists.
.. _manage_share: .. _manage_share:
@@ -64,15 +64,21 @@ Manage a share
share against ``per_share_gigabytes`` quota. share against ``per_share_gigabytes`` quota.
To register the non-managed share in the File System service, run the To register the non-managed share in the File System service, run the
:command:`manila manage` command: :command:`openstack share adopt` command:
.. code-block:: console .. code-block:: console
manila manage [--name <name>] [--description <description>] openstack share adopt [-h] [-f {json,shell,table,value,yaml}]
[--share_type <share-type>] [-c COLUMN] [--noindent] [--prefix PREFIX]
[--share-server-id <share_server_id>] [--max-width <integer>] [--fit-width]
[--driver_options [<key=value> [<key=value> ...]]] [--print-empty] [--name <name>]
<service_host> <protocol> <export_path> [--description <description>]
[--share-type <share-type>]
[--driver-options [<key=value> ...]]
[--public]
[--share-server-id <share-server-id>]
[--wait]
<service-host> <protocol> <export-path>
The positional arguments are: The positional arguments are:
@@ -117,81 +123,124 @@ To manage share, run:
.. code-block:: console .. code-block:: console
$ manila manage \ $ openstack share adopt \
manila@paris#shares \ manila@saopaulo#shares \
nfs \ nfs \
1.0.0.4:/shares/manila_share_6d2142d8_2b9b_4405_867f_8a48094c893f \ 10.0.0.10:/shares/share_e113729a_8da4_45f3_bbbf_0014f_350380c_c4b06060_9c56_459e_9219_b86a0777054b \
--name share_for_docs \ --name share_for_docs \
--description "We manage share." \ --description "We manage share." \
--share_type for_managing --share-type default
+-----------------------------+--------------------------------------+
| Property | Value | +-------------------------------------+--------------------------------------+
+-----------------------------+--------------------------------------+ | Field | Value |
| status | manage_starting | +-------------------------------------+--------------------------------------+
| share_type_name | for_managing | | id | 8b3aa39d-e07f-4255-82ac-f6f56565a725 |
| description | We manage share. | | size | None |
| availability_zone | None | | availability_zone | None |
| share_network_id | None | | created_at | 2025-04-03T10:57:19.230793 |
| share_server_id | None | | status | manage_starting |
| share_group_id | None | | name | share_for_docs |
| host | manila@paris#shares | | description | We manage share. |
| access_rules_status | active | | project_id | c0bc204890ad428796f364b677a8516b |
| snapshot_id | None | | snapshot_id | None |
| is_public | False | | share_network_id | None |
| task_state | None | | share_proto | NFS |
| snapshot_support | True | | metadata | {} |
| id | ddfb1240-ed5e-4071-a031-b842035a834a | | share_type | 807e5cd7-a0e7-4912-8f7d-352512ce51c3 |
| size | None | | volume_type | default |
| name | share_for_docs | | is_public | False |
| share_type | 14ee8575-aac2-44af-8392-d9c9d344f392 | | snapshot_support | True |
| has_replicas | False | | task_state | None |
| replication_type | None | | share_type_name | default |
| created_at | 2016-03-25T15:22:43.000000 | | access_rules_status | active |
| share_proto | NFS | | replication_type | None |
| project_id | 907004508ef4447397ce6741a8f037c1 | | has_replicas | False |
| metadata | {} | | user_id | c5d0c19aae6e4484a41e241f0d8b04fb |
+-----------------------------+--------------------------------------+ | create_share_from_snapshot_support | True |
| revert_to_snapshot_support | True |
| share_group_id | None |
| source_share_group_snapshot_member_ | None |
| id | |
| mount_snapshot_support | True |
| progress | None |
| is_soft_deleted | False |
| scheduled_to_be_deleted_at | None |
| source_backup_id | None |
| share_server_id | None |
| host | manila@saopaulo#shares |
+-------------------------------------+--------------------------------------+
Check that the share is available: Check that the share is available:
.. code-block:: console .. code-block:: console
$ manila show share_for_docs $ openstack share show share_for_docs
+----------------------+--------------------------------------------------------------------------+ +-------------------------------------+--------------------------------------+
| Property | Value | | Field | Value |
+----------------------+--------------------------------------------------------------------------+ +-------------------------------------+--------------------------------------+
| status | available | | id | 8b3aa39d-e07f-4255-82ac-f6f56565a725 |
| share_type_name | for_managing | | size | 1 |
| description | We manage share. | | availability_zone | manila-zone-1 |
| availability_zone | None | | created_at | 2025-04-03T10:57:19.230793 |
| share_network_id | None | | status | available |
| export_locations | | | name | share_for_docs |
| | path = 1.0.0.4:/shares/manila_share_6d2142d8_2b9b_4405_867f_8a48094c893f | | description | We manage share. |
| | preferred = False | | project_id | c0bc204890ad428796f364b677a8516b |
| | is_admin_only = False | | snapshot_id | None |
| | id = d4d048bf-4159-4a94-8027-e567192b8d30 | | share_network_id | None |
| | share_instance_id = 4c8e3887-4f9a-4775-bab4-e5840a09c34e | | share_proto | NFS |
| | path = 2.0.0.3:/shares/manila_share_6d2142d8_2b9b_4405_867f_8a48094c893f | | share_type | 807e5cd7-a0e7-4912-8f7d-352512ce51c3 |
| | preferred = False | | volume_type | default |
| | is_admin_only = True | | is_public | False |
| | id = 1dd4f0a3-778d-486a-a851-b522f6e7cf5f | | snapshot_support | True |
| | share_instance_id = 4c8e3887-4f9a-4775-bab4-e5840a09c34e | | 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 | c5d0c19aae6e4484a41e241f0d8b04fb |
| is_public | False | | create_share_from_snapshot_support | True |
| task_state | None | | revert_to_snapshot_support | True |
| snapshot_support | True | | share_group_id | None |
| id | ddfb1240-ed5e-4071-a031-b842035a834a | | source_share_group_snapshot_member_ | None |
| size | 1 | | id | |
| name | share_for_docs | | mount_snapshot_support | True |
| share_type | 14ee8575-aac2-44af-8392-d9c9d344f392 | | progress | 100% |
| has_replicas | False | | is_soft_deleted | False |
| replication_type | None | | scheduled_to_be_deleted_at | None |
| created_at | 2016-03-25T15:22:43.000000 | | source_backup_id | None |
| share_proto | NFS | | share_server_id | None |
| project_id | 907004508ef4447397ce6741a8f037c1 | | host | manila@saopaulo#shares |
| metadata | {} | | export_locations | |
+----------------------+--------------------------------------------------------------------------+ | | id = |
| | ba4ad0cd-6d25-422f-97f6-a1bc383ae49d |
| | path = 11.0.0.11:/shares/share_e1137 |
| | 29a_8da4_45f3_bbbf_0014f350380c_c4b0 |
| | 6060_9c56_459e_9219_b86a0777054b |
| | preferred = False |
| | metadata = {} |
| | share_instance_id = |
| | c4b06060-9c56-459e-9219-b86a0777054b |
| | is_admin_only = True |
| | id = |
| | c525a3aa-b52a-4565-acf3-aacaca1167ec |
| | path = 10.0.0.10:/shares/share_e1137 |
| | 29a_8da4_45f3_bbbf_0014f350380c_c4b0 |
| | 6060_9c56_459e_9219_b86a0777054b |
| | preferred = True |
| | metadata = {} |
| | share_instance_id = |
| | c4b06060-9c56-459e-9219-b86a0777054b |
| | is_admin_only = False |
| | id = |
| | b5c26041-eba0-415d-8bda-f46ca67a55b9 |
| | path = 10.0.0.20:/shares/share_e1137 |
| | 29a_8da4_45f3_bbbf_0014f350380c_c4b0 |
| | 6060_9c56_459e_9219_b86a0777054b |
| | preferred = False |
| | metadata = {} |
| | share_instance_id = |
| | c4b06060-9c56-459e-9219-b86a0777054b |
| | is_admin_only = False |
| properties | |
+-------------------------------------+--------------------------------------+