Skip to content

Commit 841bc60

Browse files
committed
DOC-1631 dataplane API configure Kafka client quotas
1 parent c4f7d8f commit 841bc60

1 file changed

Lines changed: 11 additions & 8 deletions

File tree

modules/manage/pages/cluster-maintenance/manage-throughput.adoc

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
= Manage Throughput
2-
:description: Manage the throughput of Kafka traffic with configurable properties.
2+
:description: Learn how to manage the throughput of Kafka traffic.
33
:page-categories: Management, Networking
44
// tag::single-source[]
55

6-
Redpanda supports throughput throttling on both ingress and egress independently, and allows configuration at the broker and client levels. This helps prevent clients from causing unbounded network and disk usage on brokers.
7-
8-
* Broker-wide limits apply to all clients connected to the broker and restrict total traffic on the broker.
9-
* Client limits apply to a set of clients defined by their `client_id` and help prevent a set of clients from starving other clients using the same broker. You can manage client quotas with xref:reference:rpk/rpk-cluster/rpk-cluster-quotas.adoc[`rpk cluster quotas`] or with the Kafka API. When no quotas apply, the client has unlimited throughput.
6+
Redpanda supports throughput throttling on both ingress and egress independently, and allows configuration at the broker and client levels. This helps prevent clients from causing unbounded network and disk usage on brokers. You can configure limits at two levels:
107

8+
* *Broker limits*: These apply to all clients connected to the broker and restrict total traffic on the broker.
9+
ifndef::env-cloud[]
10+
* *Client limits*: These apply to a set of clients defined by their `client_id` and help prevent a set of clients from starving other clients using the same broker. You can manage client quotas with xref:reference:rpk/rpk-cluster/rpk-cluster-quotas.adoc[`rpk cluster quotas`], with {ui}, or with the Kafka API. When no quotas apply, the client has unlimited throughput.
11+
endif::[]
1112
ifdef::env-cloud[]
12-
NOTE: Throughput throttling is supported for BYOC and Dedicated clusters.
13+
* *Client limits*: These apply to a set of clients defined by their `client_id` and help prevent a set of clients from starving other clients using the same broker. You can manage client quotas with xref:reference:rpk/rpk-cluster/rpk-cluster-quotas.adoc[`rpk cluster quotas`], with the {ui} UI, with the link:/api/doc/cloud-dataplane/operation/operation-quotaservice_listquotas[Redpanda Cloud Data Plane API], or with the Kafka API. When no quotas apply, the client has unlimited throughput.
14+
15+
NOTE: Throughput throttling is supported for BYOC and Dedicated clusters only.
1316
endif::[]
1417

1518
== Throughput throttling enforcement
@@ -237,9 +240,9 @@ Replace the placeholder values with the new quota values, accounting for the con
237240
rpk cluster config set kafka_client_group_byte_rate_quota=
238241
----
239242

240-
=== View throughput limits in Redpanda Console
243+
=== View throughput limits in {ui}
241244

242-
You can also use Redpanda Console to view enforced limits. In the menu, go to **Quotas**.
245+
You can also use {ui} to view enforced limits. In the side menu, go to **Quotas**.
243246

244247
=== Monitor client throughput
245248

0 commit comments

Comments
 (0)