diff --git a/doc/source/admin/shared-file-systems-quotas.rst b/doc/source/admin/shared-file-systems-quotas.rst index 591dc04698..b29f20dcd2 100644 --- a/doc/source/admin/shared-file-systems-quotas.rst +++ b/doc/source/admin/shared-file-systems-quotas.rst @@ -101,17 +101,18 @@ 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 | - | share_groups | 50 | - | share_group_snapshots | 50 | - +-----------------------+-------+ + +-----------------------+-----------------------------------+ + | Property | Value | + +-----------------------+-----------------------------------+ + | id | d99c76b43b1743fd822d26ccc915989c | + | 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 @@ -120,23 +121,24 @@ 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 | - | share_groups | 50 | - | share_group_snapshots | 50 | - +-----------------------+-------+ + +-----------------------+------------------------------------+ + | Property | Value | + +-----------------------+------------------------------------+ + | id | 1cc2154937bd40f4815d5f168d372263 | + | 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``, ``share-networks``, ``share_groups`` -and ``share_group_snapshots`` quotas. +``gigabytes``, ``snapshot-gigabytes``, ``share-networks``, ``share_groups``, +``share_group_snapshots`` and ``share-type`` quotas. .. code-block:: console @@ -150,8 +152,24 @@ To force-update a quota, use ``force`` optional key. $ manila quota-update %project_id% --shares 51 --snapshots 51 --force +The administrator can also update the quotas for a specific share type. Share +Type quotas cannot be set for individual users within a project. They can only +be applied across all users of a particular project. + +.. code-block:: console + + $ manila quota-update %project_id% --share-type %share_type_id% + To revert quotas to default for a project or for a user, delete quotas: .. code-block:: console - $ manila quota-delete --tenant %project_id% --user %user_id% + $ manila quota-delete --tenant %project_id% --user-id %user_id% + +To revert quotas to default, use the specific project or share type. Share +Type quotas can not be reverted for individual users within a project. They +can only be reverted across all users of a particular project. + +.. code-block:: console + + $ manila quota-delete --tenant %project_id% --share-type %share_type_id% \ No newline at end of file diff --git a/doc/source/cli/manila.rst b/doc/source/cli/manila.rst index a53f55f52f..c2fd0f999c 100644 --- a/doc/source/cli/manila.rst +++ b/doc/source/cli/manila.rst @@ -1286,6 +1286,7 @@ manila quota-delete .. code-block:: console usage: manila quota-delete [--tenant ] [--user ] + [--share-type ] Delete quota for a tenant/user. The quota will revert back to default (Admin only). @@ -1298,6 +1299,11 @@ only). ``--user `` ID of user to delete quota for. +``--share-type , --share_type `` + UUID or name of a share type to set the quotas for. + Optional. Mutually exclusive with '--user-id'. + Available only for microversion >= 2.39 + .. _manila_quota-show: manila quota-show @@ -1305,7 +1311,8 @@ manila quota-show .. code-block:: console - usage: manila quota-show [--tenant ] [--user ] [--detail] + usage: manila quota-show [--tenant ] [--user ] + [--share-type ] [--detail] List the quotas for a tenant/user. @@ -1317,6 +1324,11 @@ List the quotas for a tenant/user. ``--user `` ID of user to list the quotas for. +``--share-type , --share_type `` + UUID or name of a share type to set the quotas for. + Optional. Mutually exclusive with '--user-id'. + Available only for microversion >= 2.39 + ``--detail`` Optional flag to indicate whether to show quota in detail. Default false, available only for microversion @@ -1335,7 +1347,7 @@ manila quota-update [--share-networks ] [--share-groups ] [--share-group-snapshots ] - [--force] + [--share-type ] [--force] Update the quotas for a tenant/user (Admin only). @@ -1371,6 +1383,11 @@ Update the quotas for a tenant/user (Admin only). ``--share-group-snapshots , --share_group_snapshots `` New value for the "share_group_snapshots" quota. +``--share-type , --share_type `` + UUID or name of a share type to set the quotas for. + Optional. Mutually exclusive with '--user-id'. + Available only for microversion >= 2.39 + ``--force`` Whether force update the quota even if the already used and reserved exceeds the new quota.