]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc/radosgw: edit "Enable/Disable Bucket Rate Limit"
authorZac Dover <zac.dover@proton.me>
Tue, 16 Jan 2024 10:37:17 +0000 (20:37 +1000)
committerZac Dover <zac.dover@proton.me>
Tue, 16 Jan 2024 10:37:17 +0000 (20:37 +1000)
Edit "Enable/Disable Bucket Rate Limit" in doc/radosgw/admin.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
doc/radosgw/admin.rst

index 57d38c97ab2fffbd4a22e8117d35c771097846f7..03dad19c2a92f5ea6a0acbe1b214ad03a0121b55 100644 (file)
@@ -747,17 +747,22 @@ A 0 value for num ops and / or num bytes means that the
 specific rate limit attribute check is disabled.
 
 
-Enable/Disable Bucket Rate Limit
---------------------------------
+Enable and Disable Bucket Rate Limit
+------------------------------------
+
+After you set a bucket rate limit, you can enable it. The following is the
+general form of the ``radosgw-admin ratelimit enable`` command that enables
+bucket rate limits: 
 
-Once you set a bucket rate limit, you may enable it. For example:: 
+.. prompt:: bash
 
-       radosgw-admin ratelimit enable --ratelimit-scope=bucket --bucket=<bucket>
+   radosgw-admin ratelimit enable --ratelimit-scope=bucket --bucket=<bucket>
 
-You may disable an enabled bucket rate limit. For example:: 
+An enabled bucket rate limit can be disabled by running a command of the following form:
 
-       radosgw-admin ratelimit disable --ratelimit-scope=bucket --uid=mybucket
+.. prompt:: bash
 
+   radosgw-admin ratelimit disable --ratelimit-scope=bucket --uid=mybucket
 
 Reading / Writing Global Rate Limit Configuration
 -------------------------------------------------