Skip to content

Commit

Permalink
QOL existing properties
Browse files Browse the repository at this point in the history
  • Loading branch information
Deflaimun committed Oct 21, 2024
1 parent 08d5253 commit f65968e
Show file tree
Hide file tree
Showing 3 changed files with 244 additions and 68 deletions.
10 changes: 0 additions & 10 deletions modules/reference/pages/properties/broker-properties.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ NOTE: All broker properties require that you restart Redpanda for any update to

Network address for the glossterm:Admin API[] server.

*Optional:* Yes

*Visibility:* `user`

*Default:* `127.0.0.1:9644`
Expand Down Expand Up @@ -59,8 +57,6 @@ The crash-tracking logic is reset (to zero consecutive crashes) by any of the fo

*Unit*: number of consecutive crashes of a broker

*Optional:* No

*Visibility:* `user`

*Type:* integer
Expand Down Expand Up @@ -117,8 +113,6 @@ Controls how a new cluster is formed. All brokers in a cluster must have the sam

TIP: For backward compatibility, `true` is the default. Redpanda recommends using `false` in production environments to prevent accidental cluster formation.

*Optional:* Yes

*Visibility:* `user`

*Type:* boolean
Expand All @@ -137,8 +131,6 @@ Controls whether Redpanda starts in FIPS mode. This property allows for three v

* Enabled - Redpanda verifies that the operating system is enabled for FIPS by checking `/proc/sys/crypto/fips_enabled`. If the file does not exist or does not return `1`, Redpanda immediately exits.

*Optional:* No

*Visibility:* `user`

*Accepted values:* `0` (disabled), `1` (permissive), `2` (enabled)
Expand Down Expand Up @@ -290,8 +282,6 @@ Only one broker, the designated cluster root, should have an empty `seed_servers
The `seed_servers` list must be consistent across all seed brokers to prevent cluster fragmentation and ensure stable cluster formation.
====

*Optional:* Yes

*Visibility:* `user`

*Type:* array
Expand Down
179 changes: 122 additions & 57 deletions modules/reference/pages/properties/cluster-properties.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -898,13 +898,25 @@ Default quota tracking window size in milliseconds.

---

=== disable_batch_cache
=== development_enable_cloud_topics

Disable batch cache in log manager.
Enable cloud topics.

*Requires restart:* No

*Optional:* Yes
*Visibility:* `user`

*Type:* boolean

*Default:* `false`

---

=== disable_batch_cache

Disable batch cache in log manager.

*Requires restart:* Yes

*Visibility:* `tunable`

Expand All @@ -916,7 +928,9 @@ Disable batch cache in log manager.

=== disable_cluster_recovery_loop_for_tests

Disables the cluster recovery loop. This property is used to simplify testing and should not be set in production.
include::reference:partial$internal-use-property.adoc[]

Disables the cluster recovery loop.

*Requires restart:* No

Expand Down Expand Up @@ -1019,7 +1033,7 @@ Enable idempotent producers.

=== enable_leader_balancer

Enable automatic leadership rebalancing. Mode is set by <<leader_balancer_mode,`leader_balancer_mode`>>.
Enable automatic leadership rebalancing.

*Requires restart:* No

Expand Down Expand Up @@ -1119,8 +1133,6 @@ Mode to enable server-side schema ID validation.

*Requires restart:* No

*Optional:* Yes

*Visibility:* `user`

*Accepted Values*:
Expand Down Expand Up @@ -1279,8 +1291,6 @@ The strategy used to fulfill fetch requests.

*Requires restart:* No

*Optional:* Yes

*Visibility:* `tunable`

*Accepted Values:* `polling`, `non_polling`, `non_polling_with_debounce`
Expand Down Expand Up @@ -1617,6 +1627,22 @@ Time between cluster join retries in milliseconds.

---

=== kafka_admin_topic_api_rate

Target quota rate (partition mutations per default_window_sec).

*Requires restart:* No

*Visibility:* `user`

*Type:* integer

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

*Default:* `null`

---

=== kafka_batch_max_bytes

Maximum size of a batch processed by the server. If the batch is compressed, the limit applies to the compressed batch size.
Expand All @@ -1635,15 +1661,33 @@ Maximum size of a batch processed by the server. If the batch is compressed, the

---

=== kafka_connection_rate_limit
=== kafka_client_group_byte_rate_quota

Maximum connections per second for one core. If `null` (the default), then the number of connections per second is unlimited.
Per-group target produce quota byte rate (bytes per second). Client is considered part of the group if client_id contains clients_prefix.

*Unit*: number of connections per second, per core
*Requires restart:* No

*Related topics*:
*Visibility:* `user`

* xref:manage:cluster-maintenance/configure-availability.adoc#limit-client-connections[Limit client connections]
*Default:* `null`

---

=== kafka_client_group_fetch_byte_rate_quota

Per-group target fetch quota byte rate (bytes per second). Client is considered part of the group if client_id contains clients_prefix.

*Requires restart:* No

*Visibility:* `user`

*Default:* `null`

---

=== kafka_connection_rate_limit

Maximum connections per second for one core. If `null` (the default), then the number of connections per second is unlimited.

*Requires restart:* No

Expand Down Expand Up @@ -1741,8 +1785,6 @@ Flag to require authorization for Kafka connections. If `null`, the property is

*Requires restart:* No

*Optional:* No

*Visibility:* `user`

*Type:* boolean
Expand Down Expand Up @@ -2481,27 +2523,6 @@ Leadership rebalancing idle timeout.

---

=== leader_balancer_mode

Mode of the leader balancer for optimizing movements of leadership between shards (logical CPU cores). Enabled by <<enable_leader_balancer,`enable_leader_balancer`>>.

*Requires restart:* No

*Optional:* Yes

*Visibility:* `user`

*Type:* `string`

*Accepted Values*:

* `random_hill_climbing`: a shard is randomly chosen and leadership is moved to it if the load on the original shard is reduced.
* `greedy_balanced_shards`: leadership movement is based on a greedy heuristic of moving leaders from the most loaded shard to the least loaded shard.

*Default:* `random_hill_climbing`

---

=== leader_balancer_mute_timeout

Leadership rebalancing mute timeout.
Expand Down Expand Up @@ -2610,8 +2631,6 @@ The topic property xref:./topic-properties.adoc#cleanuppolicy[`cleanup.policy`]

*Requires restart:* No

*Optional:* Yes

*Visibility:* `user`

*Accepted Values*: `compact`, `delete`, `compact,delete`
Expand Down Expand Up @@ -2726,8 +2745,6 @@ The topic property xref:./topic-properties.adoc#messagetimestamptype[`message.ti

*Requires restart:* No

*Optional:* Yes

*Visibility:* `user`

*Accepted Values:* `CreateTime`, `LogAppendTime`.
Expand All @@ -2744,8 +2761,6 @@ The amount of time to keep a log file before deleting it (in milliseconds). If s

*Requires restart:* No

*Optional:* Yes

*Visibility:* `user`

*Accepted values:* [`-17592186044416`, `17592186044415`]
Expand Down Expand Up @@ -3365,8 +3380,6 @@ Mode of xref:manage:cluster-maintenance/cluster-balancing.adoc[partition balanci

*Requires restart:* No

*Optional:* Yes

*Visibility:* `user`

*Accepted values:*
Expand Down Expand Up @@ -3713,6 +3726,24 @@ Disables cross shard sharing used to throttle recovery traffic. Should only be u

---

=== raft_replica_max_flush_delay_ms

Maximum delay between two subsequent flushes. After this delay, the log is automatically force flushed.

*Unit:* milliseconds

*Requires restart:* No

*Visibility:* `tunable`

*Type:* integer

*Accepted values:* [`-17592186044416`, `17592186044415`]

*Default:* `100`

---

=== raft_replica_max_pending_flush_bytes

Maximum number of bytes that are not flushed per partition. If the configured threshold is reached, the log is automatically flushed even if it has not been explicitly requested.
Expand Down Expand Up @@ -4369,8 +4400,6 @@ Rules for mapping Kerberos principal names to Redpanda user principals.

*Requires restart:* No

*Optional:* Yes

*Visibility:* `user`

*Type:* string array
Expand All @@ -4385,8 +4414,6 @@ A list of supported SASL mechanisms.

*Requires restart:* No

*Optional:* Yes

*Visibility:* `user`

*Type:* string array
Expand Down Expand Up @@ -4457,6 +4484,20 @@ Option to explicitly disable automatic disk space management. If this property w

---

=== space_management_enable_override

Enable automatic space management. This option is ignored and deprecated in versions >= v23.3.

*Requires restart:* No

*Visibility:* `user`

*Type:* boolean

*Default:* `false`

---

=== space_management_max_log_concurrency

Maximum parallel logs inspected during space management process.
Expand Down Expand Up @@ -4573,8 +4614,6 @@ To figure out whether to set `storage_ignore_timestamps_in_future_sec` for your

*Requires restart:* No

*Optional:* No

*Visibility:* `tunable`

*Type:* integer
Expand Down Expand Up @@ -4743,14 +4782,44 @@ List of superuser usernames.

---

=== target_fetch_quota_byte_rate

Target fetch size quota byte rate (bytes per second) - disabled default.

*Requires restart:* No

*Visibility:* `user`

*Type:* integer

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

*Default:* `null`

---

=== target_quota_byte_rate

Target request size quota byte rate (bytes per second).

*Requires restart:* No

*Visibility:* `user`

*Type:* integer

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

*Default:* `target_produce_quota_byte_rate_default`

---

=== tls_min_version

The minimum TLS version that Redpanda clusters support. This property prevents client applications from negotiating a downgrade to the TLS version when they make a connection to a Redpanda cluster.

*Requires restart:* Yes

*Optional:* No

*Visibility:* `user`

*Accepted values:* `v1.0`, `v1.1`, `v1.2`, `v1.3`
Expand Down Expand Up @@ -5065,8 +5134,6 @@ Timeout to wait for leadership in metadata cache.

*Requires restart:* No

*Optional:* Yes

*Visibility:* `tunable`

*Type:* integer
Expand All @@ -5085,8 +5152,6 @@ The `write_caching_default` cluster property can be overridden with the xref:top

*Requires restart:* no

*Optional:* No

*Type*: string

*Accepted values:*
Expand Down
Loading

0 comments on commit f65968e

Please sign in to comment.