|
671 | 671 | "config_scope": "cluster" |
672 | 672 | }, |
673 | 673 | "delete.retention.ms": { |
674 | | - "description": "The retention time for tombstone records in a compacted topic. Redpanda removes tombstone records after the retention limit is exceeded.\n\nThis property supports three states: set to a specific millisecond value (including 0), unset (inherits cluster default), or disabled by setting to a negative value (no per-topic limit applied). Setting the value to 0 means tombstone records are immediately eligible for removal.\n\nIf you have enabled Tiered Storage and set <<redpandaremoteread,`redpanda.remote.read`>> or <<redpandaremotewrite,`redpanda.remote.write`>> for the topic, you cannot enable tombstone removal.\n\nIf both `delete.retention.ms` and the cluster property config_ref:tombstone_retention_ms,true,properties/cluster-properties[] are set, `delete.retention.ms` overrides the cluster level tombstone retention for an individual topic.", |
| 674 | + "description": "The retention time for tombstone records in a compacted topic. Redpanda removes tombstone records after the retention limit is exceeded.\n\nThis property supports three states:\n\n* Positive value: Sets the milliseconds to retain tombstone records before removal.\n* 0: Tombstone records are immediately eligible for removal.\n* Negative value: No per-topic limit applied, inherits cluster default from tombstone_retention_ms.", |
675 | 675 | "related_topics": [ |
676 | 676 | "xref:reference:properties/cluster-properties.adoc#tombstone_retention_ms[`tombstone_retention_ms`]", |
677 | 677 | "xref:manage:cluster-maintenance/compaction-settings.adoc#tombstone-record-removal[Tombstone record removal]" |
|
953 | 953 | "config_scope": "cluster" |
954 | 954 | }, |
955 | 955 | "initial.retention.local.target.bytes": { |
956 | | - "description": "A size-based initial retention limit for Tiered Storage that determines how much data in local storage is transferred to a partition replica when a cluster is resized. If `null` (default), all locally retained data is transferred.\n\nThis property supports three states: set to a specific byte value (including 0), unset (inherits cluster default), or disabled by setting to a negative value (transfers all locally retained data).", |
| 956 | + "description": "A size-based initial retention limit for Tiered Storage that determines how much data in local storage is transferred to a partition replica when a cluster is resized.\n\nThis property supports three states:\n\n* Positive value: Sets the maximum bytes of local data to transfer during cluster resize.\n* 0: No local data is transferred during cluster resize.\n* Negative value: All locally retained data is transferred (default behavior).", |
957 | 957 | "related_topics": [ |
958 | 958 | "xref:reference:properties/cluster-properties.adoc#initial_retention_local_target_bytes[`initial_retention_local_target_bytes`]", |
959 | 959 | "xref:manage:tiered-storage.adoc#fast-commission-and-decommission[Fast commission and decommission through Tiered Storage]" |
960 | 960 | ], |
961 | 961 | "config_scope": "topic" |
962 | 962 | }, |
963 | 963 | "initial.retention.local.target.ms": { |
964 | | - "description": "A time-based initial retention limit for Tiered Storage that determines how much data in local storage is transferred to a partition replica when a cluster is resized. If `null` (default), all locally retained data is transferred.\n\nThis property supports three states: set to a specific millisecond value (including 0), unset (inherits cluster default), or disabled by setting to a negative value (transfers all locally retained data).", |
| 964 | + "description": "A time-based initial retention limit for Tiered Storage that determines how much data in local storage is transferred to a partition replica when a cluster is resized.\n\nThis property supports three states:\n\n* Positive value: Sets the maximum age (milliseconds) of local data to transfer during cluster resize.\n* 0: No local data is transferred during cluster resize.\n* Negative value: All locally retained data is transferred (default behavior).", |
965 | 965 | "related_topics": [ |
966 | 966 | "xref:reference:properties/cluster-properties.adoc#initial_retention_local_target_ms[`initial_retention_local_target_ms`]", |
967 | 967 | "xref:manage:tiered-storage.adoc#fast-commission-and-decommission[Fast commission and decommission through Tiered Storage]" |
|
1317 | 1317 | "config_scope": "cluster" |
1318 | 1318 | }, |
1319 | 1319 | "min.cleanable.dirty.ratio": { |
1320 | | - "description": "The minimum ratio between the number of bytes in dirty segments and the total number of bytes in closed segments that must be reached before a partition's log is eligible for compaction in a compact topic.\n\nThis property supports three states: set to a specific ratio value (including 0.0), unset (inherits cluster default), or disabled by setting to a negative value (inherits cluster default). Setting the value to 0.0 means compaction is always eligible regardless of dirty ratio.", |
| 1320 | + "description": "The minimum ratio between dirty and total bytes in closed segments before a partition's log is eligible for compaction in a compact topic.\n\nThis property supports three states:\n\n* Positive value: Sets the minimum dirty ratio (0.0 to 1.0) required before compaction.\n* 0: Compaction is always eligible regardless of dirty ratio.\n* Negative value: Uses the cluster default from min_cleanable_dirty_ratio.", |
1321 | 1321 | "related_topics": [ |
1322 | 1322 | "xref:reference:properties/cluster-properties.adoc#min_cleanable_dirty_ratio[`min_cleanable_dirty_ratio`]" |
1323 | 1323 | ], |
|
1686 | 1686 | "config_scope": "topic" |
1687 | 1687 | }, |
1688 | 1688 | "retention.bytes": { |
1689 | | - "description": "A size-based retention limit that configures the maximum size that a topic partition can grow before becoming eligible for cleanup.\n\nThis property supports three states: set to a specific byte value (including 0), unset (inherits cluster default), or disabled by setting to a negative value (no per-topic limit applied). Setting the value to 0 means partitions are immediately eligible for cleanup.\n\nIf `retention.bytes` is set to a non-negative value, it overrides the cluster property xref:cluster-properties.adoc#retention_bytes[`retention_bytes`] for the topic, and the total retained size for the topic is `retention.bytes` multiplied by the number of partitions for the topic.\n\nWhen both size-based (`retention.bytes`) and time-based (`retention.ms`) retention limits are set, cleanup occurs when either limit is reached.", |
| 1689 | + "description": "A size-based retention limit that configures the maximum size that a topic partition can grow before becoming eligible for cleanup.\n\nThis property supports three states:\n\n* Positive value: Sets the maximum bytes per partition. When exceeded, oldest data becomes eligible for cleanup.\n* 0: Partitions are immediately eligible for cleanup.\n* Negative value: No per-topic limit applied, inherits cluster default from retention_bytes.", |
1690 | 1690 | "related_topics": [ |
1691 | 1691 | "xref:cluster-properties.adoc#retention_bytes[`retention_bytes`]", |
1692 | 1692 | "xref:reference:properties/cluster-properties.adoc#retention_bytes[`retention_bytes`]", |
|
1695 | 1695 | "config_scope": "topic" |
1696 | 1696 | }, |
1697 | 1697 | "retention.local.target.bytes": { |
1698 | | - "description": "A size-based retention limit for Tiered Storage that configures the maximum size that a topic partition in local storage can grow before becoming eligible for cleanup. It applies per partition and is equivalent to <<retentionbytes, `retention.bytes`>> without Tiered Storage.\n\nThis property supports three states: set to a specific byte value (including 0), unset (inherits cluster default), or disabled by setting to a negative value (no per-topic limit applied). Setting the value to 0 means data in local storage is immediately eligible for cleanup.", |
| 1698 | + "description": "A size-based retention limit for Tiered Storage that configures the maximum size that a topic partition in local storage can grow before becoming eligible for cleanup.\n\nThis property supports three states:\n\n* Positive value: Sets the maximum bytes per partition in local storage before cleanup.\n* 0: Data in local storage is immediately eligible for cleanup.\n* Negative value: No per-topic limit applied, inherits cluster default.", |
1699 | 1699 | "related_topics": [ |
1700 | 1700 | "xref:reference:properties/cluster-properties.adoc#retention_local_target_bytes[`retention_local_target_bytes`]", |
1701 | 1701 | "xref:manage:tiered-storage.adoc[Tiered Storage]" |
1702 | 1702 | ], |
1703 | 1703 | "config_scope": "topic" |
1704 | 1704 | }, |
1705 | 1705 | "retention.local.target.ms": { |
1706 | | - "description": "A time-based retention limit for Tiered Storage that sets the maximum duration that a log's segment file for a topic is retained in local storage before it's eligible for cleanup. This property is equivalent to <<retentionms, `retention.ms`>> without Tiered Storage.\n\nThis property supports three states: set to a specific millisecond value (including 0), unset (inherits cluster default), or disabled by setting to a negative value (no per-topic limit applied). Setting the value to 0 means data in local storage is immediately eligible for cleanup.", |
| 1706 | + "description": "A time-based retention limit for Tiered Storage that sets the maximum duration that a log's segment file for a topic is retained in local storage before cleanup.\n\nThis property supports three states:\n\n* Positive value: Sets the maximum milliseconds to retain data in local storage.\n* 0: Data in local storage is immediately eligible for cleanup.\n* Negative value: No per-topic limit applied, inherits cluster default.", |
1707 | 1707 | "related_topics": [ |
1708 | 1708 | "xref:reference:properties/cluster-properties.adoc#retention_local_target_ms[`retention_local_target_ms`]", |
1709 | 1709 | "xref:manage:tiered-storage.adoc[Tiered Storage]", |
|
1712 | 1712 | "config_scope": "topic" |
1713 | 1713 | }, |
1714 | 1714 | "retention.ms": { |
1715 | | - "description": "A time-based retention limit that configures the maximum duration that a log's segment file for a topic is retained before it becomes eligible to be cleaned up. To consume all data, a consumer of the topic must read from a segment before its `retention.ms` elapses, otherwise the segment may be compacted and/or deleted.\n\nThis property supports three states: set to a specific millisecond value (including 0), unset (inherits cluster default), or disabled by setting to a negative value (no per-topic limit applied). Setting the value to 0 means data is immediately eligible for cleanup.\n\nIf `retention.ms` is set to a non-negative value, it overrides the cluster property xref:./cluster-properties.adoc#log_retention_ms[`log_retention_ms`] for the topic.\n\nWhen both size-based (`retention.bytes`) and time-based (`retention.ms`) retention limits are set, the earliest occurring limit applies.", |
| 1715 | + "description": "A time-based retention limit that configures the maximum duration that a log's segment file for a topic is retained before it becomes eligible to be cleaned up.\n\nThis property supports three states:\n\n* Positive value: Sets the maximum milliseconds to retain data. After this duration, segments become eligible for cleanup.\n* 0: Data is immediately eligible for cleanup.\n* Negative value: No per-topic limit applied, inherits cluster default from log_retention_ms.", |
1716 | 1716 | "related_topics": [ |
1717 | 1717 | "xref:reference:properties/cluster-properties.adoc#log_retention_ms[`log_retention_ms`]", |
1718 | 1718 | "xref:manage:cluster-maintenance/disk-utilization.adoc#configure-message-retention[Configure message retention]" |
|
1749 | 1749 | "description": "Local retention time target for partitions of topics with object storage write enabled.\n\nThis property can be overridden on a per-topic basis by setting `retention.local.target.ms` in each topic enabled for Tiered Storage. See xref:manage:cluster-maintenance/disk-utilization.adoc#configure-message-retention[Configure message retention].\n\nNOTE: Both <<retention_local_target_bytes_default,`retention_local_target_bytes_default`>> and <<retention_local_target_ms_default,`retention_local_target_ms_default`>> can be set. The limit that is reached first is applied." |
1750 | 1750 | }, |
1751 | 1751 | "retention_local_trim_interval": { |
1752 | | - "description": "Interval between data retention checks for locally-stored data.\n\nThis property supports three states:\n\n* Positive value: Sets the interval in milliseconds between retention checks. Smaller values provide more precise retention but increase CPU usage.\n* 0: Disables periodic retention checks. Data will only be trimmed when triggered by other events.\n* Negative value: Uses the default system interval for retention checks, following Kafka protocol behavior.", |
1753 | 1752 | "config_scope": "cluster" |
1754 | 1753 | }, |
1755 | 1754 | "retries": { |
|
1925 | 1924 | "config_scope": "topic" |
1926 | 1925 | }, |
1927 | 1926 | "segment.ms": { |
1928 | | - "description": "The maximum duration that a log segment of a topic is active (open for writes and not deletable). A periodic event, with `segment.ms` as its period, forcibly closes the active segment and transitions, or rolls, to a new active segment. The closed (inactive) segment is then eligible to be cleaned up according to cleanup and retention properties.\n\nThis property supports three states: set to a specific millisecond value (including 0), unset (inherits cluster default), or disabled by setting to a negative value (inherits cluster default). Setting the value to 0 means segments are immediately eligible for closure.\n\nIf set to a non-negative value, `segment.ms` overrides the cluster property xref:./cluster-properties.adoc#log_segment_ms[`log_segment_ms`]. Values are automatically clamped between the cluster bounds set by xref:./cluster-properties.adoc#log_segment_ms_min[`log_segment_ms_min`] (default: 10 minutes) and xref:./cluster-properties.adoc#log_segment_ms_max[`log_segment_ms_max`] (default: 1 year). If your configured value exceeds these bounds, Redpanda uses the bound value and logs a warning. Check current cluster bounds with `rpk cluster config get log_segment_ms_min log_segment_ms_max`.", |
| 1927 | + "description": "The maximum duration that a log segment of a topic is active (open for writes and not deletable). A periodic event forcibly closes the active segment and transitions to a new active segment.\n\nThis property supports three states:\n\n* Positive value: Sets the maximum milliseconds a segment remains active before rolling to a new segment.\n* 0: Segments are immediately eligible for closure.\n* Negative value: Uses the cluster default from log_segment_ms.", |
1929 | 1928 | "related_topics": [ |
1930 | 1929 | "xref:reference:properties/cluster-properties.adoc#log_segment_ms[`log_segment_ms`]", |
1931 | 1930 | "xref:reference:properties/cluster-properties.adoc#log_segment_ms_min[`log_segment_ms_min`]", |
|
0 commit comments