Skip to content

Commit f4f5931

Browse files
authored
DOC-1684 update config client connections (#1364)
1 parent 9ff4a5a commit f4f5931

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

modules/manage/pages/cluster-maintenance/configure-availability.adoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Optimize the availability of your clusters by configuring and tuning properties.
77

88
== Limit client connections
99

10-
A malicious Kafka client application may create many network connections to execute its attacks. A poorly configured application may also create an excessive number of connections. To mitigate the risk of a client creating too many connections and using too many system resources, you can configure a Redpanda cluster to impose limits on the number of created client connections.
10+
To mitigate the risk of a client creating too many connections and using too many system resources, you can configure a Redpanda cluster to impose limits on the number of client connections that can be created.
1111

1212
The following Redpanda cluster properties limit the number of connections:
1313

@@ -31,10 +31,12 @@ endif::[]
3131
ifdef::env-cloud[]
3232
=== Configure connection count limit by client IP
3333

34-
Use the `kafka_connections_max_per_ip` property to limit the number of connections from each client IP address.
34+
Configure the `kafka_connections_max_per_ip` property to limit the number of connections from each client IP address.
3535

3636
IMPORTANT: Per-IP connection controls require Redpanda to see individual client IPs. If clients connect through private link endpoints, NAT gateways, or other shared-IP egress, the per-IP limit applies to the shared IP, affecting all clients behind it and preventing isolation of a single offending client. Similarly, multiple clients running on the same host will share the same IP address, and the limit applies collectively to all those clients.
3737

38+
See also: xref:manage:cluster-maintenance/config-cluster.adoc[]
39+
3840
==== Configure the limit
3941

4042
To configure `kafka_connections_max_per_ip` safely without disrupting legitimate clients, follow these steps:
@@ -51,10 +53,12 @@ redpanda_rpc_active_connections{redpanda_id="CLOUD_CLUSTER_ID", redpanda_server=
5153
+
5254
image::shared:monitor_connections.png[Range of active connections over time]
5355

54-
. Set the `kafka_connections_max_per_ip` value based on your analysis. Use the upper bound of normal connections from step 3, or use a lower value if you know how many connections per client IP are being opened.
56+
. Set the `kafka_connections_max_per_ip` value based on your analysis. Use the upper bound of normal connections observed, or use a lower value if you know how many connections per client IP are being opened.
5557

5658
. Continue monitoring the connection metrics after applying the limit to ensure that legitimate clients are not affected and that the problematic client is properly controlled.
5759

60+
NOTE: If you find a high load of unexpected connections from multiple IP addresses, `kafka_connections_max_per_ip` alone may be insufficient. If offending IPs outnumber legitimate client IPs, you may need to set `kafka_connections_max_per_ip` so low that it affects legitimate clients. If this is the case, use `kafka_connections_max_overrides` to exempt known legitimate client IPs from the connection limit.
61+
5862
==== Limitations
5963

6064
* Decreasing the limit does not terminate any currently open Kafka API connections.

0 commit comments

Comments
 (0)