From f7fd149b999e6bf959c4682e2e9e998fb2fc2820 Mon Sep 17 00:00:00 2001 From: Tony Faijue Date: Thu, 27 Feb 2025 23:02:12 +0000 Subject: [PATCH] updated share group type doc Change-Id: I402c5a4d05fcdd9851fb44dc9375b3b94077bdef --- .../shared-file-systems-share-group-types.rst | 126 ++++++++++-------- 1 file changed, 70 insertions(+), 56 deletions(-) diff --git a/doc/source/admin/shared-file-systems-share-group-types.rst b/doc/source/admin/shared-file-systems-share-group-types.rst index b7cc4b5a7b..0cb8418aa4 100644 --- a/doc/source/admin/shared-file-systems-share-group-types.rst +++ b/doc/source/admin/shared-file-systems-share-group-types.rst @@ -39,18 +39,25 @@ In the Shared File Systems configuration file ``manila.conf``, the administrator can set the share group type used by default for the share group creation. -To create a share group type, use :command:`manila share-group-type-create` command as: +To create a share group type, use :command:`openstack share group type create` command as: .. code-block:: console - manila share-group-type-create [--is_public ] - [--group-specs [ [ ...]]] - + openstack share group type create [-h] + [-f {json,shell,table,value,yaml}] + [-c COLUMN] [--noindent] + [--prefix PREFIX] + [--max-width ] + [--fit-width] [--print-empty] + [--group-specs [ ...]] + [--public ] + + [ ...] -Where the ``name`` is the share group type name and ``--is_public`` defines +Where the ``name`` is the share group type name and ``--public`` defines the level of the visibility for the share group type. One share group can -include multiple ``share_types``. ``--group-specs`` are the extra +include multiple ``share-types``. ``--group-specs`` are the extra specifications used to filter back ends. .. note:: @@ -66,7 +73,7 @@ share group type creation with extra specifications to other roles. You set a share group type to private or public and :ref:`manage the access` to the private share group types. By default a share group type is created as publicly accessible. Set -``--is_public`` to ``False`` to make the share group type private. +``--public`` to ``False`` to make the share group type private. Share group type operations --------------------------- @@ -77,48 +84,54 @@ One share group can include multiple share types. .. code-block:: console - $ manila share-group-type-create group_type_for_cg default_share_type --is_public True - +------------+--------------------------------------+ - | Property | Value | - +------------+--------------------------------------+ - | is_default | - | - | ID | cfe42f20-d13e-4348-9370-f0763e426db3 | - | Visibility | public | - | Name | group_type_for_cg | - +------------+--------------------------------------+ + $ openstack share group type create group_type_for_cg default --public True + +-------------+--------------------------------------+ + | Field | Value | + +-------------+--------------------------------------+ + | id | cd7173f2-93f9-4977-aa55-eb8884333a07 | + | name | group_type_for_cg | + | share_types | c069126a-2d87-4bbb-a395-1dc5a5ac5d96 | + | visibility | public | + | is_default | False | + | group_specs | | + +-------------+--------------------------------------+ - $ manila share-group-type-list - +--------------------------------------+-------------------+------------+------------+ - | ID | Name | visibility | is_default | - +--------------------------------------+-------------------+------------+------------+ - | cfe42f20-d13e-4348-9370-f0763e426db3 | group_type_for_cg | public | - | - +--------------------------------------+-------------------+------------+------------+ + $ openstack share group type list + +--------------------------------------+-------------------+--------------------------------------+------------+------------+-------------+ + | ID | Name | Share Types | Visibility | Is Default | Group Specs | + +--------------------------------------+-------------------+--------------------------------------+------------+------------+-------------+ + | cd7173f2-93f9-4977-aa55-eb8884333a07 | group_type_for_cg | c069126a-2d87-4bbb-a395-1dc5a5ac5d96 | public | False | | + +--------------------------------------+-------------------+--------------------------------------+------------+------------+-------------+ -You can set or unset extra specifications for a share group type -using **manila share-group-type-key set ** command. +You can set extra specifications for a share group type +using **openstack share group type set --group-specs ** command. .. code-block:: console - $ manila share-group-type-key group_type_for_cg set consistent_snapshot_support=host + $ openstack share group type set group_type_for_cg --group-specs consistent_snapshot_support=host It is also possible to view a list of current share group types and extra specifications: .. code-block:: console - $ manila share-group-type-specs-list - +--------------------------------------+-------------------+------------------------------------+ - | ID | Name | all_extra_specs | - +--------------------------------------+-------------------+------------------------------------+ - | cfe42f20-d13e-4348-9370-f0763e426db3 | group_type_for_cg | consistent_snapshot_support : host | - +--------------------------------------+-------------------+------------------------------------+ + $ openstack share group type list + +--------------------------------------+-------------------+--------------------------------------+------------+------------+------------------------------------+ + | ID | Name | Share Types | Visibility | Is Default | Group Specs | + +--------------------------------------+-------------------+--------------------------------------+------------+------------+------------------------------------+ + | cd7173f2-93f9-4977-aa55-eb8884333a07 | group_type_for_cg | c069126a-2d87-4bbb-a395-1dc5a5ac5d96 | public | False | consistent_snapshot_support : host | + +--------------------------------------+-------------------+--------------------------------------+------------+------------+------------------------------------+ -Use :command:`manila share-group-type-key unset ` to -unset an extra specification. +Use :command:`openstack share group type unset ` to +unset one or more extra specifications. + +.. code-block:: console + + $ openstack share group type unset test_group_type mount_snapshot_support A public or private share group type can be deleted with the -:command:`manila share-group-type-delete ` command. +:command:`openstack share group type delete ` command. .. _share_group_type_access: @@ -127,46 +140,47 @@ Share group type access You can manage access to a private share group type for different projects. Administrators can provide access, revoke access, and retrieve -information about access for a specified private share group. +information about access for a specified private share group type. Create a private group type: .. code-block:: console - $ manila share-group-type-create my_type1 default_share_type --is_public False - +------------+--------------------------------------+ - | Property | Value | - +------------+--------------------------------------+ - | is_default | - | - | ID | f57cf3db-2503-4c0f-915c-4f1335d95465 | - | Visibility | private | - | Name | my_type1 | - +------------+--------------------------------------+ + $ openstack share group type create my_type1 default --public False + +-------------+--------------------------------------+ + | Field | Value | + +-------------+--------------------------------------+ + | id | 0c488ca6-8843-4313-ba2b-cc33acb2af73 | + | name | my_type1 | + | share_types | c069126a-2d87-4bbb-a395-1dc5a5ac5d96 | + | visibility | private | + | is_default | False | + | group_specs | | + +-------------+--------------------------------------+ .. note:: - If you run :command:`manila share-group-type-list` only public share group - types appear. To see private share group types, run :command:`manila - share-group-type-list` with ``--all`` optional argument. + If you run :command:`openstack share group type list` both public and private share group + types appear. Grant access to created private type for a demo and alt_demo projects by providing their IDs: .. code-block:: console - $ manila share-group-type-access-add my_type1 d8f9af6915404114ae4f30668a4f5ba7 - $ manila share-group-type-access-add my_type1 e4970f57f1824faab2701db61ee7efdf + $ openstack share group type access create my_type1 63ce0a1452384fce9edb0189425ea0e2 + $ openstack share group type access create my_type1 d274cfc59e2543d38aa223af4f5eb327 -To view information about access for a private share, :command:`manila type-access-list my_type1`: +To view information about access for a private share group type, use the command :command:`openstack share group type access list my_type1`: .. code-block:: console - $ manila type-access-list my_type1 + $ openstack share group type access list my_type1 +----------------------------------+ - | Project_ID | + | Project ID | +----------------------------------+ - | d8f9af6915404114ae4f30668a4f5ba7 | - | e4970f57f1824faab2701db61ee7efdf | + | 63ce0a1452384fce9edb0189425ea0e2 | + | d274cfc59e2543d38aa223af4f5eb327 | +----------------------------------+ After granting access to the share group type, the target project @@ -174,8 +188,8 @@ can see the share group type in the list, and create private share groups. To deny access for a specified project, use -:command:`manila share-group-type-access-remove ` command. +:command:`openstack share group type access delete ` command. .. code-block:: console - $ manila share-group-type-access-remove my_type1 e4970f57f1824faab2701db61ee7efdf + $ openstack share group type access delete my_type1 b0fa13353e594d6f809dfa405fedc46a