From c7d29205dc57438889a6977f1735800eabbe4bb7 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Thu, 11 Jan 2024 18:32:09 +1000 Subject: [PATCH] doc/radosgw - edit admin.rst "set user rate limit" Edit "Set User Rate Limit" in doc/radosgw/admin.rst. Signed-off-by: Zac Dover (cherry picked from commit 8660b4edc71113d5d2d51438c9fd6f388b35a214) --- doc/radosgw/admin.rst | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/doc/radosgw/admin.rst b/doc/radosgw/admin.rst index 88a7215fb1563..a178d69421fb2 100644 --- a/doc/radosgw/admin.rst +++ b/doc/radosgw/admin.rst @@ -654,19 +654,27 @@ time has elapsed, "user A" will be able to send ``GET`` requests again. Set User Rate Limit ------------------- -Before you enable a rate limit, you must first set the rate limit parameters. -For example:: +Before you can enable a rate limit, you must first set the rate limit +parameters. The following is the general form of commands that set rate limit +parameters: - radosgw-admin ratelimit set --ratelimit-scope=user --uid= <[--max-read-ops=] [--max-read-bytes=] - [--max-write-ops=] [--max-write-bytes=]> +.. prompt:: bash -For example:: + radosgw-admin ratelimit set --ratelimit-scope=user --uid= + <[--max-read-ops=] [--max-read-bytes=] + [--max-write-ops=] [--max-write-bytes=]> - radosgw-admin ratelimit set --ratelimit-scope=user --uid=johndoe --max-read-ops=1024 --max-write-bytes=10240 +An example of using ``radosgw-admin ratelimit set`` to set a rate limit might +look like this: +.. prompt:: bash -A 0 value for num ops and / or num bytes means that the -specific rate limit attribute check is disabled. + radosgw-admin ratelimit set --ratelimit-scope=user --uid=johndoe --max-read-ops=1024 --max-write-bytes=10240 + + +A value of ``0`` assigned to ``--max-read-ops``, ``--max-read-bytes``, +``--max-write-ops``, or ``--max-write-bytes`` disables the specified rate +limit. Get User Rate Limit ------------------- -- 2.39.5