openstack/manila
Code Issues Proposed changes

Merge "Updated documentation to openstack commands"

Browse Source
This commit is contained in:
Zuul
2025-05-06 15:16:32 +00:00
committed by Gerrit Code Review
parent 5fadf50c80 f8c7793848
commit 8fd38e768e
1 changed files with 82 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

158
doc/source/admin/shared-file-systems-quotas.rst
View File

@@ -16,30 +16,37 @@ not set up limits explicitly, the service does not impose any rate limits
but it enforces default resource limits (also referred to as ``default but it enforces default resource limits (also referred to as ``default
quotas``). quotas``).
Users can query their absolute limits using the :command:`manila Users can query their absolute limits using the :command:`openstack share limits show --absolute` command.
absolute-limits` command.
.. code-block:: console .. code-block:: console
$ manila absolute-limits $ openstack share limits show --absolute
+----------------------------+-------+ +------------------------------+-------+
| Name | Value | | Name | Value |
+----------------------------+-------+ +------------------------------+-------+
| maxTotalShareGigabytes | 1000 | | maxTotalShares | 50 |
| maxTotalShareNetworks | 10 | | maxTotalShareSnapshots | 50 |
| maxTotalShareSnapshots | 50 | | maxTotalShareGigabytes | 1000 |
| maxTotalShares | 50 | | maxTotalSnapshotGigabytes | 1000 |
| maxTotalSnapshotGigabytes | 1000 | | maxTotalShareNetworks | 10 |
| maxTotalShareReplicas | 100 | | maxTotalShareGroups | 50 |
| maxTotalReplicaGigabytes | 1000 | | maxTotalShareGroupSnapshots | 50 |
| totalShareGigabytesUsed | 1 | | maxTotalShareReplicas | 100 |
| totalShareNetworksUsed | 2 | | maxTotalReplicaGigabytes | 1000 |
| totalShareSnapshotsUsed | 1 | | maxTotalShareBackups | 10 |
| totalSharesUsed | 1 | | maxTotalBackupGigabytes | 1000 |
| totalSnapshotGigabytesUsed | 1 | | totalSharesUsed | 2 |
| totalShareReplicasUsed | 1 | | totalShareSnapshotsUsed | 0 |
| totalReplicaGigabytesUsed | 1 | | totalShareGigabytesUsed | 2 |
+----------------------------+-------+ | totalSnapshotGigabytesUsed | 0 |
| totalShareNetworksUsed | 0 |
| totalShareGroupsUsed | 0 |
| totalShareGroupSnapshotsUsed | 0 |
| totalShareReplicasUsed | 0 |
| totalReplicaGigabytesUsed | 0 |
| totalShareBackupsUsed | 0 |
| totalBackupGigabytesUsed | 0 |
+------------------------------+-------+
API Rate Limits API Rate Limits
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
@@ -90,14 +97,14 @@ To see the rate limits, run:
.. code-block:: console .. code-block:: console
$ manila rate-limits $ openstack share limits show --rate
+--------+------------+-------+--------+--------+----------------------+ +--------+----------+------------+-------+-----------+--------+----------------------+
| Verb | URI | Value | Remain | Unit | Next_Available | | Verb | Regex | URI | Value | Remaining | Unit | Next Available |
+--------+------------+-------+--------+--------+----------------------+ +--------+----------+------------+-------+-----------+--------+----------------------+
| DELETE | "*" | 120 | 120 | MINUTE | 2015-10-20T15:17:20Z | | POST | ^/shares | "*/shares" | 120 | 120 | MINUTE | 2025-02-25T02:15:39Z |
| POST | "*/shares" | 120 | 120 | MINUTE | 2015-10-20T15:17:20Z | | PUT | .* | "*/shares" | 120 | 120 | MINUTE | 2025-02-25T02:15:39Z |
| PUT | "*/shares" | 120 | 120 | MINUTE | 2015-10-20T15:17:20Z | | DELETE | .* | "*" | 120 | 120 | MINUTE | 2025-02-25T02:15:39Z |
+--------+------------+-------+--------+--------+----------------------+ +--------+----------+------------+-------+-----------+--------+----------------------+
Default Resource Quotas Default Resource Quotas
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
@@ -113,37 +120,34 @@ set on capacity with ``gigabytes`` (total size of shares allowed),
If these resource quotas are not set by an administrator, default quotas If these resource quotas are not set by an administrator, default quotas
that are hardcoded in the service will apply. To view these that are hardcoded in the service will apply. To view these
default quotas, the administrator can use the :command:`manila default quotas, the administrator can use the :command:`openstack share quota show –class default` command:
quota-defaults` command:
.. code-block:: console .. code-block:: console
$ manila quota-defaults $ openstack share quota show %project_id% --defaults
+-----------------------+------------------------------------+ +-----------------------+----------------------------------+
| Property | Value | | Field | Value |
+-----------------------+------------------------------------+ +-----------------------+----------------------------------+
| id | 1cc2154937bd40f4815d5f168d372263 | | backup_gigabytes | 1000 |
| gigabytes | 1000 | | backups | 10 |
| per_share_gigabytes | -1 | | gigabytes | 1000 |
| snapshot_gigabytes | 1000 | | id | a0ce678da60e4ca18010016d44ee6e83 |
| snapshots | 50 | | per_share_gigabytes | -1 |
| shares | 50 | | replica_gigabytes | 1000 |
| share_networks | 10 | | share_group_snapshots | 50 |
| share_groups | 50 | | share_groups | 50 |
| share_group_snapshots | 50 | | share_networks | 10 |
| share_replicas | 100 | | share_replicas | 100 |
| replica_gigabytes | 1000 | | shares | 50 |
+-----------------------+------------------------------------+ | snapshot_gigabytes | 1000 |
| snapshots | 50 |
+-----------------------+----------------------------------+
Administrators can modify default quotas with the :command:`manila Administrators can modify default quotas with the :command:`openstack share quota set --class default` command:
quota-class-update` command:
.. code-block:: console .. code-block:: console
manila quota-class-update default \ openstack share quota set --class default --shares 30 --snapshots 50 --share-groups 15
--shares 30 \
--snapshots 50 \
--share-groups 15
Alternatively, you can also specify these defaults via the ``manila.conf``. Alternatively, you can also specify these defaults via the ``manila.conf``.
@@ -171,7 +175,7 @@ The administrator can customize quotas for a specific project, or for a
specific user within a project context, or for a share type used by users of specific user within a project context, or for a share type used by users of
a project. a project.
To list the quotas for a project or user, use the :command:`manila quota-show` To list the quotas for a project or user, use the :command:`openstack share quota show`
command. If you specify the optional ``--user`` parameter, you get the command. If you specify the optional ``--user`` parameter, you get the
quotas for this user in the specified project. If you omit this parameter, quotas for this user in the specified project. If you omit this parameter,
you get the quotas for the specified project. If there are no overrides, the you get the quotas for the specified project. If there are no overrides, the
@@ -187,28 +191,30 @@ quotas shown will match the defaults.
.. code-block:: console .. code-block:: console
$ manila quota-show --tenant %project_id% --user %user_id% $ openstack share quota show %project_id% --user %user_id%
+-----------------------+-----------------------------------+ +-----------------------+----------------------------------+
| Property | Value | | Field | Value |
+-----------------------+-----------------------------------+ +-----------------------+----------------------------------+
| id | d99c76b43b1743fd822d26ccc915989c | | backup_gigabytes | 1000 |
| gigabytes | 1000 | | backups | 10 |
| per_share_gigabytes | -1 | | gigabytes | 1000 |
| snapshot_gigabytes | 1000 | | id | a0ce678da60e4ca18010016d44ee6e83 |
| snapshots | 50 | | per_share_gigabytes | -1 |
| shares | 50 | | replica_gigabytes | 1000 |
| share_networks | 10 | | share_group_snapshots | 50 |
| share_groups | 50 | | share_groups | 50 |
| share_group_snapshots | 50 | | share_networks | 10 |
| share_replicas | 100 | | share_replicas | 100 |
| replica_gigabytes | 1000 | | shares | 50 |
+-----------------------+-----------------------------------+ | snapshot_gigabytes | 1000 |
| snapshots | 50 |
+-----------------------+----------------------------------+
These quotas can be updated with the :command:`manila quota-update` command. These quotas can be updated with the :command:`openstack share quota set` command.
.. code-block:: console .. code-block:: console
$ manila quota-update %project_id% --user %user_id% --shares 49 --snapshots 49 $ openstack share quota set %project_id% --user %user_id% --shares 49 --snapshots 49
The service will prevent the quota being set lower than the current The service will prevent the quota being set lower than the current
consumption. However, a quota update can still be made if necessary with consumption. However, a quota update can still be made if necessary with
@@ -216,7 +222,7 @@ the``force`` key.
.. code-block:: console .. code-block:: console
$ manila quota-update %project_id% --shares 51 --snapshots 51 --force $ openstack share quota set %project_id% --shares 51 --snapshots 51 --force
The administrator can also update the quotas for a specific share type. Share 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 Type quotas cannot be set for individual users within a project. They can only
@@ -224,14 +230,14 @@ be applied across all users of a particular project.
.. code-block:: console .. code-block:: console
$ manila quota-update %project_id% --share-type %share_type_id% $ openstack share quota set %project_id% --share-type %share_type_id%
To revert quotas to default for a project or for a user, simply delete To revert quotas to default for a project or for a user, simply delete
the quota that has been set: the quota that has been set:
.. code-block:: console .. code-block:: console
$ manila quota-delete --tenant %project_id% --user-id %user_id% $ openstack share quota delete %project_id% --user %user_id%
Share type quotas can be reverted in the same way. Except, Share Type quotas Share type quotas can be reverted in the same way. Except, Share Type quotas
can not be set for individual users within a project, so they cannot be can not be set for individual users within a project, so they cannot be
@@ -239,4 +245,4 @@ unset either.
.. code-block:: console .. code-block:: console
$ manila quota-delete --tenant %project_id% --share-type %share_type_id% $ openstack share quota delete %project_id% --share-type %share_type_id%