From b9116958cac3491b02fd058550d890c3d20cfd63 Mon Sep 17 00:00:00 2001 From: Maysa Macedo Date: Sun, 22 Oct 2017 14:13:06 -0300 Subject: [PATCH] Add admin documentation for following keys of quotas: -'share_groups' -'share_group_snapshots' Related-Bug: 1710042 Change-Id: I48837eea5bbdb87629673af10e7c79f245786d86 --- .../admin/shared-file-systems-quotas.rst | 43 +++++++++++-------- doc/source/cli/manila.rst | 20 ++++++++- .../shared-file-systems/overview.rst | 4 ++ .../configuration/tables/manila-quota.inc | 4 ++ 4 files changed, 50 insertions(+), 21 deletions(-) diff --git a/doc/source/admin/shared-file-systems-quotas.rst b/doc/source/admin/shared-file-systems-quotas.rst index 53403059ab..591dc04698 100644 --- a/doc/source/admin/shared-file-systems-quotas.rst +++ b/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 | - +--------------------+-------+ - | gigabytes | 1000 | - | snapshot_gigabytes | 1000 | - | snapshots | 50 | - | shares | 50 | - | share_networks | 10 | - +--------------------+-------+ + +-----------------------+-------+ + | Property | Value | + +-----------------------+-------+ + | gigabytes | 1000 | + | snapshot_gigabytes | 1000 | + | snapshots | 50 | + | shares | 50 | + | 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 | - +--------------------+-------+ - | gigabytes | 1000 | - | snapshot_gigabytes | 1000 | - | snapshots | 50 | - | shares | 50 | - | share_networks | 10 | - +--------------------+-------+ + +-----------------------+-------+ + | Property | Value | + +-----------------------+-------+ + | gigabytes | 1000 | + | snapshot_gigabytes | 1000 | + | snapshots | 50 | + | shares | 50 | + | 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 diff --git a/doc/source/cli/manila.rst b/doc/source/cli/manila.rst index db45f949bc..a53f55f52f 100644 --- a/doc/source/cli/manila.rst +++ b/doc/source/cli/manila.rst @@ -1228,6 +1228,8 @@ manila quota-class-update [--gigabytes ] [--snapshot-gigabytes ] [--share-networks ] + [--share-groups ] + [--share-group-snapshots ] 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 `` New value for the "share_networks" quota. +``--share-groups , --share_groups `` + New value for the "share_groups" quota. + +``--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 ] [--shares ] [--snapshots ] [--gigabytes ] [--snapshot-gigabytes ] - [--share-networks ] [--force] + [--share-networks ] + [--share-groups ] + [--share-group-snapshots ] + [--force] 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 `` New value for the "share_networks" quota. +``--share-groups , --share_groups `` + New value for the "share_groups" quota. + +``--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 `` Public share is visible for all tenants. - diff --git a/doc/source/configuration/shared-file-systems/overview.rst b/doc/source/configuration/shared-file-systems/overview.rst index 3353941e9c..254045887a 100644 --- a/doc/source/configuration/shared-file-systems/overview.rst +++ b/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. diff --git a/doc/source/configuration/tables/manila-quota.inc b/doc/source/configuration/tables/manila-quota.inc index b96b4fcefa..c06c5d0de1 100644 --- a/doc/source/configuration/tables/manila-quota.inc +++ b/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.