summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorZac Dover <zac.dover@proton.me>2024-01-16 11:37:17 +0100
committerZac Dover <zac.dover@proton.me>2024-01-16 11:37:17 +0100
commita1fca50dfdcb30e58ebcc4ef60ef921b977efc81 (patch)
treeeed0b8d37b9e1eeb243969c5274abbbf29ae7c40 /doc
parentMerge pull request #55143 from afreen23/main (diff)
downloadceph-a1fca50dfdcb30e58ebcc4ef60ef921b977efc81.tar.xz
ceph-a1fca50dfdcb30e58ebcc4ef60ef921b977efc81.zip
doc/radosgw: edit "Enable/Disable Bucket Rate Limit"
Edit "Enable/Disable Bucket Rate Limit" in doc/radosgw/admin.rst. Signed-off-by: Zac Dover <zac.dover@proton.me>
Diffstat (limited to 'doc')
-rw-r--r--doc/radosgw/admin.rst17
1 files changed, 11 insertions, 6 deletions
diff --git a/doc/radosgw/admin.rst b/doc/radosgw/admin.rst
index 57d38c97ab2..03dad19c2a9 100644
--- a/doc/radosgw/admin.rst
+++ b/doc/radosgw/admin.rst
@@ -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
-------------------------------------------------