]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/radosgw - edit admin.rst "set user rate limit" 55151/head
authorZac Dover <zac.dover@proton.me>
Thu, 11 Jan 2024 08:32:09 +0000 (18:32 +1000)
committerZac Dover <zac.dover@proton.me>
Thu, 11 Jan 2024 17:19:35 +0000 (03:19 +1000)
Edit "Set User Rate Limit" in doc/radosgw/admin.rst.

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

doc/radosgw/admin.rst

index 88a7215fb1563501c6d814436b87681bd7c9f90d..a178d69421fb2a4dd7b95055ec522e4a12100b65 100644 (file)
@@ -654,19 +654,27 @@ time has elapsed, "user A" will be able to send ``GET`` requests again.
 Set User Rate Limit
 -------------------
 
-Before you enable a rate limit, you must first set the rate limit parameters.
-For example:: 
+Before you can enable a rate limit, you must first set the rate limit
+parameters. The following is the general form of commands that set rate limit
+parameters: 
 
-       radosgw-admin ratelimit set --ratelimit-scope=user --uid=<uid> <[--max-read-ops=<num ops>] [--max-read-bytes=<num bytes>]
-  [--max-write-ops=<num ops>] [--max-write-bytes=<num bytes>]>
+.. prompt:: bash
 
-For example:: 
+   radosgw-admin ratelimit set --ratelimit-scope=user --uid=<uid>
+   <[--max-read-ops=<num ops>] [--max-read-bytes=<num bytes>]
+   [--max-write-ops=<num ops>] [--max-write-bytes=<num bytes>]>
 
-       radosgw-admin ratelimit set --ratelimit-scope=user --uid=johndoe --max-read-ops=1024 --max-write-bytes=10240
+An example of using ``radosgw-admin ratelimit set`` to set a rate limit might
+look like this: 
 
+.. prompt:: bash
 
-A 0 value for num ops and / or num bytes means that the
-specific rate limit attribute check is disabled.
+   radosgw-admin ratelimit set --ratelimit-scope=user --uid=johndoe --max-read-ops=1024 --max-write-bytes=10240
+
+
+A value of ``0`` assigned to ``--max-read-ops``, ``--max-read-bytes``,
+``--max-write-ops``, or ``--max-write-bytes`` disables the specified rate
+limit.  
 
 Get User Rate Limit
 -------------------