Skip to content

Commit 47fabe7

Browse files
doc/rgw: edit admin.rst - rate limit management
Edit the "Rate Limit Management" section in doc/radosgw/admin.rst. Co-authored-by: Anthony D'Atri <[email protected]> Signed-off-by: Zac Dover <[email protected]>
1 parent 08f4347 commit 47fabe7

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

doc/radosgw/admin.rst

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -584,20 +584,24 @@ commands, as in the following examples:
584584
Rate Limit Management
585585
=====================
586586

587-
Quotas may be set for The Ceph Object Gateway on users and buckets. "Rate
587+
Quotas can be set for The Ceph Object Gateway on users and buckets. The "rate
588588
limit" includes the maximum number of read operations (read ops) and write
589-
operations (write ops) per minute and the number of bytes per minute that can
590-
be written or read per user or per bucket.
589+
operations (write ops) per minute as well as the number of bytes per minute
590+
that can be written or read per user or per bucket.
591591

592+
Read Requests and Write Requests
593+
--------------------------------
592594
Operations that use the ``GET`` method or the ``HEAD`` method in their REST
593595
requests are "read requests". All other requests are "write requests".
594596

597+
How Metrics Work
598+
----------------
595599
Each object gateway tracks per-user metrics separately from bucket metrics.
596600
These metrics are not shared with other gateways. The configured limits should
597601
be divided by the number of active object gateways. For example, if "user A" is
598602
to be be limited to 10 ops per minute and there are two object gateways in the
599603
cluster, then the limit on "user A" should be ``5`` (10 ops per minute / 2
600-
RGWs). If the requests are **not** balanced between RGWs, the rate limit might
604+
RGWs). If the requests are **not** balanced between RGWs, the rate limit might
601605
be underutilized. For example: if the ops limit is ``5`` and there are two
602606
RGWs, **but** the Load Balancer sends load to only one of those RGWs, the
603607
effective limit is 5 ops, because this limit is enforced per RGW. If the rate
@@ -626,22 +630,25 @@ time has elapsed, "user A" will be able to send ``GET`` requests again.
626630
- **User:** The ``--uid`` option allows you to specify a rate limit for a
627631
user.
628632

629-
- **Maximum Read Ops:** The ``--max-read-ops`` setting allows you to specify
630-
the maximum number of read ops per minute per RGW. A 0 value disables this setting (which means unlimited access).
633+
- **Maximum Read Ops:** The ``--max-read-ops`` setting allows you to limit read
634+
bytes per minute per RGW instance. A ``0`` value disables throttling.
631635

632-
- **Maximum Read Bytes:** The ``--max-read-bytes`` setting allows you to specify
633-
the maximum number of read bytes per minute per RGW. A 0 value disables this setting (which means unlimited access).
636+
- **Maximum Read Bytes:** The ``--max-read-bytes`` setting allows you to limit
637+
read bytes per minute per RGW instance. A ``0`` value disables throttling.
634638

635639
- **Maximum Write Ops:** The ``--max-write-ops`` setting allows you to specify
636-
the maximum number of write ops per minute per RGW. A 0 value disables this setting (which means unlimited access).
640+
the maximum number of write ops per minute per RGW instance. A ``0`` value
641+
disables throttling.
637642

638-
- **Maximum Write Bytes:** The ``--max-write-bytes`` setting allows you to specify
639-
the maximum number of write bytes per minute per RGW. A 0 value disables this setting (which means unlimited access).
643+
- **Maximum Write Bytes:** The ``--max-write-bytes`` setting allows you to
644+
specify the maximum number of write bytes per minute per RGW instance. A
645+
``0`` value disables throttling.
640646

641-
- **Rate Limit Scope:** The ``--ratelimit-scope`` option sets the scope for the rate limit.
642-
The options are ``bucket`` , ``user`` and ``anonymous``. Bucket rate limit apply to buckets.
643-
The user rate limit applies to a user. Anonymous applies to an unauthenticated user.
644-
Anonymous scope is only available for global rate limit.
647+
- **Rate Limit Scope:** The ``--ratelimit-scope`` option sets the scope for the
648+
rate limit. The options are ``bucket`` , ``user`` and ``anonymous``. Bucket
649+
rate limit apply to buckets. The user rate limit applies to a user. The
650+
``anonymous`` option applies to an unauthenticated user. Anonymous scope is
651+
available only for global rate limit.
645652

646653

647654
Set User Rate Limit

0 commit comments

Comments
 (0)