Skip to content

Commit 4aa065f

Browse files
committed
DOC-1643 single source client connections in docs
1 parent b01d63f commit 4aa065f

File tree

2 files changed

+34
-1
lines changed

2 files changed

+34
-1
lines changed

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

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
= Configure Client Connections
22
:description: Guidelines for configuring Redpanda clusters for optimal availability.
33
:page-categories: Management, Networking
4+
// tag::single-source[]
45

56
Optimize the availability of your clusters by configuring and tuning properties.
67

@@ -10,14 +11,16 @@ A malicious Kafka client application may create many network connections to exec
1011

1112
The following Redpanda cluster properties limit the number of connections:
1213

13-
* xref:reference:cluster-properties.adoc#kafka_connections_max[`kafka_connections_max`]: Similar to Kafka's `max.connections`, this sets the maximum number of connections per broker.
1414
* xref:reference:cluster-properties.adoc#kafka_connections_max_per_ip[`kafka_connections_max_per_ip`]: Similar to Kafka's `max.connections.per.ip`, this sets the maximum number of connections accepted per IP address by a broker.
1515
* xref:reference:cluster-properties.adoc#kafka_connections_max_overrides[`kafka_connections_max_overrides`]: A list of IP addresses for which `kafka_connections_max_per_ip` is overridden and doesn't apply.
16+
ifndef::env-cloud[]
17+
* xref:reference:cluster-properties.adoc#kafka_connections_max[`kafka_connections_max`]: Similar to Kafka's `max.connections`, this sets the maximum number of connections per broker.
1618

1719
Redpanda also provides properties to manage the rate of connection creation:
1820

1921
* xref:reference:cluster-properties.adoc#kafka_connection_rate_limit[`kafka_connection_rate_limit`]: This property limits the maximum rate of connections created per second. It applies to each CPU core.
2022
* xref:reference:cluster-properties.adoc#kafka_connection_rate_limit_overrides[`kafka_connection_rate_limit_overrides`]: A list of IP addresses for which `kafka_connection_rate_limit` is overridden and doesn't apply.
23+
endif::[]
2124

2225
[NOTE]
2326
====
@@ -46,10 +49,21 @@ See also: xref:develop:produce-data/configure-producers.adoc[Configure Producers
4649

4750
A Redpanda broker may create log segments at startup. If a broker crashes after startup, and if it gets stuck in a crash loop, it could produce progressively more stored state that uses more disk space and takes more time for each restart to process.
4851

52+
ifndef::env-cloud[]
4953
To prevent infinite crash loops, the Redpanda broker property xref:reference:node-properties.adoc#crash_loop_limit[`crash_loop_limit`] sets an upper limit on the number of consecutive crashes that can happen within one hour of each other. After it reaches the limit, a broker cannot restart until its internal consecutive crash counter is reset to zero by one of the following conditions:
54+
endif::[]
55+
56+
ifdef::env-cloud[]
57+
To prevent infinite crash loops, the Redpanda broker property [`crash_loop_limit`] sets an upper limit on the number of consecutive crashes that can happen within one hour of each other. After it reaches the limit, a broker cannot restart until its internal consecutive crash counter is reset to zero by one of the following conditions:
58+
endif::[]
5059

5160
* The `redpanda.yaml` configuration file is updated.
61+
ifndef::env-cloud[]
5262
* The `startup_log` file in the broker's xref:reference:node-properties.adoc#data_directory[data_directory] is manually deleted.
63+
endif::[]
64+
ifdef::env-cloud[]
65+
* The `startup_log` file in the broker's `data_directory` is manually deleted.
66+
endif::[]
5367
* One hour has elapsed since the last crash.
5468
* The broker is properly shut down. (This is not possible after `crash_loop_limit` has been reached and the broker cannot be restarted.)
5569

@@ -59,4 +73,12 @@ To prevent infinite crash loops, the Redpanda broker property xref:reference:nod
5973
* If the limit is less than two, the broker is blocked from restarting after every crash, until one of the reset conditions is met.
6074
====
6175

76+
ifndef::env-cloud[]
6277
To facilitate debugging in environments where a broker is stuck in a crash loop, set the xref:reference:properties/broker-properties.adoc#crash_loop_sleep_sec[`crash_loop_sleep_sec` configuration]. This setting determines how long the broker sleeps before terminating the process after reaching the crash loop limit. The window during which the broker remains available allows you to troubleshoot the issue. This setting is most useful when xref:troubleshoot:errors-solutions/k-resolve-errors.adoc[troubleshooting in Kubernetes environments].
78+
endif::[]
79+
80+
ifdef::env-cloud[]
81+
To facilitate debugging in environments where a broker is stuck in a crash loop, set the `crash_loop_sleep_sec` configuration. This setting determines how long the broker sleeps before terminating the process after reaching the crash loop limit. The window during which the broker remains available allows you to troubleshoot the issue.
82+
endif::[]
83+
84+
// end::single-source[]

modules/reference/pages/properties/cluster-properties.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2862,6 +2862,7 @@ Maximum number of Kafka client connections per broker. If `null`, the property i
28622862

28632863
---
28642864

2865+
// tag::kafka_connections_max_overrides[]
28652866
=== kafka_connections_max_overrides
28662867

28672868
A list of IP addresses for which Kafka client connection limits are overridden and don't apply. For example, `(['127.0.0.1:90', '50.20.1.1:40']).`.
@@ -2872,14 +2873,20 @@ A list of IP addresses for which Kafka client connection limits are overridden a
28722873

28732874
*Type:* array
28742875

2876+
ifndef::env-cloud[]
28752877
*Default*: `{}` (empty list)
2878+
endif::[]
28762879

28772880
*Related topics*:
28782881

28792882
* xref:manage:cluster-maintenance/configure-availability.adoc#limit-client-connections[Limit client connections]
28802883

28812884
---
28822885

2886+
2887+
// end::kafka_connections_max_overrides[]
2888+
2889+
// tag::kafka_connections_max_per_ip[]
28832890
=== kafka_connections_max_per_ip
28842891

28852892
Maximum number of Kafka client connections per IP address, per broker. If `null`, the property is disabled.
@@ -2892,14 +2899,18 @@ Maximum number of Kafka client connections per IP address, per broker. If `null`
28922899

28932900
*Accepted values:* [`0`, `4294967295`]
28942901

2902+
ifndef::env-cloud[]
28952903
*Default:* `null`
2904+
endif::[]
28962905

28972906
*Related topics*:
28982907

28992908
* xref:manage:cluster-maintenance/configure-availability.adoc#limit-client-connections[Limit client connections]
29002909

29012910
---
29022911

2912+
// end::kafka_connections_max_per_ip[]
2913+
29032914
=== kafka_enable_authorization
29042915

29052916
Flag to require authorization for Kafka connections. If `null`, the property is disabled, and authorization is instead enabled by <<enable_sasl,`enable_sasl`>>.

0 commit comments

Comments
 (0)