From: Hyun Jin Kim <hello.hyunjin@gmail.com>
Date: Tue, 17 Jun 2025 13:01:28 +0000 (-0400)
Subject: doc/radosgw/admin.rst: explain bucket and uid flags for bucket quota
X-Git-Tag: v19.2.3~32^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=1dd7da390d7a2476bcd8af579c32223f0b4945cc;p=ceph.git

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 <hello.hyunjin@gmail.com>
(cherry picked from commit d5c7b4d62c71ca2a57b7d9a552eae03f0f620cef)
---

diff --git a/doc/radosgw/admin.rst b/doc/radosgw/admin.rst
index bfa6c9b77bdad..3b17fd33835ee 100644
--- a/doc/radosgw/admin.rst
+++ b/doc/radosgw/admin.rst
@@ -438,9 +438,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.
   
@@ -449,14 +446,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: 
 
@@ -493,13 +489,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=<uid> --quota-scope=bucket [--max-objects=<num objects>] [--max-size=<max size]
+   radosgw-admin quota set --quota-scope=bucket {--bucket=<bucket name> | --uid=<uid>} [--max-objects=<num objects>] [--max-size=<max size>]
 
 A negative value for ``--max-objects`` or ``--max-size`` means that the
 specific quota attribute is disabled.