Merge "Add admin documentation for following keys of quotas: -'share_groups' -'share_group_snapshots'"

doc/source/admin/shared-file-systems-quotas.rst

@@ -101,15 +101,17 @@ you get the quotas for the specified project.
 .. code-block:: console
 
    $ manila quota-show --tenant %project_id% --user %user_id%
-   +--------------------+-------+
+   +-----------------------+-------+
-   | Property           | Value |
+   | Property              | Value |
-   +--------------------+-------+
+   +-----------------------+-------+
-   | gigabytes          | 1000  |
+   | gigabytes             | 1000  |
-   | snapshot_gigabytes | 1000  |
+   | snapshot_gigabytes    | 1000  |
-   | snapshots          | 50    |
+   | snapshots             | 50    |
-   | shares             | 50    |
+   | shares                | 50    |
-   | share_networks     | 10    |
+   | share_networks        | 10    |
-   +--------------------+-------+
+   | share_groups          | 50    |
+   | share_group_snapshots | 50    |
+   +-----------------------+-------+
 
 There are default quotas for a project that are set from the
 ``manila.conf`` file. To list the default quotas for a project, use
@@ -118,20 +120,23 @@ the :command:`manila quota-defaults` command:
 .. code-block:: console
 
    $ manila quota-defaults --tenant %project_id%
-   +--------------------+-------+
+   +-----------------------+-------+
-   | Property           | Value |
+   | Property              | Value |
-   +--------------------+-------+
+   +-----------------------+-------+
-   | gigabytes          | 1000  |
+   | gigabytes             | 1000  |
-   | snapshot_gigabytes | 1000  |
+   | snapshot_gigabytes    | 1000  |
-   | snapshots          | 50    |
+   | snapshots             | 50    |
-   | shares             | 50    |
+   | shares                | 50    |
-   | share_networks     | 10    |
+   | share_networks        | 10    |
-   +--------------------+-------+
+   | share_groups          | 50    |
+   | share_group_snapshots | 50    |
+   +-----------------------+-------+
 
 The administrator can update the quotas for a specific project, or for a
 specific user by providing both the ``--tenant`` and ``--user`` optional
 arguments. It is possible to update the ``shares``, ``snapshots``,
-``gigabytes``, ``snapshot-gigabytes``, and ``share-networks`` quotas.
+``gigabytes``, ``snapshot-gigabytes``, ``share-networks``, ``share_groups``
+and ``share_group_snapshots`` quotas.
 
 .. code-block:: console
 

doc/source/cli/manila.rst

@@ -1228,6 +1228,8 @@ manila quota-class-update
                                     [--gigabytes <gigabytes>]
                                     [--snapshot-gigabytes <snapshot_gigabytes>]
                                     [--share-networks <share-networks>]
+                                    [--share-groups <share-groups>]
+                                    [--share-group-snapshots <share-group-snapshots>]
                                     <class-name>
 
 Update the quotas for a quota class (Admin only).
@@ -1254,6 +1256,12 @@ Update the quotas for a quota class (Admin only).
 ``--share-networks <share-networks>, --share_networks <share-networks>``
   New value for the "share_networks" quota.
 
+``--share-groups <share-groups>, --share_groups <share-groups>``
+  New value for the "share_groups" quota.
+
+``--share-group-snapshots <share-group-snapshots>, --share_group_snapshots <share-group-snapshots>``
+  New value for the "share_group_snapshots" quota.
+
 .. _manila_quota-defaults:
 
 manila quota-defaults
@@ -1324,7 +1332,10 @@ manila quota-update
    usage: manila quota-update [--user <user-id>] [--shares <shares>]
                               [--snapshots <snapshots>] [--gigabytes <gigabytes>]
                               [--snapshot-gigabytes <snapshot_gigabytes>]
-                              [--share-networks <share-networks>] [--force]
+                              [--share-networks <share-networks>]
+                              [--share-groups <share-groups>]
+                              [--share-group-snapshots <share-group-snapshots>]
+                              [--force]
                               <tenant_id>
 
 Update the quotas for a tenant/user (Admin only).
@@ -1354,6 +1365,12 @@ Update the quotas for a tenant/user (Admin only).
 ``--share-networks <share-networks>, --share_networks <share-networks>``
   New value for the "share_networks" quota.
 
+``--share-groups <share-groups>, --share_groups <share-groups>``
+  New value for the "share_groups" quota.
+
+``--share-group-snapshots <share-group-snapshots>, --share_group_snapshots <share-group-snapshots>``
+  New value for the "share_group_snapshots" quota.
+
 ``--force``
   Whether force update the quota even if the already
   used and reserved exceeds the new quota.
@@ -3594,4 +3611,3 @@ Rename a share.
 
 ``--is-public <is_public>, --is_public <is_public>``
   Public share is visible for all tenants.
-

doc/source/configuration/shared-file-systems/overview.rst

@@ -66,6 +66,10 @@ The Shared File Systems service contains the following components:
 
    -  The number of share networks that can be created.
 
+   -  The number of share groups that can be created.
+
+   -  The number of share group snapshots that can be created.
+
    You can revise the default quota values with the Shared File Systems
    CLI, so the limits placed by quotas are editable by admin users.
 

doc/source/configuration/tables/manila-quota.inc

@@ -34,5 +34,9 @@
      - (Integer) Number of snapshot gigabytes allowed per project.
    * - ``quota_snapshots`` = ``50``
      - (Integer) Number of share snapshots allowed per project.
+   * - ``quota_share_groups`` = ``50``
+     - (Integer) Number of share groups allowed.
+   * - ``quota_share_group_snapshots`` = ``50``
+     - (Integer) Number of share group snapshots allowed.
    * - ``reservation_expire`` = ``86400``
      - (Integer) Number of seconds until a reservation expires.