From: Zac Dover <zac.dover@proton.me>
Date: Sun, 14 Jan 2024 23:29:23 +0000 (+1000)
Subject: doc/radosgw: edit admin.rst "Get Bucket Rate Limit"
X-Git-Tag: v17.2.8~562^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F55254%2Fhead;p=ceph.git

doc/radosgw: edit admin.rst "Get Bucket Rate Limit"

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)
---

diff --git a/doc/radosgw/admin.rst b/doc/radosgw/admin.rst
index 4fb8ffe749ab..8b8c74de4cae 100644
--- a/doc/radosgw/admin.rst
+++ b/doc/radosgw/admin.rst
@@ -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:  
@@ -738,18 +738,26 @@ specific rate limit attribute check is disabled.
 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.
 
-	radosgw-admin ratelimit set --ratelimit-scope=bucket --bucket=<bucket>
+The following is the general form of the command that returns the current
+configured limit parameters:
 
-For example:: 
+.. prompt:: bash
 
-	radosgw-admin ratelimit get --ratelimit-scope=bucket --bucket=mybucket
+   radosgw-admin ratelimit get --ratelimit-scope=bucket --bucket=<bucket>
 
+An example of using ``radosgw-admin ratelimit get`` to return the rate limit
+parameters for a bucket might look like this:
 
-A 0 value for num ops and / or num bytes means that the
-specific rate limit attribute check is disabled.
+.. prompt:: bash
+
+   radosgw-admin ratelimit get --ratelimit-scope=bucket --bucket=mybucket
+
+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