topic prop update

Author: paulohtb6

modules/reference/partials/properties/topic-properties.adoc

@@ -317,9 +317,11 @@ endif::[]
 
 The retention time for tombstone records in a compacted topic. Redpanda removes tombstone records after the retention limit is exceeded.
 
-If you have enabled Tiered Storage and set <<redpandaremoteread,`redpanda.remote.read`>> or <<redpandaremotewrite,`redpanda.remote.write`>> for the topic, you cannot enable tombstone removal.
+This property supports three states:
 
-If 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.
+* Positive value: Sets the milliseconds to retain tombstone records before removal.
+* 0: Tombstone records are immediately eligible for removal.
+* Negative value: No per-topic limit applied, inherits cluster default from tombstone_retention_ms.
 
 [cols="1s,2a"]
 |===
@@ -497,7 +499,13 @@ endif::[]
 // tag::category-tiered-storage[]
 === initial.retention.local.target.bytes
 
-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.
+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.
+
+This property supports three states:
+
+* Positive value: Sets the maximum bytes of local data to transfer during cluster resize.
+* 0: No local data is transferred during cluster resize.
+* Negative value: All locally retained data is transferred (default behavior).
 
 [cols="1s,2a"]
 |===
@@ -544,7 +552,13 @@ endif::[]
 // tag::category-tiered-storage[]
 === initial.retention.local.target.ms
 
-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.
+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.
+
+This property supports three states:
+
+* Positive value: Sets the maximum age (milliseconds) of local data to transfer during cluster resize.
+* 0: No local data is transferred during cluster resize.
+* Negative value: All locally retained data is transferred (default behavior).
 
 [cols="1s,2a"]
 |===
@@ -830,7 +844,13 @@ endif::[]
 // tag::category-retention-compaction[]
 === min.cleanable.dirty.ratio
 
-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.
+The minimum ratio between dirty and total bytes in closed segments before a partition's log is eligible for compaction in a compact topic.
+
+This property supports three states:
+
+* Positive value: Sets the minimum dirty ratio (0.0 to 1.0) required before compaction.
+* 0: Compaction is always eligible regardless of dirty ratio.
+* Negative value: Uses the cluster default from min_cleanable_dirty_ratio.
 
 [cols="1s,2a"]
 |===
@@ -1701,9 +1721,11 @@ endif::[]
 
 A size-based retention limit that configures the maximum size that a topic partition can grow before becoming eligible for cleanup.
 
-If `retention.bytes` is set to a positive 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.
+This property supports three states:
 
-When both size-based (`retention.bytes`) and time-based (`retention.ms`) retention limits are set, cleanup occurs when either limit is reached.
+* Positive value: Sets the maximum bytes per partition. When exceeded, oldest data becomes eligible for cleanup.
+* 0: Partitions are immediately eligible for cleanup.
+* Negative value: No per-topic limit applied, inherits cluster default from retention_bytes.
 
 [cols="1s,2a"]
 |===
@@ -1752,7 +1774,13 @@ endif::[]
 // tag::category-tiered-storage[]
 === retention.local.target.bytes
 
-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.
+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.
+
+This property supports three states:
+
+* Positive value: Sets the maximum bytes per partition in local storage before cleanup.
+* 0: Data in local storage is immediately eligible for cleanup.
+* Negative value: No per-topic limit applied, inherits cluster default.
 
 [cols="1s,2a"]
 |===
@@ -1799,7 +1827,13 @@ endif::[]
 // tag::category-tiered-storage[]
 === retention.local.target.ms
 
-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.
+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.
+
+This property supports three states:
+
+* Positive value: Sets the maximum milliseconds to retain data in local storage.
+* 0: Data in local storage is immediately eligible for cleanup.
+* Negative value: No per-topic limit applied, inherits cluster default.
 
 [cols="1s,2a"]
 |===
@@ -1848,11 +1882,13 @@ endif::[]
 // tag::category-retention-compaction[]
 === retention.ms
 
-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. If a non-positive value, no per-topic limit is applied.
+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.
 
-If `retention.ms` is set to a positive value, it overrides the cluster property xref:./cluster-properties.adoc#log_retention_ms[`log_retention_ms`] for the topic.
+This property supports three states:
 
-When both size-based (`retention.bytes`) and time-based (`retention.ms`) retention limits are set, the earliest occurring limit applies.
+* Positive value: Sets the maximum milliseconds to retain data. After this duration, segments become eligible for cleanup.
+* 0: Data is immediately eligible for cleanup.
+* Negative value: No per-topic limit applied, inherits cluster default from log_retention_ms.
 
 [cols="1s,2a"]
 |===
@@ -1954,9 +1990,13 @@ endif::[]
 // tag::category-segment-message[]
 === segment.ms
 
-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.
+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.
+
+This property supports three states:
 
-If set to a positive duration, `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`.
+* Positive value: Sets the maximum milliseconds a segment remains active before rolling to a new segment.
+* 0: Segments are immediately eligible for closure.
+* Negative value: Uses the cluster default from log_segment_ms.
 
 [cols="1s,2a"]
 |===