From d1a281f130b24ce8d2c18e7f6476527bdfc0f5ba Mon Sep 17 00:00:00 2001 From: micheleRP Date: Thu, 14 Aug 2025 11:44:53 -0600 Subject: [PATCH 01/12] DOC-1587 Conditionalize Manage Throughput for Cloud --- modules/manage/pages/cluster-maintenance/manage-throughput.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc index c3e5ac8242..99595081a9 100644 --- a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc +++ b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc @@ -1,6 +1,7 @@ = Manage Throughput :description: Manage the throughput of Kafka traffic with configurable properties. :page-categories: Management, Networking +// tag::single-source[] Redpanda supports applying throughput throttling on both ingress and egress independently, and allows configuration at the broker and client levels. The purpose of this is to prevent unbounded network and disk usage of the broker by clients. Broker-wide limits apply to all clients connected to the broker and restrict total traffic on the broker. 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. @@ -242,3 +243,4 @@ TRACE 2024-06-14 15:37:59,195 [shard 2:main] kafka_quotas - quota_manager.cc:36 TRACE 2024-06-14 15:37:59,195 [shard 2:main] kafka_quotas - connection_context.cc:605 - [127.0.0.1:58636] throttle request:{snc:0, client:184}, enforce:{snc:-14359, client:-14359}, key:0, request_size:1316 ---- +// end::single-source[] From f23b80410d032d095bb0d156ca32cc5886115f30 Mon Sep 17 00:00:00 2001 From: micheleRP Date: Thu, 14 Aug 2025 11:54:20 -0600 Subject: [PATCH 02/12] update playbook --- local-antora-playbook.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/local-antora-playbook.yml b/local-antora-playbook.yml index e15360d1a9..6629d78fa6 100644 --- a/local-antora-playbook.yml +++ b/local-antora-playbook.yml @@ -17,7 +17,7 @@ content: - url: https://github.com/redpanda-data/docs branches: [v/*, api, shared, site-search,'!v-end-of-life/*'] - url: https://github.com/redpanda-data/cloud-docs - branches: 'main' + branches: 'DOC-1586-single-source-Manage-Throughput-in-cloud-docs' - url: https://github.com/redpanda-data/redpanda-labs branches: main start_paths: [docs,'*/docs'] From dba57035611821332e1dc080dd3a3f2bcc918dce Mon Sep 17 00:00:00 2001 From: micheleRP Date: Thu, 14 Aug 2025 12:53:54 -0600 Subject: [PATCH 03/12] conditionalize out content not supported in Cloud --- .../manage-throughput.adoc | 25 +++++++++++++++---- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc index 99595081a9..43d1925955 100644 --- a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc +++ b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc @@ -9,12 +9,17 @@ Redpanda supports applying throughput throttling on both ingress and egress inde NOTE: As of v24.2, Redpanda enforces all throughput limits per broker, including client throughput. -Throughput limits are enforced by applying backpressure to clients. When a connection is in breach of the throughput limit, the throttler advises the client about the delay (throttle time) that would bring the rate back to the allowed level. Redpanda starts by adding a `throttle_time_ms` field to responses. If that isn't honored, delays are inserted on the connection's next read operation. The throttling delay may not exceed the limit set by xref:reference:tunable-properties.adoc#max_kafka_throttle_delay_ms[`max_kafka_throttle_delay_ms`]. +Throughput limits are enforced by applying backpressure to clients. When a connection is in breach of the throughput limit, the throttler advises the client about the delay (throttle time) that would bring the rate back to the allowed level. Redpanda starts by adding a `throttle_time_ms` field to responses. If that isn't honored, delays are inserted on the connection's next read operation. + +ifndef::env-cloud[] +The throttling delay may not exceed the limit set by xref:reference:tunable-properties.adoc#max_kafka_throttle_delay_ms[`max_kafka_throttle_delay_ms`]. +endif::[] == Broker-wide throughput limits Broker-wide throughput limits account for all Kafka API traffic going into or out of the broker, as data is produced to or consumed from a topic. The limit values represent the allowed rate of data in bytes per second passing through in each direction. Redpanda also provides administrators the ability to exclude clients from throughput throttling and to fine-tune which Kafka request types are subject to throttling limits. +ifndef::env-cloud[] === Broker-wide throughput limit properties The properties for broker-wide throughput quota balancing are configured at the cluster level, for all brokers in a cluster: @@ -41,8 +46,9 @@ The properties for broker-wide throughput quota balancing are configured at the [NOTE] ==== -* By default, both `kafka_throughput_limit_node_in_bps` and `kafka_throughput_limit_node_out_bps` are disabled, and no throughput limits are applied. You must manually set them to enable throughput throttling. +By default, both `kafka_throughput_limit_node_in_bps` and `kafka_throughput_limit_node_out_bps` are disabled, and no throughput limits are applied. You must manually set them to enable throughput throttling. ==== +endif::[] == Client throughput limits @@ -72,12 +78,13 @@ It is possible to create conflicting quotas if you configure the same quotas thr . Quota configured through the Kafka API for an exact match on `client_id` . Quota configured through the Kafka API for a prefix match on `client_id` -. Quota configured through cluster configuration properties (`kafka_client_group_byte_rate_quota`, `kafka_client_group_fetch_byte_rate_quota`, xref:upgrade:deprecated/index.adoc[deprecated starting in v24.2]) for a prefix match on `client_id` +. Quota configured through cluster configuration properties (`kafka_client_group_byte_rate_quota`, `kafka_client_group_fetch_byte_rate_quota`-deprecated starting in v24.2) for a prefix match on `client_id` . Default quota configured through the Kafka API on `client_id` -. Default quota configured through cluster configuration properties (`target_quota_byte_rate`, `target_fetch_quota_byte_rate`, `kafka_admin_topic_api_rate`, xref:upgrade:deprecated/index.adoc[deprecated starting in v24.2]) on `client_id` +. Default quota configured through cluster configuration properties (`target_quota_byte_rate`, `target_fetch_quota_byte_rate`, `kafka_admin_topic_api_rate`-deprecated starting in v24.2) on `client_id` Redpanda recommends <> over from cluster configuration-managed quotas to Kafka-compatible quotas. You can re-create the configuration-based quotas with `rpk`, and then remove the cluster configurations. +ifndef::env-cloud[] === Individual client throughput limit To view current throughput quotas set through the Kafka API, run xref:reference:rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc[`rpk cluster quotas describe`]. @@ -95,6 +102,7 @@ client-id=consumer-1 producer_byte_rate=140000 ---- + To set a throughput quota for a single client, use the xref:reference:rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc[`rpk cluster quotas alter`] command. [,bash] @@ -119,6 +127,7 @@ rpk cluster quotas alter --add consumer_byte_rate=200000 --name client-id-prefix NOTE: A client group specified with `client-id-prefix` is not the equivalent of a Kafka consumer group. It is used only to match requests based on the `client_id` prefix. The `client_id` field is typically a configurable property when you create a client with Kafka libraries. + === Default client throughput limit You can apply default throughput limits to clients. Redpanda applies the default limits if no quotas are configured for a specific `client_id` or prefix. @@ -217,20 +226,26 @@ Replace the placeholder values with the new quota values, accounting for the con rpk cluster config set kafka_client_group_byte_rate_quota= ---- +endif::[] + === View throughput limits in Redpanda Console You can also use Redpanda Console to view enforced limits. In the menu, go to **Quotas**. === Monitor client throughput -The following metrics are available on both the `/public_metrics` and `/metrics` endpoints to provide insights into client throughput quota usage: +The following metrics provide insights into client throughput quota usage: * Client quota throughput per rule and quota type: ** `/public_metrics` - xref:reference:public-metrics-reference.adoc#redpanda_kafka_quotas_client_quota_throughput[`redpanda_kafka_quotas_client_quota_throughput`] +ifndef::env-cloud[] ** `/metrics` - xref:reference:internal-metrics-reference.adoc#vectorized_kafka_quotas_client_quota_throughput[`vectorized_kafka_quotas_client_quota_throughput`] +endif::[] * Client quota throttling delay per rule and quota type, in seconds: ** `/public_metrics` - xref:reference:public-metrics-reference.adoc#redpanda_kafka_quotas_client_quota_throttle_time[`redpanda_kafka_quotas_client_quota_throttle_time`] +ifndef::env-cloud[] ** `/metrics` - xref:reference:internal-metrics-reference.adoc#vectorized_kafka_quotas_client_quota_throttle_time[`vectorized_kafka_quotas_client_quota_throttle_time`] +endif::[] The `kafka_quotas` logger provides details at the trace level on client quota throttling: From 94ae158009a2df573b514c8b5517aac31a32412a Mon Sep 17 00:00:00 2001 From: micheleRP Date: Thu, 14 Aug 2025 13:10:27 -0600 Subject: [PATCH 04/12] single source rpk cluster quotas --- .../pages/cluster-maintenance/manage-throughput.adoc | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc index 43d1925955..fad9c8ff56 100644 --- a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc +++ b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc @@ -5,6 +5,10 @@ Redpanda supports applying throughput throttling on both ingress and egress independently, and allows configuration at the broker and client levels. The purpose of this is to prevent unbounded network and disk usage of the broker by clients. Broker-wide limits apply to all clients connected to the broker and restrict total traffic on the broker. 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. +ifdef::env-cloud[] +NOTE: Throughput throttling is supported for BYOC and Dedicated clusters. +endif::[] + == Throughput throttling enforcement NOTE: As of v24.2, Redpanda enforces all throughput limits per broker, including client throughput. @@ -84,7 +88,6 @@ It is possible to create conflicting quotas if you configure the same quotas thr Redpanda recommends <> over from cluster configuration-managed quotas to Kafka-compatible quotas. You can re-create the configuration-based quotas with `rpk`, and then remove the cluster configurations. -ifndef::env-cloud[] === Individual client throughput limit To view current throughput quotas set through the Kafka API, run xref:reference:rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc[`rpk cluster quotas describe`]. @@ -226,8 +229,6 @@ Replace the placeholder values with the new quota values, accounting for the con rpk cluster config set kafka_client_group_byte_rate_quota= ---- -endif::[] - === View throughput limits in Redpanda Console You can also use Redpanda Console to view enforced limits. In the menu, go to **Quotas**. From 836654f3beee5017230a38fc0db7b7284eebcee6 Mon Sep 17 00:00:00 2001 From: micheleRP Date: Thu, 14 Aug 2025 13:18:00 -0600 Subject: [PATCH 05/12] single source rpk cluster quotas --- .../pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc | 6 ++++-- .../pages/rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc | 6 ++++-- .../pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc | 3 +++ .../reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc | 6 ++++-- 4 files changed, 15 insertions(+), 6 deletions(-) diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc index 8704b157af..9a0dc5a616 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc @@ -1,5 +1,5 @@ = rpk cluster quotas alter -:description: rpk cluster quotas alter +// tag::single-source[] Add or delete a client quota. @@ -74,4 +74,6 @@ Remove quota (producer_byte_rate) from client ID `foo`: [,bash] ---- rpk cluster quotas alter --delete producer_byte_rate --name client-id= ----- \ No newline at end of file +---- + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc index c7701067d1..b8e7422c2e 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc @@ -1,5 +1,5 @@ = rpk cluster quotas describe -:description: rpk cluster quotas describe +// tag::single-source[] Describe client quotas. @@ -64,4 +64,6 @@ Describe client quotas for a given client ID prefix `.`: [,bash] ---- rpk cluster quotas describe --name client-id=. ----- \ No newline at end of file +---- + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc index 06e4187258..b94777cb7c 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc @@ -1,4 +1,5 @@ = rpk cluster quotas import +// tag::single-source[] Use this command to import client quotas in the format produced by `rpk cluster quotas describe --format json/yaml`. @@ -150,3 +151,5 @@ quotas: value: "140000" ' ---- + +// end::single-source[] \ No newline at end of file diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc index ccb2009623..5961f9c2be 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc @@ -1,5 +1,5 @@ = rpk cluster quotas -:description: rpk cluster quotas +// tag::single-source[] Manage Redpanda client quotas. @@ -34,4 +34,6 @@ quotas, quota |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. -|=== \ No newline at end of file +|=== + +// end::single-source[] \ No newline at end of file From 2fe04ab8cf03fac2bb0bb46ebec1f71f7198f86a Mon Sep 17 00:00:00 2001 From: micheleRP Date: Fri, 15 Aug 2025 14:00:31 -0600 Subject: [PATCH 06/12] add UI option --- .../manage/pages/cluster-maintenance/manage-throughput.adoc | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc index fad9c8ff56..b840249093 100644 --- a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc +++ b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc @@ -5,6 +5,8 @@ Redpanda supports applying throughput throttling on both ingress and egress independently, and allows configuration at the broker and client levels. The purpose of this is to prevent unbounded network and disk usage of the broker by clients. Broker-wide limits apply to all clients connected to the broker and restrict total traffic on the broker. 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`], with the Kafka API, or on the **Quotas** page in {ui}. You can enter a client ID to see which quotas apply and their effective limits based on precedence rules. If no quotas apply, then the client will have unlimited throughput. + ifdef::env-cloud[] NOTE: Throughput throttling is supported for BYOC and Dedicated clusters. endif::[] @@ -82,9 +84,9 @@ It is possible to create conflicting quotas if you configure the same quotas thr . Quota configured through the Kafka API for an exact match on `client_id` . Quota configured through the Kafka API for a prefix match on `client_id` -. Quota configured through cluster configuration properties (`kafka_client_group_byte_rate_quota`, `kafka_client_group_fetch_byte_rate_quota`-deprecated starting in v24.2) for a prefix match on `client_id` +. Quota configured through cluster configuration properties (`kafka_client_group_byte_rate_quota`, `kafka_client_group_fetch_byte_rate_quota`-deprecated in v24.2) for a prefix match on `client_id` . Default quota configured through the Kafka API on `client_id` -. Default quota configured through cluster configuration properties (`target_quota_byte_rate`, `target_fetch_quota_byte_rate`, `kafka_admin_topic_api_rate`-deprecated starting in v24.2) on `client_id` +. Default quota configured through cluster configuration properties (`target_quota_byte_rate`, `target_fetch_quota_byte_rate`, `kafka_admin_topic_api_rate`-deprecated in v24.2) on `client_id` Redpanda recommends <> over from cluster configuration-managed quotas to Kafka-compatible quotas. You can re-create the configuration-based quotas with `rpk`, and then remove the cluster configurations. From 7e4c92b395f36e87cf59497ab22b16fe3611caa1 Mon Sep 17 00:00:00 2001 From: micheleRP Date: Fri, 15 Aug 2025 14:23:54 -0600 Subject: [PATCH 07/12] format list --- .../manage/pages/cluster-maintenance/manage-throughput.adoc | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc index b840249093..02eb1593d8 100644 --- a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc +++ b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc @@ -3,9 +3,10 @@ :page-categories: Management, Networking // tag::single-source[] -Redpanda supports applying throughput throttling on both ingress and egress independently, and allows configuration at the broker and client levels. The purpose of this is to prevent unbounded network and disk usage of the broker by clients. Broker-wide limits apply to all clients connected to the broker and restrict total traffic on the broker. 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. +Redpanda supports applying throughput throttling on both ingress and egress independently, and allows configuration at the broker and client levels. The purpose of this is to prevent unbounded network and disk usage of the broker by clients. -You can manage client quotas with xref:reference:rpk/rpk-cluster/rpk-cluster-quotas.adoc[`rpk cluster quotas`], with the Kafka API, or on the **Quotas** page in {ui}. You can enter a client ID to see which quotas apply and their effective limits based on precedence rules. If no quotas apply, then the client will have unlimited throughput. +* Broker-wide limits apply to all clients connected to the broker and restrict total traffic on the broker. +* 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`], with the Kafka API, or on the **Quotas** page in {ui}. When no quotas apply, the client has unlimited throughput. ifdef::env-cloud[] NOTE: Throughput throttling is supported for BYOC and Dedicated clusters. From 6e62044036454f5824f91689c4bab06446011d21 Mon Sep 17 00:00:00 2001 From: micheleRP Date: Fri, 15 Aug 2025 17:03:05 -0600 Subject: [PATCH 08/12] conditionalize out steps with properties --- .../manage/pages/cluster-maintenance/manage-throughput.adoc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc index 02eb1593d8..3507fd0198 100644 --- a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc +++ b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc @@ -85,9 +85,13 @@ It is possible to create conflicting quotas if you configure the same quotas thr . Quota configured through the Kafka API for an exact match on `client_id` . Quota configured through the Kafka API for a prefix match on `client_id` +ifndef::env-cloud[] . Quota configured through cluster configuration properties (`kafka_client_group_byte_rate_quota`, `kafka_client_group_fetch_byte_rate_quota`-deprecated in v24.2) for a prefix match on `client_id` +endif::[] . Default quota configured through the Kafka API on `client_id` +ifndef::env-cloud[] . Default quota configured through cluster configuration properties (`target_quota_byte_rate`, `target_fetch_quota_byte_rate`, `kafka_admin_topic_api_rate`-deprecated in v24.2) on `client_id` +endif::[] Redpanda recommends <> over from cluster configuration-managed quotas to Kafka-compatible quotas. You can re-create the configuration-based quotas with `rpk`, and then remove the cluster configurations. From 38b65880e64aa231ed574debc2f92421a35e3f1e Mon Sep 17 00:00:00 2001 From: micheleRP Date: Fri, 15 Aug 2025 20:12:38 -0600 Subject: [PATCH 09/12] rebuild with what's new --- modules/manage/pages/cluster-maintenance/manage-throughput.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc index 3507fd0198..93eaed5c7b 100644 --- a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc +++ b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc @@ -3,7 +3,7 @@ :page-categories: Management, Networking // tag::single-source[] -Redpanda supports applying throughput throttling on both ingress and egress independently, and allows configuration at the broker and client levels. The purpose of this is to prevent unbounded network and disk usage of the broker by clients. +Redpanda supports applying throughput throttling on both ingress and egress independently, and allows configuration at the broker and client levels. The purpose of this is to prevent unbounded network and disk usage of the broker by clients. * Broker-wide limits apply to all clients connected to the broker and restrict total traffic on the broker. * 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`], with the Kafka API, or on the **Quotas** page in {ui}. When no quotas apply, the client has unlimited throughput. From 6e2ca52118da4a198616b1a6ae37eedb4ceb2d7c Mon Sep 17 00:00:00 2001 From: micheleRP Date: Mon, 18 Aug 2025 07:56:33 -0600 Subject: [PATCH 10/12] take out UI --- modules/manage/pages/cluster-maintenance/manage-throughput.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc index 93eaed5c7b..bcfb139e9d 100644 --- a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc +++ b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc @@ -6,7 +6,7 @@ Redpanda supports applying throughput throttling on both ingress and egress independently, and allows configuration at the broker and client levels. The purpose of this is to prevent unbounded network and disk usage of the broker by clients. * Broker-wide limits apply to all clients connected to the broker and restrict total traffic on the broker. -* 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`], with the Kafka API, or on the **Quotas** page in {ui}. When no quotas apply, the client has unlimited throughput. +* 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. ifdef::env-cloud[] NOTE: Throughput throttling is supported for BYOC and Dedicated clusters. From e304e7ef28d749815af6352e0a50f46b2b366d8a Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Mon, 18 Aug 2025 20:11:32 -0600 Subject: [PATCH 11/12] Update modules/manage/pages/cluster-maintenance/manage-throughput.adoc Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com> --- modules/manage/pages/cluster-maintenance/manage-throughput.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc index bcfb139e9d..e03c3a7c07 100644 --- a/modules/manage/pages/cluster-maintenance/manage-throughput.adoc +++ b/modules/manage/pages/cluster-maintenance/manage-throughput.adoc @@ -3,7 +3,7 @@ :page-categories: Management, Networking // tag::single-source[] -Redpanda supports applying throughput throttling on both ingress and egress independently, and allows configuration at the broker and client levels. The purpose of this is to prevent unbounded network and disk usage of the broker by clients. +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. * Broker-wide limits apply to all clients connected to the broker and restrict total traffic on the broker. * 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. From 8c92220303dda0441dc532343fe9465d0d64d984 Mon Sep 17 00:00:00 2001 From: micheleRP Date: Mon, 18 Aug 2025 20:20:42 -0600 Subject: [PATCH 12/12] fix typo in formatting + revert playbook --- local-antora-playbook.yml | 2 +- .../pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/local-antora-playbook.yml b/local-antora-playbook.yml index 6629d78fa6..e15360d1a9 100644 --- a/local-antora-playbook.yml +++ b/local-antora-playbook.yml @@ -17,7 +17,7 @@ content: - url: https://github.com/redpanda-data/docs branches: [v/*, api, shared, site-search,'!v-end-of-life/*'] - url: https://github.com/redpanda-data/cloud-docs - branches: 'DOC-1586-single-source-Manage-Throughput-in-cloud-docs' + branches: 'main' - url: https://github.com/redpanda-data/redpanda-labs branches: main start_paths: [docs,'*/docs'] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc index b94777cb7c..d2c1e6c640 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc @@ -44,7 +44,7 @@ JSON:: ---- ====== -Use the '--no-confirm' flag if you wish to avoid the confirmation prompt. +Use the `--no-confirm` flag to avoid the confirmation prompt. == Usage