From e8cd1e80108c6625f6d1bd7a7f6b41dfc3c5c5a5 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Mon, 15 Jan 2024 09:29:23 +1000 Subject: [PATCH] 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 Signed-off-by: Zac Dover (cherry picked from commit 7c4fdd3762831cb86993b1b4a814ea68a9ea2401) --- doc/radosgw/admin.rst | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/doc/radosgw/admin.rst b/doc/radosgw/admin.rst index 4fb8ffe749abe..8b8c74de4cae3 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= +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= +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 -- 2.39.5