Skip to content

Commit 9652842

Browse files
Merge pull request ceph#55142 from zdover23/wip-doc-2024-01-11-radosgw-user-rate-limit-ops
doc/radosgw - edit admin.rst "set user rate limit"
2 parents a6110a8 + 8660b4e commit 9652842

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

doc/radosgw/admin.rst

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -654,19 +654,27 @@ time has elapsed, "user A" will be able to send ``GET`` requests again.
654654
Set User Rate Limit
655655
-------------------
656656

657-
Before you enable a rate limit, you must first set the rate limit parameters.
658-
For example::
657+
Before you can enable a rate limit, you must first set the rate limit
658+
parameters. The following is the general form of commands that set rate limit
659+
parameters:
659660

660-
radosgw-admin ratelimit set --ratelimit-scope=user --uid=<uid> <[--max-read-ops=<num ops>] [--max-read-bytes=<num bytes>]
661-
[--max-write-ops=<num ops>] [--max-write-bytes=<num bytes>]>
661+
.. prompt:: bash
662662

663-
For example::
663+
radosgw-admin ratelimit set --ratelimit-scope=user --uid=<uid>
664+
<[--max-read-ops=<num ops>] [--max-read-bytes=<num bytes>]
665+
[--max-write-ops=<num ops>] [--max-write-bytes=<num bytes>]>
664666

665-
radosgw-admin ratelimit set --ratelimit-scope=user --uid=johndoe --max-read-ops=1024 --max-write-bytes=10240
667+
An example of using ``radosgw-admin ratelimit set`` to set a rate limit might
668+
look like this:
666669

670+
.. prompt:: bash
667671

668-
A 0 value for num ops and / or num bytes means that the
669-
specific rate limit attribute check is disabled.
672+
radosgw-admin ratelimit set --ratelimit-scope=user --uid=johndoe --max-read-ops=1024 --max-write-bytes=10240
673+
674+
675+
A value of ``0`` assigned to ``--max-read-ops``, ``--max-read-bytes``,
676+
``--max-write-ops``, or ``--max-write-bytes`` disables the specified rate
677+
limit.
670678

671679
Get User Rate Limit
672680
-------------------

0 commit comments

Comments
 (0)