]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/radosgw: edit admin.rst "Get Bucket Rate Limit" 55253/head
authorZac Dover <zac.dover@proton.me>
Sun, 14 Jan 2024 23:29:23 +0000 (09:29 +1000)
committerZac Dover <zac.dover@proton.me>
Sat, 20 Jan 2024 07:35:16 +0000 (17:35 +1000)
Edit "Get Bucket Rate Limit" in doc/radosgw/admin.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 7c4fdd3762831cb86993b1b4a814ea68a9ea2401)

doc/radosgw/admin.rst

index fe8e84b05062282920fd9d11c5fde2d64fd63f78..c09f6d591d8c907a2c1a0b8e2ea4c7c793010d62 100644 (file)
@@ -679,8 +679,8 @@ limit.
 Get User Rate Limit
 -------------------
 
-The ``radosgw-admin ratelimit get`` command returns the current configured rate
-limit parameters.
+The ``radosgw-admin ratelimit get`` command returns the currently configured
+rate limit parameters.
 
 The following is the general form of the command that returns the current
 configured limit parameters:  
@@ -744,18 +744,26 @@ limit.
 Get Bucket Rate Limit
 ---------------------
 
-Get the current configured rate limit parameters
-For example:: 
+The ``radosgw-admin ratelimit get`` command returns the current configured rate
+limit parameters.
+
+The following is the general form of the command that returns the current
+configured limit parameters:
+
+.. prompt:: bash
 
-       radosgw-admin ratelimit set --ratelimit-scope=bucket --bucket=<bucket>
+   radosgw-admin ratelimit get --ratelimit-scope=bucket --bucket=<bucket>
 
-For example:: 
+An example of using ``radosgw-admin ratelimit get`` to return the rate limit
+parameters for a bucket might look like this:
 
-       radosgw-admin ratelimit get --ratelimit-scope=bucket --bucket=mybucket
+.. prompt:: bash
 
+   radosgw-admin ratelimit get --ratelimit-scope=bucket --bucket=mybucket
 
-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 rate
+limit.
 
 
 Enable/Disable Bucket Rate Limit