]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/radosgw: edit admin.rst "set bucket rate limit" 55242/head
authorZac Dover <zac.dover@proton.me>
Sun, 14 Jan 2024 10:23:25 +0000 (20:23 +1000)
committerZac Dover <zac.dover@proton.me>
Fri, 19 Jan 2024 05:59:49 +0000 (15:59 +1000)
Edit "Set Bucket Rate Limit" in doc/radosgw/admin.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit e9b3ef4cb11760392ff7f766d652289636fcf5eb)

doc/radosgw/admin.rst

index 4fb8ffe749abe67d3f8f417289a6211188ce7980..fe8e84b05062282920fd9d11c5fde2d64fd63f78 100644 (file)
@@ -722,18 +722,24 @@ Set Bucket Rate Limit
 ---------------------
 
 Before you enable a rate limit, you must first set the rate limit parameters.
-For example:: 
+The following is the general form of commands that set rate limit parameters:
+
+.. prompt:: bash
 
-       radosgw-admin ratelimit set --ratelimit-scope=bucket --bucket=<bucket> <[--max-read-ops=<num ops>] [--max-read-bytes=<num bytes>]
+   radosgw-admin ratelimit set --ratelimit-scope=bucket --bucket=<bucket> <[--max-read-ops=<num ops>] [--max-read-bytes=<num bytes>]
   [--max-write-ops=<num ops>] [--max-write-bytes=<num bytes>]>
 
-For example:: 
+An example of using ``radosgw-admin ratelimit set`` to set a rate limit for a
+bucket might look like this: 
 
-       radosgw-admin ratelimit set --ratelimit-scope=bucket --bucket=mybucket --max-read-ops=1024 --max-write-bytes=10240
+.. prompt:: bash
 
+   radosgw-admin ratelimit set --ratelimit-scope=bucket --bucket=mybucket --max-read-ops=1024 --max-write-bytes=10240
 
-A 0 value for num ops and / or num bytes means that the
-specific rate limit attribute check is disabled.
+
+A value of ``0`` assigned to ``--max-read-ops``, ``--max-read-bytes``,
+``--max-write-ops``, or ``-max-write-bytes`` disables the specified bucket rate
+limit. 
 
 Get Bucket Rate Limit
 ---------------------