diff --git a/modules/reference/pages/properties/cluster-properties.adoc b/modules/reference/pages/properties/cluster-properties.adoc index ca83b5c84b..0af9e6e8c9 100644 --- a/modules/reference/pages/properties/cluster-properties.adoc +++ b/modules/reference/pages/properties/cluster-properties.adoc @@ -2,7 +2,7 @@ :page-aliases: reference:tunable-properties.adoc, reference:cluster-properties.adoc :description: Reference of cluster configuration properties. -Cluster configuration properties are the same for all brokers in a cluster, and are set at the cluster level. +Cluster properties are configuration settings that control the behavior of a Redpanda cluster at a global level. Configuring cluster properties allows you to adapt Redpanda to specific workloads, optimize resource usage, and enable or disable features. For information on how to edit cluster properties, see xref:manage:cluster-maintenance/cluster-property-configuration.adoc[] or xref:manage:kubernetes/k-cluster-property-configuration.adoc[]. @@ -218,8 +218,13 @@ endif::[] // end::audit_excluded_topics[] +// tag::audit_log_num_partitions[] === audit_log_num_partitions +ifdef::env-cloud[] +NOTE: This property is read-only in Redpanda Cloud. +endif::[] + Defines the number of partitions used by a newly-created audit topic. This configuration applies only to the audit log topic and may be different from the cluster or other topic configurations. This cannot be altered for existing audit log topics. *Unit:* number of partitions per topic @@ -238,6 +243,8 @@ endif::[] --- +// end::audit_log_num_partitions[] + === audit_log_replication_factor Defines the replication factor for a newly-created audit log topic. This configuration applies only to the audit log topic and may be different from the cluster or other topic configurations. This cannot be altered for existing audit log topics. Setting this value is optional. If a value is not provided, Redpanda will use the value specified for `internal_topic_replication_factor`. @@ -306,6 +313,8 @@ If you produce to a topic that doesn't exist, the topic will be created with def === cluster_id +NOTE: This property is read-only in Redpanda Cloud. + Cluster identifier. *Requires restart:* No @@ -320,6 +329,8 @@ Cluster identifier. --- + +// tag::compacted_log_segment_size[] === compacted_log_segment_size Size (in bytes) for each compacted log segment. @@ -336,6 +347,8 @@ Size (in bytes) for each compacted log segment. --- +// end::compacted_log_segment_size[] + === compaction_ctrl_backlog_size Target backlog size for compaction controller. If not set the max backlog size is configured to 80% of total disk space available. @@ -667,8 +680,13 @@ Timeout, in milliseconds, to wait for new topic creation. --- +// tag::data_transforms_binary_max_size[] === data_transforms_binary_max_size +ifdef::env-cloud[] +NOTE: This property is read-only in Redpanda Cloud. +endif::[] + The maximum size for a deployable WebAssembly binary that the broker can store. *Requires restart:* No @@ -681,6 +699,7 @@ The maximum size for a deployable WebAssembly binary that the broker can store. --- +// end::data_transforms_binary_max_size[] === data_transforms_commit_interval_ms @@ -776,8 +795,13 @@ endif::[] // end::data_transforms_logging_line_max_bytes[] +// tag::data_transforms_per_core_memory_reservation[] === data_transforms_per_core_memory_reservation +ifdef::env-cloud[] +NOTE: This property is read-only in Redpanda Cloud. +endif::[] + The amount of memory to reserve per core for data transform (Wasm) virtual machines. Memory is reserved on boot. The maximum number of functions that can be deployed to a cluster is equal to `data_transforms_per_core_memory_reservation` / `data_transforms_per_function_memory_limit`. *Requires restart:* Yes @@ -792,8 +816,15 @@ endif::[] --- +// end::data_transforms_per_core_memory_reservation[] + +// tag::data_transforms_per_function_memory_limit[] === data_transforms_per_function_memory_limit +ifdef::env-cloud[] +NOTE: This property is read-only in Redpanda Cloud. +endif::[] + The amount of memory to give an instance of a data transform (Wasm) virtual machine. The maximum number of functions that can be deployed to a cluster is equal to `data_transforms_per_core_memory_reservation` / `data_transforms_per_function_memory_limit`. *Requires restart:* Yes @@ -806,6 +837,8 @@ The amount of memory to give an instance of a data transform (Wasm) virtual mach --- +// end::data_transforms_per_function_memory_limit[] + === data_transforms_read_buffer_memory_percentage @@ -1031,8 +1064,13 @@ Default number of partitions per topic. --- +// tag::default_topic_replications[] === default_topic_replications +ifdef::env-cloud[] +NOTE: This property is read-only in Redpanda Cloud. In Redpanda Cloud, all new topics are created with a replication factor of 3. +endif::[] + Default replication factor for new topics. *Requires restart:* No @@ -1043,12 +1081,14 @@ Default replication factor for new topics. *Accepted values:* [`-32768`, `32767`] +ifndef::env-cloud[] *Default:* `1` - -NOTE: In Redpanda Cloud, all new topics are created with a replication factor of 3. +endif::[] --- +// end::default_topic_replications[] + === default_window_sec Default quota tracking window size in milliseconds. @@ -1736,9 +1776,16 @@ Maximum age of the metadata cached in the health monitor of a non-controller bro --- +// tag::http_authentication[] === http_authentication +ifdef::env-cloud[] +NOTE: This property is read-only in Redpanda Cloud. +endif::[] + +ifndef::env-cloud[] include::reference:partial$enterprise-licensed-property.adoc[] +endif::[] A list of supported HTTP authentication mechanisms. Accepted Values: `BASIC`, `OIDC`. @@ -1750,12 +1797,17 @@ A list of supported HTTP authentication mechanisms. Accepted Values: `BASIC`, `O *Accepted Values:* `BASIC`, `OIDC` +ifndef::env-cloud[] *Enterprise license required*: `OIDC` *Default:* `[basic]` +endif::[] --- +// end::http_authentication[] + +// tag::iceberg_backlog_controller_p_coeff[] === iceberg_backlog_controller_p_coeff Proportional coefficient for the Iceberg backlog controller. Number of shares assigned to the datalake scheduling group will be proportional to the backlog size error. A negative value means larger and faster changes in the number of shares in the datalake scheduling group. @@ -1774,8 +1826,15 @@ Proportional coefficient for the Iceberg backlog controller. Number of shares as --- +// end::iceberg_backlog_controller_p_coeff[] + +// tag::iceberg_catalog_base_location[] === iceberg_catalog_base_location +ifdef::env-cloud[] +NOTE: This property is read-only in Redpanda Cloud. +endif::[] + Base path for the object-storage-backed Iceberg catalog. After Iceberg is enabled, do not change this value. *Requires restart:* Yes @@ -1784,7 +1843,9 @@ Base path for the object-storage-backed Iceberg catalog. After Iceberg is enable *Type:* string +ifndef::env-cloud[] *Default:* `redpanda-iceberg-catalog` +endif::[] **Related topics**: @@ -1793,6 +1854,8 @@ Base path for the object-storage-backed Iceberg catalog. After Iceberg is enable --- +// end::iceberg_catalog_base_location[] + === iceberg_catalog_commit_interval_ms @@ -3437,11 +3500,18 @@ The amount of time to keep a log file before deleting it (in milliseconds). If s --- +// tag::log_segment_ms[] === log_segment_ms +ifdef::env-cloud[] +NOTE: This property is read-only in Redpanda Cloud. +endif::[] + Default lifetime of log segments. If `null`, the property is disabled, and no default lifetime is set. Any value under 60 seconds (60000 ms) is rejected. This property can also be set in the Kafka API using the Kafka-compatible alias, `log.roll.ms`. +ifndef::env-cloud[] The topic property xref:./topic-properties.adoc#segmentms[`segment.ms`] overrides the value of `log_segment_ms` at the topic level. +endif::[] *Unit:* milliseconds @@ -3453,12 +3523,14 @@ The topic property xref:./topic-properties.adoc#segmentms[`segment.ms`] override *Accepted values:* [`-17592186044416`, `17592186044415`] +ifndef::env-cloud[] *Default:* `1209600000` (2 weeks) *Related properties*: * <> * <> +endif::[] --- @@ -3842,8 +3914,13 @@ The minimum ratio between the number of bytes in dirty segments and the total nu --- +// tag::minimum_topic_replications[] === minimum_topic_replications +ifdef::env-cloud[] +NOTE: This property is read-only in Redpanda Cloud. +endif::[] + Minimum allowable replication factor for topics in this cluster. The set value must be positive, odd, and equal to or less than the number of available brokers. Changing this parameter only restricts newly-created topics. Redpanda returns an `INVALID_REPLICATION_FACTOR` error on any attempt to create a topic with a replication factor less than this property. If you change the `minimum_topic_replications` setting, the replication factor of existing topics remains unchanged. However, Redpanda will log a warning on start-up with a list of any topics that have fewer replicas than this minimum. For example, you might see a message such as `Topic X has a replication factor less than specified minimum: 1 < 3`. @@ -3858,10 +3935,14 @@ If you change the `minimum_topic_replications` setting, the replication factor o *Accepted values:* [`1`, `32767`] +ifndef::env-cloud[] *Default:* `1` +endif::[] --- +// end::minimum_topic_replications[] + === node_isolation_heartbeat_timeout How long after the last heartbeat request a node will wait before considering itself to be isolated. @@ -3949,8 +4030,13 @@ The amount of time (in seconds) to allow for when validating the expiry claim in --- +// tag::oidc_discovery_url[] === oidc_discovery_url +ifdef::env-cloud[] +NOTE: This property is read-only in Redpanda Cloud. +endif::[] + The URL pointing to the well-known discovery endpoint for the OIDC provider. *Requires restart:* No @@ -3959,10 +4045,14 @@ The URL pointing to the well-known discovery endpoint for the OIDC provider. *Type:* string +ifdef::env-cloud[] *Default:* `https://auth.prd.cloud.redpanda.com/.well-known/openid-configuration` +endif::[] --- +// end::oidc_discovery_url[] + === oidc_keys_refresh_interval The frequency of refreshing the JSON Web Keys (JWKS) used to validate access tokens. @@ -3981,8 +4071,13 @@ The frequency of refreshing the JSON Web Keys (JWKS) used to validate access tok --- +// tag::oidc_principal_mapping[] === oidc_principal_mapping +ifdef::env-cloud[] +NOTE: This property is read-only in Redpanda Cloud. +endif::[] + Rule for mapping JWT payload claim to a Redpanda user principal. *Requires restart:* No @@ -3991,12 +4086,21 @@ Rule for mapping JWT payload claim to a Redpanda user principal. *Type:* string +ifndef::env-cloud[] *Default:* `$.sub` +endif::[] --- +// end::oidc_principal_mapping[] + +// tag::oidc_token_audience[] === oidc_token_audience +ifdef::env-cloud[] +NOTE: This property is read-only in Redpanda Cloud. +endif::[] + A string representing the intended recipient of the token. *Requires restart:* No @@ -4005,10 +4109,14 @@ A string representing the intended recipient of the token. *Type:* string +ifndef::env-cloud[] *Default:* `redpanda` +endif::[] --- +// end::oidc_token_audience[] + === partition_autobalancing_concurrent_moves Number of partitions that can be reassigned at once. @@ -5135,9 +5243,16 @@ Rules for mapping Kerberos principal names to Redpanda user principals. --- +// tag::sasl_mechanisms[] === sasl_mechanisms +ifdef::env-cloud[] +NOTE: This property is read-only in Redpanda Cloud. +endif::[] + +ifndef::env-cloud[] include::reference:partial$enterprise-licensed-property.adoc[] +endif::[] A list of supported SASL mechanisms. Accepted values: `SCRAM`, `GSSAPI`, `OAUTHBEARER`, `PLAIN`. Note that in order to enable PLAIN, you must also enable SCRAM. @@ -5149,12 +5264,16 @@ A list of supported SASL mechanisms. Accepted values: `SCRAM`, `GSSAPI`, `OAUTHB *Accepted values*: `SCRAM`, `GSSAPI`, `OAUTHBEARER`, `PLAIN` +ifndef::env-cloud[] *Enterprise license required*: `GSSAPI`, `OAUTHBEARER` *Default:* `[SCRAM]` +endif::[] --- +// end::sasl_mechanisms[] + === schema_registry_normalize_on_startup Normalize schemas as they are read from the topic on startup. @@ -5540,8 +5659,13 @@ TLS client-initiated renegotiation is considered unsafe and is disabled by defau --- +// tag::tls_min_version[] === tls_min_version +ifdef::env-cloud[] +NOTE: This property is read-only in Redpanda Cloud. +endif::[] + 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 @@ -5552,10 +5676,14 @@ The minimum TLS version that Redpanda clusters support. This property prevents c *Type:* string +ifndef::env-cloud[] *Default:* `v1.2` +endif::[] --- +// end::tls_min_version[] + === tm_sync_timeout_ms Transaction manager's synchronization timeout. Maximum time to wait for internal state machine to catch up before rejecting a request. diff --git a/modules/reference/pages/properties/object-storage-properties.adoc b/modules/reference/pages/properties/object-storage-properties.adoc index 7f6a3d040e..88d6230e6a 100644 --- a/modules/reference/pages/properties/object-storage-properties.adoc +++ b/modules/reference/pages/properties/object-storage-properties.adoc @@ -2,11 +2,13 @@ :description: Reference of object storage properties. :page-aliases: reference:object-storage-properties.adoc -Object storage properties are a type of cluster property. For information on how to edit cluster properties, see xref:manage:cluster-maintenance/cluster-property-configuration.adoc[]. +Object storage properties are a type of cluster property. Cluster properties are configuration settings that control the behavior of a Redpanda cluster at a global level. Configuring cluster properties allows you to adapt Redpanda to specific workloads, optimize resource usage, and enable or disable features. + +For information on how to edit cluster properties, see xref:manage:cluster-maintenance/cluster-property-configuration.adoc[]. NOTE: Some object storage properties require that you restart the cluster for any updates to take effect. See the specific property details to identify whether or not a restart is required. -== Cloud configuration +== Cluster configuration Object storage properties should only be set if you enable xref:manage:tiered-storage.adoc[Tiered Storage]. @@ -114,6 +116,7 @@ Azure Data Lake Storage v2 port override. See also: <