From d5c7b4d62c71ca2a57b7d9a552eae03f0f620cef Mon Sep 17 00:00:00 2001 From: Hyun Jin Kim Date: Tue, 17 Jun 2025 09:01:28 -0400 Subject: [PATCH] doc/radosgw/admin.rst: explain bucket and uid flags for bucket quota Clarify behavior of bucket and uid flags when setting a quota with quota-scope=bucket. Signed-off-by: Hyun Jin Kim --- doc/radosgw/admin.rst | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/doc/radosgw/admin.rst b/doc/radosgw/admin.rst index e580409f80c3f..2740a287a11cd 100644 --- a/doc/radosgw/admin.rst +++ b/doc/radosgw/admin.rst @@ -439,9 +439,6 @@ The Ceph Object Gateway makes it possible for you to set quotas on users and buckets owned by users. Quotas include the maximum number of objects in a bucket and the maximum storage size a bucket can hold. -- **Bucket:** The ``--bucket`` option allows you to specify a quota for - buckets the user owns. - - **Maximum Objects:** The ``--max-objects`` setting allows you to specify the maximum number of objects. A negative value disables this setting. @@ -450,14 +447,13 @@ bucket and the maximum storage size a bucket can hold. setting. - **Quota Scope:** The ``--quota-scope`` option sets the scope for the quota. - The options are ``bucket`` and ``user``. Bucket quotas apply to each bucket - owned by the user. User Quotas are summed across all buckets owned by the - user. - + The options are ``bucket`` and ``user``. Set User Quota -------------- +User Quotas are summed across all buckets owned by the user. + Before you enable a quota, you must first set the quota parameters. To set quota parameters, run a command of the following form: @@ -494,13 +490,14 @@ To disable an enabled user quota, run a command of the following form: Set Bucket Quota ---------------- -Bucket quotas apply to the buckets owned by the specified ``uid``. They are -independent of the user. To set a bucket quota, run a command of the following -form: +If the ``--bucket`` option is specified, the bucket quota applies to a single bucket with the specified name. +Else, if the ``--uid`` option is specified, the bucket quota applies to all buckets owned by the user with the specified UID. + +To set a bucket quota, run a command of the following form: .. prompt:: bash # - radosgw-admin quota set --uid= --quota-scope=bucket [--max-objects=] [--max-size= | --uid=} [--max-objects=] [--max-size=] A negative value for ``--max-objects`` or ``--max-size`` means that the specific quota attribute is disabled. -- 2.39.5