Cluster Configuration Properties

Cluster configuration properties are the same for all brokers in a cluster, and are set at the cluster level.

For information on how to edit cluster properties, see Configure Cluster Properties.

Some properties require a cluster restart for updates to take effect. This triggers a long-running operation that can take several minutes to complete.

Cluster configuration

audit_enabled

Enables or disables audit logging. When you set this to true, Redpanda checks for an existing topic named _redpanda.audit_log. If none is found, Redpanda automatically creates one for you.

Requires restart: No

Visibility: user

Type: boolean

Enterprise license required: true

Default: false


audit_excluded_principals

List of user principals to exclude from auditing.

Requires restart: No

Visibility: user

Type: array

Default: null


audit_excluded_topics

List of topics to exclude from auditing.

Requires restart: No

Visibility: user

Type: array

Default: null


data_transforms_enabled

Enables WebAssembly-powered data transforms directly in the broker. When data_transforms_enabled is set to true, Redpanda reserves memory for data transforms, even if no transform functions are currently deployed. This memory reservation ensures that adequate resources are available for transform functions when they are needed, but it also means that some memory is allocated regardless of usage.

Requires restart: Yes

Visibility: user

Type: boolean

Default: false


data_transforms_logging_line_max_bytes

Transform log lines truncate to this length. Truncation occurs after any character escaping.

Unit: bytes

Requires restart: No

Visibility: tunable

Type: integer

Default: 1024


iceberg_catalog_type

Iceberg catalog type that Redpanda will use to commit table metadata updates. Supported types: rest, object_storage.

Requires restart: Yes

Visibility: user

Accepted values: rest, object_storage

Default: object_storage

Related topics:


iceberg_default_partition_spec

Default value for the redpanda.iceberg.partition.spec topic property that determines the partition spec for the Iceberg table corresponding to the topic.

Requires restart: No

Visibility: user

Type: string

Default: (hour(redpanda.timestamp))

Partitions the topic by extracting the hour from redpanda.timestamp, grouping records by hour to optimize queries.

Related topics:


iceberg_delete

Default value for the redpanda.iceberg.delete topic property that determines if the corresponding Iceberg table is deleted upon deleting the topic.

Requires restart: No

Visibility: user

Type: boolean

Default: true

Related topics:


iceberg_enabled

Enables the translation of topic data into Iceberg tables. Setting iceberg_enabled to true activates the feature at the cluster level, but each topic must also set the redpanda.iceberg.enabled topic-level property to true to use it. If iceberg_enabled is set to false, then the feature is disabled for all topics in the cluster, overriding any topic-level settings.

Requires restart: Yes

Visibility: user

Type: boolean

Default: false

Related topics:


iceberg_invalid_record_action

Default value for the redpanda.iceberg.invalid.record.action topic property.

Requires restart: No

Visibility: user

Default: dlq_table

Related topics:


iceberg_rest_catalog_authentication_mode

The authentication mode for client requests made to the Iceberg catalog. Choose from: none, bearer, and oauth2. In bearer mode, the token specified in iceberg_rest_catalog_token is used unconditionally, and no attempts are made to refresh the token. In oauth2 mode, the credentials specified in iceberg_rest_catalog_client_id and iceberg_rest_catalog_client_secret are used to obtain a bearer token from the URI defined by iceberg_rest_catalog_oauth2_server_uri..

Requires restart: Yes

Visibility: user

Default: none

Related topics:


iceberg_rest_catalog_client_id

The client ID used to query the REST catalog API for the OAuth token. Required if catalog type is set to rest.

Requires restart: Yes

Visibility: user

Type: string

Default: null

Related topics:


iceberg_rest_catalog_client_secret

Secret used with the client ID to query the OAuth token endpoint for Iceberg REST catalog authentication. Required if catalog type is set to rest and iceberg_rest_catalog_authentication_mode is set to oauth2.

Requires restart: Yes

Visibility: user

Type: string

Default: null

Related topics:


iceberg_rest_catalog_crl

The contents of a certificate revocation list for iceberg_rest_catalog_trust. Takes precedence over iceberg_rest_catalog_crl_file.

Requires restart: Yes

Visibility: user

Type: string

Default: null


iceberg_rest_catalog_endpoint

URL of Iceberg REST catalog endpoint.

Requires restart: Yes

Visibility: user

Type: string

Default: null

Related topics:


iceberg_rest_catalog_oauth2_server_uri

The OAuth URI used to retrieve access tokens for Iceberg REST catalog authentication. If left undefined, the deprecated Iceberg catalog endpoint /v1/oauth/tokens is used instead.

Requires restart: Yes

Visibility: user

Type: string

Default: null

Related topics:


iceberg_rest_catalog_prefix

Prefix part of the Iceberg REST catalog URL. Prefix is appended to the catalog path, for example /v1/{prefix}/namespaces.

Requires restart: Yes

Visibility: user

Type: string

Default: null

Related topics:


iceberg_rest_catalog_request_timeout_ms

Maximum length of time that Redpanda waits for a response from the REST catalog before aborting the request.

Unit: milliseconds

Requires restart: No

Visibility: tunable

Type: integer

Accepted values: [-17592186044416, 17592186044415]

Default: 10000

Related topics:


iceberg_rest_catalog_token

Token used to access the REST Iceberg catalog. If the token is present, Redpanda ignores credentials stored in the properties iceberg_rest_catalog_client_id and iceberg_rest_catalog_client_secret.

Required if iceberg_rest_catalog_authentication_mode is set to bearer.

Requires restart: Yes

Visibility: user

Type: string

Default: null

Related topics:


iceberg_rest_catalog_trust

The contents of a certificate chain to trust for the REST Iceberg catalog.

Takes precedence over iceberg_rest_catalog_trust_file.

Requires restart: Yes

Visibility: user

Type: string

Default: null


iceberg_target_lag_ms

Default value for the redpanda.iceberg.target.lag.ms topic property, which controls how often the data in an Iceberg table is refreshed with new data from the corresponding Redpanda topic. Redpanda attempts to commit all data produced to the topic within the lag target, subject to resource availability.

Unit: milliseconds

Requires restart: No

Visibility: user

Type: integer

Accepted values: [-17592186044416, 17592186044415]

Default: 60000

Related topics: