Skip to content

Commit 27a0fc5

Browse files
authored
Merge pull request ceph#55269 from zdover23/wip-doc-2024-01-23-radosgw-admin-read-write-global-rate-limit-config
doc/radosgw: edit "read/write global rate limit" admin.rst Reviewed-by: Anthony D'Atri <[email protected]>
2 parents e50c80d + c67a5e5 commit 27a0fc5

File tree

1 file changed

+30
-19
lines changed

1 file changed

+30
-19
lines changed

doc/radosgw/admin.rst

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -783,35 +783,46 @@ An enabled bucket rate limit can be disabled by running a command of the followi
783783

784784
radosgw-admin ratelimit disable --ratelimit-scope=bucket --uid=mybucket
785785

786-
Reading / Writing Global Rate Limit Configuration
787-
-------------------------------------------------
786+
Reading and Writing Global Rate Limit Configuration
787+
---------------------------------------------------
788788

789-
You can read and write global rate limit settings in the period configuration. To
790-
view the global rate limit settings::
789+
You can read and write global rate limit settings in the period's configuration.
790+
To view the global rate limit settings, run the following command:
791791

792-
radosgw-admin global ratelimit get
792+
.. prompt:: bash
793+
794+
radosgw-admin global ratelimit get
793795

794796
The global rate limit settings can be manipulated with the ``global ratelimit``
795-
counterparts of the ``ratelimit set``, ``ratelimit enable``, and ``ratelimit disable``
796-
commands. Per user and per bucket ratelimit configuration is overriding the global configuration::
797+
counterparts of the ``ratelimit set``, ``ratelimit enable``, and ``ratelimit
798+
disable`` commands. Per-user and per-bucket ratelimit configurations override
799+
the global configuration:
797800

798-
radosgw-admin global ratelimit set --ratelimit-scope bucket --max-read-ops=1024
799-
radosgw-admin global ratelimit enable --ratelimit-scope bucket
801+
.. prompt:: bash
800802

801-
The global rate limit can configure rate limit scope for all authenticated users::
803+
radosgw-admin global ratelimit set --ratelimit-scope bucket --max-read-ops=1024
804+
radosgw-admin global ratelimit enable --ratelimit-scope bucket
802805

803-
radosgw-admin global ratelimit set --ratelimit-scope user --max-read-ops=1024
804-
radosgw-admin global ratelimit enable --ratelimit-scope user
806+
The global rate limit can be used to configure the scope of the rate limit for
807+
all authenticated users:
808+
809+
.. prompt:: bash
805810

806-
The global rate limit can configure rate limit scope for all unauthenticated users::
811+
radosgw-admin global ratelimit set --ratelimit-scope user --max-read-ops=1024
812+
radosgw-admin global ratelimit enable --ratelimit-scope user
813+
814+
The global rate limit can be used to configure the scope of the rate limit for
815+
all unauthenticated users:
816+
817+
.. prompt:: bash
807818

808-
radosgw-admin global ratelimit set --ratelimit-scope=anonymous --max-read-ops=1024
809-
radosgw-admin global ratelimit enable --ratelimit-scope=anonymous
819+
radosgw-admin global ratelimit set --ratelimit-scope=anonymous --max-read-ops=1024
820+
radosgw-admin global ratelimit enable --ratelimit-scope=anonymous
810821

811-
.. note:: In a multisite configuration, where there is a realm and period
812-
present, changes to the global rate limit must be committed using ``period
813-
update --commit``. If there is no period present, the rados gateway(s) must
814-
be restarted for the changes to take effect.
822+
.. note:: In a multisite configuration where a realm and a period are present,
823+
any changes to the global rate limit must be committed using ``period update
824+
--commit``. If no period is present, the rados gateway(s) must be restarted
825+
for the changes to take effect.
815826

816827
Usage
817828
=====

0 commit comments

Comments
 (0)