From 36d35dbbf4b1889f6e87a44406569648a2407db8 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Sun, 14 Jan 2024 20:23:25 +1000 Subject: [PATCH] doc/radosgw: edit admin.rst "set bucket rate limit" Edit "Set Bucket Rate Limit" in doc/radosgw/admin.rst. Signed-off-by: Zac Dover (cherry picked from commit e9b3ef4cb11760392ff7f766d652289636fcf5eb) --- doc/radosgw/admin.rst | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/doc/radosgw/admin.rst b/doc/radosgw/admin.rst index 4fb8ffe749abe..fe8e84b050622 100644 --- a/doc/radosgw/admin.rst +++ b/doc/radosgw/admin.rst @@ -722,18 +722,24 @@ Set Bucket Rate Limit --------------------- Before you enable a rate limit, you must first set the rate limit parameters. -For example:: +The following is the general form of commands that set rate limit parameters: + +.. prompt:: bash - radosgw-admin ratelimit set --ratelimit-scope=bucket --bucket= <[--max-read-ops=] [--max-read-bytes=] + radosgw-admin ratelimit set --ratelimit-scope=bucket --bucket= <[--max-read-ops=] [--max-read-bytes=] [--max-write-ops=] [--max-write-bytes=]> -For example:: +An example of using ``radosgw-admin ratelimit set`` to set a rate limit for a +bucket might look like this: - radosgw-admin ratelimit set --ratelimit-scope=bucket --bucket=mybucket --max-read-ops=1024 --max-write-bytes=10240 +.. prompt:: bash + radosgw-admin ratelimit set --ratelimit-scope=bucket --bucket=mybucket --max-read-ops=1024 --max-write-bytes=10240 -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 bucket rate +limit. Get Bucket Rate Limit --------------------- -- 2.39.5