Skip to content

Commit da27661

Browse files
Merge pull request ceph#64020 from zdover23/wip-doc-2025-06-19-backport-63983-to-tentacle
tentacle: doc/radosgw/admin.rst: explain bucket and uid flags for bucket quota
2 parents 684eb2a + 20d165a commit da27661

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

doc/radosgw/admin.rst

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -439,9 +439,6 @@ The Ceph Object Gateway makes it possible for you to set quotas on users and
439439
buckets owned by users. Quotas include the maximum number of objects in a
440440
bucket and the maximum storage size a bucket can hold.
441441

442-
- **Bucket:** The ``--bucket`` option allows you to specify a quota for
443-
buckets the user owns.
444-
445442
- **Maximum Objects:** The ``--max-objects`` setting allows you to specify
446443
the maximum number of objects. A negative value disables this setting.
447444

@@ -450,14 +447,13 @@ bucket and the maximum storage size a bucket can hold.
450447
setting.
451448

452449
- **Quota Scope:** The ``--quota-scope`` option sets the scope for the quota.
453-
The options are ``bucket`` and ``user``. Bucket quotas apply to each bucket
454-
owned by the user. User Quotas are summed across all buckets owned by the
455-
user.
456-
450+
The options are ``bucket`` and ``user``.
457451

458452
Set User Quota
459453
--------------
460454

455+
User Quotas are summed across all buckets owned by the user.
456+
461457
Before you enable a quota, you must first set the quota parameters.
462458
To set quota parameters, run a command of the following form:
463459

@@ -494,13 +490,14 @@ To disable an enabled user quota, run a command of the following form:
494490
Set Bucket Quota
495491
----------------
496492

497-
Bucket quotas apply to the buckets owned by the specified ``uid``. They are
498-
independent of the user. To set a bucket quota, run a command of the following
499-
form:
493+
If the ``--bucket`` option is specified, the bucket quota applies to a single bucket with the specified name.
494+
Else, if the ``--uid`` option is specified, the bucket quota applies to all buckets owned by the user with the specified UID.
495+
496+
To set a bucket quota, run a command of the following form:
500497

501498
.. prompt:: bash #
502499

503-
radosgw-admin quota set --uid=<uid> --quota-scope=bucket [--max-objects=<num objects>] [--max-size=<max size]
500+
radosgw-admin quota set --quota-scope=bucket {--bucket=<bucket name> | --uid=<uid>} [--max-objects=<num objects>] [--max-size=<max size>]
504501

505502
A negative value for ``--max-objects`` or ``--max-size`` means that the
506503
specific quota attribute is disabled.

0 commit comments

Comments
 (0)