From 5400c6c5a5a0abb9ce0c75552b36e5cab576c09a Mon Sep 17 00:00:00 2001 From: Joyce Fee Date: Thu, 4 Jun 2026 16:25:43 -0400 Subject: [PATCH 1/3] fix(DOC-2226): sweep broken dotted-property xref anchors MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The migration from no-separator to hyphen-separator anchor IDs (idseparator: '-') is half-finished. Existing xrefs in the no-separator form (e.g., #retentionms) still load the page but silently fail to jump to the target section because Antora does not validate URL fragments. This PR sweeps the hand-edited referrers that point at the topic-properties page. Per the ticket, generated content under modules/reference/partials/properties/ and modules/reference/attachments/ is intentionally not touched here — those land on the next property-docs regen (the override source in docs-data/property-overrides.json is updated so the regen produces correct anchors). 49 anchor substitutions across 8 files: - modules/develop/pages/transactions.adoc (1) - modules/get-started/pages/release-notes/redpanda.adoc (1) - modules/manage/pages/cluster-maintenance/compaction-settings.adoc (5) - modules/manage/pages/cluster-maintenance/topic-property-configuration.adoc (8) - modules/manage/pages/kubernetes/k-manage-topics.adoc (3) - modules/manage/pages/schema-reg/schema-id-validation.adoc (12) - modules/manage/partials/tiered-storage.adoc (1) - docs-data/property-overrides.json (18) Also fixes one off-target xref in the override JSON: a default_topic_replication reference pointed at topic-properties.adoc but default_topic_replication is a cluster property. Removed the duplicate topic-properties reference; the override already had the correct cluster-properties.adoc xref alongside. Two anchor renames carried in this sweep (where the property was renamed, not just the anchor separator): - redpanda.value.schema.validation -> redpanda.value.schema.id.validation (anchor: redpandavalueschemavalidation -> redpanda-value-schema-id-validation) - redpanda.key.schema.validation -> redpanda.key.schema.id.validation (anchor: redpandakeyschemavalidation -> redpanda-key-schema-id-validation) Not addressed in this PR (flagged for follow-up): - xref:reference:properties/topic-properties.adoc#redpanda-iceberg-enabled appears in 3 places (property-overrides.json, cluster-properties.adoc, attachments JSON) but no `=== redpanda.iceberg.enabled` H3 exists on topic-properties. The property may have been renamed (redpanda.iceberg.mode subsumes the enabled toggle) or deprecated. Needs human review of intent before fixing. Co-Authored-By: Claude Opus 4.7 --- docs-data/property-overrides.json | 39 +++++++++---------- modules/develop/pages/transactions.adoc | 2 +- .../pages/release-notes/redpanda.adoc | 2 +- .../compaction-settings.adoc | 10 ++--- .../topic-property-configuration.adoc | 16 ++++---- .../pages/kubernetes/k-manage-topics.adoc | 4 +- .../schema-reg/schema-id-validation.adoc | 20 +++++----- modules/manage/partials/tiered-storage.adoc | 2 +- 8 files changed, 47 insertions(+), 48 deletions(-) diff --git a/docs-data/property-overrides.json b/docs-data/property-overrides.json index 281f92f2f1..cb61956094 100644 --- a/docs-data/property-overrides.json +++ b/docs-data/property-overrides.json @@ -306,7 +306,7 @@ "cloud_storage_enable_segment_uploads": { "description": "Controls the upload of log segments to Tiered Storage. If set to `false`, this property temporarily pauses all log segment uploads from the Redpanda cluster. When the uploads are paused, the <> cluster configuration and `redpanda.remote.allowgaps` topic properties control local retention behavior.", "related_topics": [ - "xref:properties/topic-properties.adoc#redpandaremoteallowgaps[`redpanda.remote.allowgaps`]" + "xref:properties/topic-properties.adoc#redpanda-remote-allowgaps[`redpanda.remote.allowgaps`]" ] }, "cloud_storage_enabled": { @@ -1246,9 +1246,9 @@ }, "kafka_max_message_size_upper_limit_bytes": { "related_topics": [ - "xref:reference:properties/topic-properties.adoc#maxmessagebytes[`max.message.bytes`]" + "xref:reference:properties/topic-properties.adoc#max-message-bytes[`max.message.bytes`]" ], - "description": "The maximum value you can set for the xref:./topic-properties.adoc#maxmessagebytes[`max.message.bytes`] topic property. When set to `null`, no limit is enforced.", + "description": "The maximum value you can set for the xref:./topic-properties.adoc#max-message-bytes[`max.message.bytes`] topic property. When set to `null`, no limit is enforced.", "config_scope": "cluster" }, "kafka_nodelete_topics": { @@ -1324,9 +1324,9 @@ "config_scope": "cluster" }, "log_cleanup_policy": { - "description": "Default cleanup policy for topic logs.\n\nThe topic property xref:./topic-properties.adoc#cleanuppolicy[`cleanup.policy`] overrides the value of `log_cleanup_policy` at the topic level.", + "description": "Default cleanup policy for topic logs.\n\nThe topic property xref:./topic-properties.adoc#cleanup-policy[`cleanup.policy`] overrides the value of `log_cleanup_policy` at the topic level.", "related_topics": [ - "xref:reference:properties/topic-properties.adoc#cleanuppolicy[`cleanup.policy`]" + "xref:reference:properties/topic-properties.adoc#cleanup-policy[`cleanup.policy`]" ], "config_scope": "cluster" }, @@ -1348,28 +1348,28 @@ "config_scope": "cluster" }, "log_compression_type": { - "description": "IMPORTANT: This property is ignored regardless of the value specified. The behavior is always the same as the `producer` value. Redpanda brokers do not compress or recompress data based on this property. If producers send compressed data, Redpanda stores it as-is; if producers send uncompressed data, Redpanda stores it uncompressed. Other listed values are accepted for Apache Kafka compatibility but are ignored by the broker. This property may appear in Admin API and `rpk topic describe` outputs for compatibility.\n\nDefault for the Kafka-compatible compression.type property. Redpanda does not recompress data.\n\nThe topic property xref:./topic-properties.adoc#compressiontype[`compression.type`] overrides the value of `log_compression_type` at the topic level.", + "description": "IMPORTANT: This property is ignored regardless of the value specified. The behavior is always the same as the `producer` value. Redpanda brokers do not compress or recompress data based on this property. If producers send compressed data, Redpanda stores it as-is; if producers send uncompressed data, Redpanda stores it uncompressed. Other listed values are accepted for Apache Kafka compatibility but are ignored by the broker. This property may appear in Admin API and `rpk topic describe` outputs for compatibility.\n\nDefault for the Kafka-compatible compression.type property. Redpanda does not recompress data.\n\nThe topic property xref:./topic-properties.adoc#compression-type[`compression.type`] overrides the value of `log_compression_type` at the topic level.", "related_topics": [ - "xref:reference:properties/topic-properties.adoc#compressiontype[`compression.type`]" + "xref:reference:properties/topic-properties.adoc#compression-type[`compression.type`]" ], "config_scope": "cluster" }, "log_message_timestamp_after_max_ms": { "related_topics": [ - "xref:reference:properties/topic-properties.adoc#messagetimestampaftermaxms[`message.timestamp.after.max.ms`]" + "xref:reference:properties/topic-properties.adoc#message-timestamp-after-max-ms[`message.timestamp.after.max.ms`]" ], - "description": "The maximum allowed time difference when a record's timestamp is in the future compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the future. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#messagetimestampaftermaxms[`message.timestamp.after.max.ms`] overrides this cluster-level setting." + "description": "The maximum allowed time difference when a record's timestamp is in the future compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the future. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#message-timestamp-after-max-ms[`message.timestamp.after.max.ms`] overrides this cluster-level setting." }, "log_message_timestamp_before_max_ms": { "related_topics": [ - "xref:reference:properties/topic-properties.adoc#messagetimestampbeforemaxms[`message.timestamp.before.max.ms`]" + "xref:reference:properties/topic-properties.adoc#message-timestamp-before-max-ms[`message.timestamp.before.max.ms`]" ], - "description": "The maximum allowed time difference when a record's timestamp is in the past compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the past. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#messagetimestampbeforemaxms[`message.timestamp.before.max.ms`] overrides this cluster-level setting." + "description": "The maximum allowed time difference when a record's timestamp is in the past compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the past. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#message-timestamp-before-max-ms[`message.timestamp.before.max.ms`] overrides this cluster-level setting." }, "log_message_timestamp_type": { - "description": "Default timestamp type for topic messages (CreateTime or LogAppendTime).\n\nThe topic property xref:./topic-properties.adoc#messagetimestamptype[`message.timestamp.type`] overrides the value of `log_message_timestamp_type` at the topic level.", + "description": "Default timestamp type for topic messages (CreateTime or LogAppendTime).\n\nThe topic property xref:./topic-properties.adoc#message-timestamp-type[`message.timestamp.type`] overrides the value of `log_message_timestamp_type` at the topic level.", "related_topics": [ - "xref:reference:properties/topic-properties.adoc#messagetimestamptype[`message.timestamp.type`]" + "xref:reference:properties/topic-properties.adoc#message-timestamp-type[`message.timestamp.type`]" ], "config_scope": "cluster" }, @@ -1383,7 +1383,7 @@ "log_segment_ms": { "config_scope": "cluster", "related_topics": [ - "self-managed-only:xref:reference:properties/topic-properties.adoc#segmentms[`segment.ms`]" + "self-managed-only:xref:reference:properties/topic-properties.adoc#segment-ms[`segment.ms`]" ], "description": "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`." }, @@ -1418,7 +1418,7 @@ }, "max_compaction_lag_ms": { "related_topics": [ - "xref:reference:properties/topic-properties.adoc#max.compaction.lag.ms[`max.compaction.lag.ms`]" + "xref:reference:properties/topic-properties.adoc#max-compaction-lag-ms[`max.compaction.lag.ms`]" ], "config_scope": "cluster" }, @@ -1492,7 +1492,7 @@ }, "min_compaction_lag_ms": { "related_topics": [ - "xref:reference:properties/topic-properties.adoc#min.compaction.lag.ms[`min.compaction.lag.ms`]" + "xref:reference:properties/topic-properties.adoc#min-compaction-lag-ms[`min.compaction.lag.ms`]" ], "config_scope": "cluster", "description": "The minimum amount of time (in ms) that a log segment must remain unaltered before it can be compacted in a compact topic." @@ -2048,8 +2048,7 @@ "schema_registry_replication_factor": { "description": "Replication factor for internal `_schemas` topic. If unset, defaults to the xref:../cluster-properties.adoc#default_topic_replication[`default_topic_replication`] cluster property.", "related_topics": [ - "xref:../cluster-properties.adoc#default_topic_replication[`default_topic_replication`]", - "xref:../topic-properties.adoc#default_topic_replication[`default_topic_replication`]" + "xref:../cluster-properties.adoc#default_topic_replication[`default_topic_replication`]" ], "config_scope": "broker", "category": "schema-registry", @@ -2276,11 +2275,11 @@ }, "write_caching_default": { "related_topics": [ - "xref:reference:properties/topic-properties.adoc#writecaching[`write.caching`]", + "xref:reference:properties/topic-properties.adoc#write-caching[`write.caching`]", "xref:develop:manage-topics/config-topics.adoc#configure-write-caching[Write caching]" ], "config_scope": "cluster", - "description": "The default write caching mode to apply to user topics. Write caching acknowledges a message as soon as it is received and acknowledged on a majority of brokers, without waiting for it to be written to disk. With `acks=all`, this provides lower latency while still ensuring that a majority of brokers acknowledge the write. \n\nFsyncs follow <> and <>, whichever is reached first.\n\nThe `write_caching_default` cluster property can be overridden with the xref:reference:properties/topic-properties.adoc#writecaching[`write.caching`] topic property." + "description": "The default write caching mode to apply to user topics. Write caching acknowledges a message as soon as it is received and acknowledged on a majority of brokers, without waiting for it to be written to disk. With `acks=all`, this provides lower latency while still ensuring that a majority of brokers acknowledge the write. \n\nFsyncs follow <> and <>, whichever is reached first.\n\nThe `write_caching_default` cluster property can be overridden with the xref:reference:properties/topic-properties.adoc#write-caching[`write.caching`] topic property." }, "delete_topic_enable": { "type": "boolean", diff --git a/modules/develop/pages/transactions.adoc b/modules/develop/pages/transactions.adoc index afa7fffe58..8c63976ec3 100644 --- a/modules/develop/pages/transactions.adoc +++ b/modules/develop/pages/transactions.adoc @@ -323,7 +323,7 @@ Different transactions require different approaches to handling failures within Transactions are supported on topics with compaction configured. The compaction process removes aborted transaction data from the log. The resulting compacted segment contains only committed data batches (and potentially harmless gaps in the offsets due to skipped batches). ifndef::env-cloud[] -At a cluster-level, compaction is set when xref:reference:cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`] or xref:reference:topic-properties.adoc#cleanuppolicy[`cleanup.policy`] are set to either `compact` or `compact,delete`. +At a cluster-level, compaction is set when xref:reference:cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`] or xref:reference:topic-properties.adoc#cleanup-policy[`cleanup.policy`] are set to either `compact` or `compact,delete`. Optionally, you can enable removal of transactional control batches (commit and abort markers) during compaction by setting xref:reference:properties/cluster-properties.adoc#log_compaction_tx_batch_removal_enabled[`log_compaction_tx_batch_removal_enabled`] to `true`. When enabled, the topic's xref:reference:properties/topic-properties.adoc#delete-retention-ms[`delete.retention.ms`] setting is applied to these markers. For topics with a `compact` only cleanup policy, you must explicitly set `delete.retention.ms` at the topic level. This feature is not applied when Tiered Storage is enabled. See xref:manage:cluster-maintenance/compaction-settings.adoc#transactional-control-batch-removal[Transactional control batch removal]. diff --git a/modules/get-started/pages/release-notes/redpanda.adoc b/modules/get-started/pages/release-notes/redpanda.adoc index 6ed7f8e4ba..468dccf544 100644 --- a/modules/get-started/pages/release-notes/redpanda.adoc +++ b/modules/get-started/pages/release-notes/redpanda.adoc @@ -100,7 +100,7 @@ For end-to-end steps and prerequisites, see xref:manage:security/authentication. **Storage mode:** * xref:reference:properties/cluster-properties.adoc#default_redpanda_storage_mode[`default_redpanda_storage_mode`]: Set the default storage mode for new topics (`local`, `tiered`, `cloud`, or `unset`) -* xref:reference:properties/topic-properties.adoc#redpandastoragemode[`redpanda.storage.mode`]: Set the storage mode for an individual topic, superseding the legacy `redpanda.remote.read` and `redpanda.remote.write` properties +* xref:reference:properties/topic-properties.adoc#redpanda-storage-mode[`redpanda.storage.mode`]: Set the storage mode for an individual topic, superseding the legacy `redpanda.remote.read` and `redpanda.remote.write` properties **Cloud Topics:** diff --git a/modules/manage/pages/cluster-maintenance/compaction-settings.adoc b/modules/manage/pages/cluster-maintenance/compaction-settings.adoc index e0d528b982..ea6ca0ab97 100644 --- a/modules/manage/pages/cluster-maintenance/compaction-settings.adoc +++ b/modules/manage/pages/cluster-maintenance/compaction-settings.adoc @@ -20,7 +20,7 @@ While compaction reduces storage needs, Redpanda's compaction (just like Kafka's == Configure a cleanup policy -A compaction policy may be applied to a cluster or to an individual topic. If both are set, the topic-level policy overrides the cluster-level policy. The cluster-level xref:reference:cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`] and the topic-level xref:reference:topic-properties.adoc#cleanuppolicy[`cleanup.policy`] support the following three options: +A compaction policy may be applied to a cluster or to an individual topic. If both are set, the topic-level policy overrides the cluster-level policy. The cluster-level xref:reference:cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`] and the topic-level xref:reference:topic-properties.adoc#cleanup-policy[`cleanup.policy`] support the following three options: * `delete`: Records are deleted from the topic once the specified retention period (time and/or size allocations) is exceeded. This is the default mechanism and is analogous to disabling compaction. * `compact`: This triggers only cleanup of records with multiple versions. A record that represents the only version for a given key is not deleted. @@ -54,7 +54,7 @@ Where: | Cluster | 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. -| xref:reference:properties/topic-properties.adoc#mincleanabledirtyratio[`min.cleanable.dirty.ratio`] +| xref:reference:properties/topic-properties.adoc#min-cleanable-dirty-ratio[`min.cleanable.dirty.ratio`] | Topic | Topic-level override of the cluster-wide dirty ratio threshold. @@ -70,11 +70,11 @@ Where: | Cluster | The minimum time in milliseconds that a message remains uncompacted in the log. Use to guarantee the minimum length of time that must pass after a message is written before it could be compacted. For example, to provide a lower bound on how long each message will remain in the (uncompacted) head. -| xref:reference:properties/topic-properties.adoc#maxcompactionlagms[`max.compaction.lag.ms`] +| xref:reference:properties/topic-properties.adoc#max-compaction-lag-ms[`max.compaction.lag.ms`] | Topic | The maximum amount of time in milliseconds that a message remains ineligible for compaction. Use to guarantee the maximum delay between the time a message is written and the time the message becomes eligible for compaction. -| xref:reference:properties/topic-properties.adoc#mincompactionlagms[`min.compaction.lag.ms`] +| xref:reference:properties/topic-properties.adoc#min-compaction-lag-ms[`min.compaction.lag.ms`] | Topic | The minimum time in milliseconds that a message remains uncompacted in the log. Use to guarantee the minimum length of time that must pass after a message is written before it could be compacted. For example, to provide a lower bound on how long each message will remain in the (uncompacted) head. |=== @@ -106,7 +106,7 @@ Redpanda runs a scan every `log_compaction_interval_ms`. During each scan: Compaction also enables deletion of existing records through tombstones. For example, as data is deleted from a source system, clients produce a tombstone record to the log. A tombstone contains a key and the value `null`. Tombstones signal to brokers and consumers that records with the same key prior to it in the log should be deleted. -You can specify how long Redpanda keeps these tombstones for compacted topics using both a cluster configuration property config_ref:tombstone_retention_ms,true,properties/cluster-properties[] and a topic configuration property xref:reference:properties/topic-properties.adoc#deleteretentionms[`delete.retention.ms`]. If both are set, the topic-level tombstone retention policy overrides the cluster-level policy. +You can specify how long Redpanda keeps these tombstones for compacted topics using both a cluster configuration property config_ref:tombstone_retention_ms,true,properties/cluster-properties[] and a topic configuration property xref:reference:properties/topic-properties.adoc#delete-retention-ms[`delete.retention.ms`]. If both are set, the topic-level tombstone retention policy overrides the cluster-level policy. [NOTE] ==== diff --git a/modules/manage/pages/cluster-maintenance/topic-property-configuration.adoc b/modules/manage/pages/cluster-maintenance/topic-property-configuration.adoc index 88023d0673..d7d6626df2 100644 --- a/modules/manage/pages/cluster-maintenance/topic-property-configuration.adoc +++ b/modules/manage/pages/cluster-maintenance/topic-property-configuration.adoc @@ -185,7 +185,7 @@ The most commonly configured topic properties fall into these main categories: Redpanda manages disk space through two main mechanisms: **compaction** (removing duplicate keys) and **retention** (removing old data). -Choose your cleanup strategy with xref:reference:properties/topic-properties.adoc#cleanuppolicy[`cleanup.policy`]: +Choose your cleanup strategy with xref:reference:properties/topic-properties.adoc#cleanup-policy[`cleanup.policy`]: - `delete` - Remove old data based on time or size limits - `compact` - Keep only the latest value for each key - `compact,delete` - Combine both strategies @@ -194,9 +194,9 @@ Choose your cleanup strategy with xref:reference:properties/topic-properties.ado When using `cleanup.policy=compact` or `cleanup.policy=compact,delete`, configure: -- xref:reference:properties/topic-properties.adoc#mincleanabledirtyratio[`min.cleanable.dirty.ratio`] - Control when compaction triggers based on dirty data ratio -- xref:reference:properties/topic-properties.adoc#maxcompactionlagms[`max.compaction.lag.ms`] - Set maximum time before compaction is forced -- xref:reference:properties/topic-properties.adoc#mincompactionlagms[`min.compaction.lag.ms`] - Set minimum time before compaction can occur +- xref:reference:properties/topic-properties.adoc#min-cleanable-dirty-ratio[`min.cleanable.dirty.ratio`] - Control when compaction triggers based on dirty data ratio +- xref:reference:properties/topic-properties.adoc#max-compaction-lag-ms[`max.compaction.lag.ms`] - Set maximum time before compaction is forced +- xref:reference:properties/topic-properties.adoc#min-compaction-lag-ms[`min.compaction.lag.ms`] - Set minimum time before compaction can occur === Retention @@ -204,15 +204,15 @@ When using `cleanup.policy=delete` or `cleanup.policy=compact,delete`, configure - xref:reference:properties/topic-properties.adoc#retention-bytes[`retention.bytes`] - Maximum size before cleanup (size-based retention) - xref:reference:properties/topic-properties.adoc#retention-ms[`retention.ms`] - Maximum age before cleanup (time-based retention) -- xref:reference:properties/topic-properties.adoc#segmentbytes[`segment.bytes`] - Control how frequently cleanup can occur by setting segment size +- xref:reference:properties/topic-properties.adoc#segment-bytes[`segment.bytes`] - Control how frequently cleanup can occur by setting segment size === Performance Essential performance tuning properties: -- xref:reference:properties/topic-properties.adoc#writecaching[`write.caching`] - Cache writes for lower latency with `acks=all` -- xref:reference:properties/topic-properties.adoc#maxmessagebytes[`max.message.bytes`] - Set maximum message size -- xref:reference:properties/topic-properties.adoc#replicationfactor[`replication.factor`] - Number of replicas for durability vs. performance +- xref:reference:properties/topic-properties.adoc#write-caching[`write.caching`] - Cache writes for lower latency with `acks=all` +- xref:reference:properties/topic-properties.adoc#max-message-bytes[`max.message.bytes`] - Set maximum message size +- xref:reference:properties/topic-properties.adoc#replication-factor[`replication.factor`] - Number of replicas for durability vs. performance For complete details about all available topic properties, see xref:reference:properties/topic-properties.adoc[Topic Configuration Properties]. diff --git a/modules/manage/pages/kubernetes/k-manage-topics.adoc b/modules/manage/pages/kubernetes/k-manage-topics.adoc index d971284876..4e4e18bc06 100644 --- a/modules/manage/pages/kubernetes/k-manage-topics.adoc +++ b/modules/manage/pages/kubernetes/k-manage-topics.adoc @@ -326,7 +326,7 @@ With `write_caching` enabled at the cluster level, Redpanda fsyncs to disk accor === Configure at topic level -To override the cluster-level setting at the topic level, set the topic-level property xref:reference:topic-properties.adoc#writecaching[`write.caching`]: +To override the cluster-level setting at the topic level, set the topic-level property xref:reference:topic-properties.adoc#write-caching[`write.caching`]: .`example-topic.yaml` [,yaml,indent=0] @@ -334,7 +334,7 @@ To override the cluster-level setting at the topic level, set the topic-level pr include::manage:example$kubernetes/topic-crds.feature[tags=write-caching-topic-example,indent=0] ---- -With `write.caching` enabled at the topic level, Redpanda fsyncs to disk according to xref:reference:topic-properties.adoc#flushms[`flush.ms`] and xref:reference:topic-properties.adoc#flushbytes[`flush.bytes`], whichever is reached first. +With `write.caching` enabled at the topic level, Redpanda fsyncs to disk according to xref:reference:topic-properties.adoc#flush-ms[`flush.ms`] and xref:reference:topic-properties.adoc#flush-bytes[`flush.bytes`], whichever is reached first. == Verify a topic diff --git a/modules/manage/pages/schema-reg/schema-id-validation.adoc b/modules/manage/pages/schema-reg/schema-id-validation.adoc index 16261d0de3..d86af80f5f 100644 --- a/modules/manage/pages/schema-reg/schema-id-validation.adoc +++ b/modules/manage/pages/schema-reg/schema-id-validation.adoc @@ -88,8 +88,8 @@ When <>, Redpanda u To customize the subject name strategy per topic, set the following client topic properties: ifndef::env-cloud[] -* Set xref:reference:properties/topic-properties.adoc#redpandakeyschemavalidation[`redpanda.key.schema.id.validation`] to `true` to enable key schema ID validation for the topic, and set xref:reference:properties/topic-properties.adoc#redpandakeysubjectnamestrategy[`redpanda.key.subject.name.strategy`] to the desired subject name strategy for keys of the topic (default: `TopicNameStrategy`). -* Set xref:reference:properties/topic-properties.adoc#redpandavalueschemavalidation[`redpanda.value.schema.id.validation`] to `true` to enable value schema ID validation for the topic, and set xref:reference:properties/topic-properties.adoc#redpandavaluesubjectnamestrategy[`redpanda.value.subject.name.strategy`] to the desired subject name strategy for values of the topic (default: `TopicNameStrategy`). +* Set xref:reference:properties/topic-properties.adoc#redpanda-key-schema-id-validation[`redpanda.key.schema.id.validation`] to `true` to enable key schema ID validation for the topic, and set xref:reference:properties/topic-properties.adoc#redpanda-key-subject-name-strategy[`redpanda.key.subject.name.strategy`] to the desired subject name strategy for keys of the topic (default: `TopicNameStrategy`). +* Set xref:reference:properties/topic-properties.adoc#redpanda-value-schema-id-validation[`redpanda.value.schema.id.validation`] to `true` to enable value schema ID validation for the topic, and set xref:reference:properties/topic-properties.adoc#redpanda-value-subject-name-strategy[`redpanda.value.subject.name.strategy`] to the desired subject name strategy for values of the topic (default: `TopicNameStrategy`). [NOTE] ==== @@ -98,17 +98,17 @@ The `redpanda.` properties have corresponding `confluent.` properties. |=== | Redpanda property | Confluent property -| xref:reference:properties/topic-properties.adoc#redpandakeyschemavalidation[`redpanda.key.schema.id.validation`] -| xref:reference:properties/topic-properties.adoc#confluentkeyschemavalidation[`confluent.key.schema.validation`] +| xref:reference:properties/topic-properties.adoc#redpanda-key-schema-id-validation[`redpanda.key.schema.id.validation`] +| xref:reference:properties/topic-properties.adoc#confluent-key-schema-validation[`confluent.key.schema.validation`] -| xref:reference:properties/topic-properties.adoc#redpandakeysubjectnamestrategy[`redpanda.key.subject.name.strategy`] -| xref:reference:properties/topic-properties.adoc#confluentkeysubjectnamestrategy[`confluent.key.subject.name.strategy`] +| xref:reference:properties/topic-properties.adoc#redpanda-key-subject-name-strategy[`redpanda.key.subject.name.strategy`] +| xref:reference:properties/topic-properties.adoc#confluent-key-subject-name-strategy[`confluent.key.subject.name.strategy`] -| xref:reference:properties/topic-properties.adoc#redpandavalueschemavalidation[`redpanda.value.schema.id.validation`] -| xref:reference:properties/topic-properties.adoc#confluentvalueschemavalidation[`confluent.value.schema.validation`] +| xref:reference:properties/topic-properties.adoc#redpanda-value-schema-id-validation[`redpanda.value.schema.id.validation`] +| xref:reference:properties/topic-properties.adoc#confluent-value-schema-validation[`confluent.value.schema.validation`] -| xref:reference:properties/topic-properties.adoc#redpandavaluesubjectnamestrategy[`redpanda.value.subject.name.strategy`] -| xref:reference:properties/topic-properties.adoc#confluentvaluesubjectnamestrategy[`confluent.value.subject.name.strategy`] +| xref:reference:properties/topic-properties.adoc#redpanda-value-subject-name-strategy[`redpanda.value.subject.name.strategy`] +| xref:reference:properties/topic-properties.adoc#confluent-value-subject-name-strategy[`confluent.value.subject.name.strategy`] |=== ==== endif::[] diff --git a/modules/manage/partials/tiered-storage.adoc b/modules/manage/partials/tiered-storage.adoc index a3f8fc6dc8..775dd96f9f 100644 --- a/modules/manage/partials/tiered-storage.adoc +++ b/modules/manage/partials/tiered-storage.adoc @@ -1015,7 +1015,7 @@ See also: xref:manage:cluster-maintenance/disk-utilization.adoc#configure-messag ==== Compacted topics in Tiered Storage -When you set xref:reference:topic-properties.adoc#cleanuppolicy[`cleanup.policy`] for a topic to `compact`, nothing gets deleted from object storage based on retention settings. When set to `compact,delete`, compacted segments are deleted from object storage based on `retention.ms` and `retention.bytes`. +When you set xref:reference:topic-properties.adoc#cleanup-policy[`cleanup.policy`] for a topic to `compact`, nothing gets deleted from object storage based on retention settings. When set to `compact,delete`, compacted segments are deleted from object storage based on `retention.ms` and `retention.bytes`. For compacted topics, Redpanda compacts segments after they have been uploaded to object storage. Redpanda initially uploads all uncompacted segments. It then re-uploads the segments with compaction applied. It's likely that some segments in object storage are not compacted, but the Tiered Storage read path can manage this. From 87528a55fdc5a3f911647457b4ca890efd03699c Mon Sep 17 00:00:00 2001 From: Joyce Fee Date: Thu, 4 Jun 2026 16:43:13 -0400 Subject: [PATCH 2/3] fix(DOC-2226): propagate anchor fixes to generated property partials MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Companion to the previous commit's source-override fix. Apply the broken-anchor → hyphenated-anchor mapping to the four generated files under modules/reference/partials/properties/ and modules/reference/attachments/, so this PR ships a complete sweep rather than leaving the generated files for a later regen cycle. Approach: ran `doc-tools generate property-docs --tag v26.1.9 --generate-partials` to produce the full regen, then reverted the four generated files to pre-regen state and applied ONLY the anchor substitution (same mapping the previous commit used on the hand-edited referrers). End state is mechanically equivalent to a regen with the unrelated source drift reverted, but achieved without committing the drift in the first place. Drift the regen would have introduced (intentionally NOT applied here; needs a separate coordinated property-docs resync ticket): - delete_topic_enable: description rewrite + new Related topics section - raft_election_timeout_ms: type change string → integer, default null → 1500 - features_auto_finalization: "Introduced in v26.1.9" annotation - iceberg_rest_catalog_gcp_user_project: NOTE added, redpanda-cloud tags repositioned, default text adjusted 36 anchor substitutions in this commit: - modules/reference/partials/properties/cluster-properties.adoc (17) - modules/reference/attachments/redpanda-properties-v26.1.9.json (18) - modules/reference/partials/properties/object-storage-properties.adoc (1) Plus one default_topic_replication dedup: - modules/reference/partials/properties/broker-properties.adoc (dropped the off-target topic-properties xref; only the correct cluster-properties xref remains) - modules/reference/attachments/redpanda-properties-v26.1.9.json (same dedup in the schema_registry_replication_factor related_topics list) After this commit, the only remaining "broken" topic-properties anchor in the entire repo is `#redpanda-iceberg-enabled` (3 refs, all in generated files), which is flagged for follow-up in the previous commit message — no matching H3 on topic-properties; the property may have been renamed or deprecated. Co-Authored-By: Claude Opus 4.7 --- .../redpanda-properties-v26.1.9.json | 39 +++++++++---------- .../properties/broker-properties.adoc | 5 +-- .../properties/cluster-properties.adoc | 34 ++++++++-------- .../properties/object-storage-properties.adoc | 2 +- 4 files changed, 38 insertions(+), 42 deletions(-) diff --git a/modules/reference/attachments/redpanda-properties-v26.1.9.json b/modules/reference/attachments/redpanda-properties-v26.1.9.json index 9c3f22324c..8356577193 100644 --- a/modules/reference/attachments/redpanda-properties-v26.1.9.json +++ b/modules/reference/attachments/redpanda-properties-v26.1.9.json @@ -2007,7 +2007,7 @@ "needs_restart": false, "nullable": false, "related_topics": [ - "xref:properties/topic-properties.adoc#redpandaremoteallowgaps[`redpanda.remote.allowgaps`]" + "xref:properties/topic-properties.adoc#redpanda-remote-allowgaps[`redpanda.remote.allowgaps`]" ], "type": "boolean", "visibility": "tunable" @@ -8042,7 +8042,7 @@ "config_scope": "cluster", "default": 104857600, "defined_in": "src/v/config/configuration.cc", - "description": "The maximum value you can set for the xref:./topic-properties.adoc#maxmessagebytes[`max.message.bytes`] topic property. When set to `null`, no limit is enforced.", + "description": "The maximum value you can set for the xref:./topic-properties.adoc#max-message-bytes[`max.message.bytes`] topic property. When set to `null`, no limit is enforced.", "is_deprecated": false, "is_enterprise": false, "maximum": 2147483647, @@ -8051,7 +8051,7 @@ "needs_restart": false, "nullable": true, "related_topics": [ - "xref:reference:properties/topic-properties.adoc#maxmessagebytes[`max.message.bytes`]" + "xref:reference:properties/topic-properties.adoc#max-message-bytes[`max.message.bytes`]" ], "type": "integer", "visibility": "tunable" @@ -8885,7 +8885,7 @@ "config_scope": "cluster", "default": "delete", "defined_in": "src/v/config/configuration.cc", - "description": "Default cleanup policy for topic logs.\n\nThe topic property xref:./topic-properties.adoc#cleanuppolicy[`cleanup.policy`] overrides the value of `log_cleanup_policy` at the topic level.", + "description": "Default cleanup policy for topic logs.\n\nThe topic property xref:./topic-properties.adoc#cleanup-policy[`cleanup.policy`] overrides the value of `log_cleanup_policy` at the topic level.", "enum": [ "none", "delete", @@ -8898,7 +8898,7 @@ "needs_restart": false, "nullable": false, "related_topics": [ - "xref:reference:properties/topic-properties.adoc#cleanuppolicy[`cleanup.policy`]" + "xref:reference:properties/topic-properties.adoc#cleanup-policy[`cleanup.policy`]" ], "type": "string", "visibility": "user" @@ -9064,7 +9064,7 @@ "config_scope": "cluster", "default": "producer", "defined_in": "src/v/config/configuration.cc", - "description": "IMPORTANT: This property is ignored regardless of the value specified. The behavior is always the same as the `producer` value. Redpanda brokers do not compress or recompress data based on this property. If producers send compressed data, Redpanda stores it as-is; if producers send uncompressed data, Redpanda stores it uncompressed. Other listed values are accepted for Apache Kafka compatibility but are ignored by the broker. This property may appear in Admin API and `rpk topic describe` outputs for compatibility.\n\nDefault for the Kafka-compatible compression.type property. Redpanda does not recompress data.\n\nThe topic property xref:./topic-properties.adoc#compressiontype[`compression.type`] overrides the value of `log_compression_type` at the topic level.", + "description": "IMPORTANT: This property is ignored regardless of the value specified. The behavior is always the same as the `producer` value. Redpanda brokers do not compress or recompress data based on this property. If producers send compressed data, Redpanda stores it as-is; if producers send uncompressed data, Redpanda stores it uncompressed. Other listed values are accepted for Apache Kafka compatibility but are ignored by the broker. This property may appear in Admin API and `rpk topic describe` outputs for compatibility.\n\nDefault for the Kafka-compatible compression.type property. Redpanda does not recompress data.\n\nThe topic property xref:./topic-properties.adoc#compression-type[`compression.type`] overrides the value of `log_compression_type` at the topic level.", "enum": [ "none", "gzip", @@ -9081,7 +9081,7 @@ "needs_restart": false, "nullable": false, "related_topics": [ - "xref:reference:properties/topic-properties.adoc#compressiontype[`compression.type`]" + "xref:reference:properties/topic-properties.adoc#compression-type[`compression.type`]" ], "type": "string", "visibility": "user" @@ -9114,7 +9114,7 @@ "default": 3600000, "default_human_readable": "1 hour", "defined_in": "src/v/config/configuration.cc", - "description": "The maximum allowed time difference when a record's timestamp is in the future compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the future. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#messagetimestampaftermaxms[`message.timestamp.after.max.ms`] overrides this cluster-level setting.", + "description": "The maximum allowed time difference when a record's timestamp is in the future compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the future. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#message-timestamp-after-max-ms[`message.timestamp.after.max.ms`] overrides this cluster-level setting.", "is_deprecated": false, "is_enterprise": false, "maximum": 17592186044415, @@ -9123,7 +9123,7 @@ "needs_restart": false, "nullable": false, "related_topics": [ - "xref:reference:properties/topic-properties.adoc#messagetimestampaftermaxms[`message.timestamp.after.max.ms`]" + "xref:reference:properties/topic-properties.adoc#message-timestamp-after-max-ms[`message.timestamp.after.max.ms`]" ], "type": "integer", "visibility": "user" @@ -9137,7 +9137,7 @@ "config_scope": "cluster", "default": 9223372036854, "defined_in": "src/v/config/configuration.cc", - "description": "The maximum allowed time difference when a record's timestamp is in the past compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the past. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#messagetimestampbeforemaxms[`message.timestamp.before.max.ms`] overrides this cluster-level setting.", + "description": "The maximum allowed time difference when a record's timestamp is in the past compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the past. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#message-timestamp-before-max-ms[`message.timestamp.before.max.ms`] overrides this cluster-level setting.", "is_deprecated": false, "is_enterprise": false, "maximum": 17592186044415, @@ -9146,7 +9146,7 @@ "needs_restart": false, "nullable": false, "related_topics": [ - "xref:reference:properties/topic-properties.adoc#messagetimestampbeforemaxms[`message.timestamp.before.max.ms`]" + "xref:reference:properties/topic-properties.adoc#message-timestamp-before-max-ms[`message.timestamp.before.max.ms`]" ], "type": "integer", "visibility": "user" @@ -9160,7 +9160,7 @@ "config_scope": "cluster", "default": "CreateTime", "defined_in": "src/v/config/configuration.cc", - "description": "Default timestamp type for topic messages (CreateTime or LogAppendTime).\n\nThe topic property xref:./topic-properties.adoc#messagetimestamptype[`message.timestamp.type`] overrides the value of `log_message_timestamp_type` at the topic level.", + "description": "Default timestamp type for topic messages (CreateTime or LogAppendTime).\n\nThe topic property xref:./topic-properties.adoc#message-timestamp-type[`message.timestamp.type`] overrides the value of `log_message_timestamp_type` at the topic level.", "enum": [ "CreateTime", "LogAppendTime" @@ -9172,7 +9172,7 @@ "needs_restart": false, "nullable": false, "related_topics": [ - "xref:reference:properties/topic-properties.adoc#messagetimestamptype[`message.timestamp.type`]" + "xref:reference:properties/topic-properties.adoc#message-timestamp-type[`message.timestamp.type`]" ], "type": "string", "visibility": "user" @@ -9221,7 +9221,7 @@ "needs_restart": false, "nullable": true, "related_topics": [ - "self-managed-only:xref:reference:properties/topic-properties.adoc#segmentms[`segment.ms`]" + "self-managed-only:xref:reference:properties/topic-properties.adoc#segment-ms[`segment.ms`]" ], "type": "integer", "visibility": "user" @@ -9462,7 +9462,7 @@ "needs_restart": false, "nullable": false, "related_topics": [ - "xref:reference:properties/topic-properties.adoc#max.compaction.lag.ms[`max.compaction.lag.ms`]" + "xref:reference:properties/topic-properties.adoc#max-compaction-lag-ms[`max.compaction.lag.ms`]" ], "type": "integer", "visibility": "user" @@ -9924,7 +9924,7 @@ "needs_restart": false, "nullable": false, "related_topics": [ - "xref:reference:properties/topic-properties.adoc#min.compaction.lag.ms[`min.compaction.lag.ms`]" + "xref:reference:properties/topic-properties.adoc#min-compaction-lag-ms[`min.compaction.lag.ms`]" ], "type": "integer", "visibility": "user" @@ -12803,8 +12803,7 @@ "needs_restart": true, "nullable": true, "related_topics": [ - "xref:../cluster-properties.adoc#default_topic_replication[`default_topic_replication`]", - "xref:../topic-properties.adoc#default_topic_replication[`default_topic_replication`]" + "xref:../cluster-properties.adoc#default_topic_replication[`default_topic_replication`]" ], "type": "integer" }, @@ -14033,7 +14032,7 @@ "config_scope": "cluster", "default": "false", "defined_in": "src/v/config/configuration.cc", - "description": "The default write caching mode to apply to user topics. Write caching acknowledges a message as soon as it is received and acknowledged on a majority of brokers, without waiting for it to be written to disk. With `acks=all`, this provides lower latency while still ensuring that a majority of brokers acknowledge the write. \n\nFsyncs follow <> and <>, whichever is reached first.\n\nThe `write_caching_default` cluster property can be overridden with the xref:reference:properties/topic-properties.adoc#writecaching[`write.caching`] topic property.", + "description": "The default write caching mode to apply to user topics. Write caching acknowledges a message as soon as it is received and acknowledged on a majority of brokers, without waiting for it to be written to disk. With `acks=all`, this provides lower latency while still ensuring that a majority of brokers acknowledge the write. \n\nFsyncs follow <> and <>, whichever is reached first.\n\nThe `write_caching_default` cluster property can be overridden with the xref:reference:properties/topic-properties.adoc#write-caching[`write.caching`] topic property.", "enum": [ "true", "false", @@ -14046,7 +14045,7 @@ "needs_restart": false, "nullable": false, "related_topics": [ - "xref:reference:properties/topic-properties.adoc#writecaching[`write.caching`]", + "xref:reference:properties/topic-properties.adoc#write-caching[`write.caching`]", "xref:develop:manage-topics/config-topics.adoc#configure-write-caching[Write caching]" ], "type": "string", diff --git a/modules/reference/partials/properties/broker-properties.adoc b/modules/reference/partials/properties/broker-properties.adoc index 9aa32c0321..b34738c0a9 100644 --- a/modules/reference/partials/properties/broker-properties.adoc +++ b/modules/reference/partials/properties/broker-properties.adoc @@ -2989,10 +2989,7 @@ pandaproxy: ---- | Related topics -| -* xref:../cluster-properties.adoc#default_topic_replication[`default_topic_replication`] - -* xref:../topic-properties.adoc#default_topic_replication[`default_topic_replication`] +|xref:../cluster-properties.adoc#default_topic_replication[`default_topic_replication`] |=== diff --git a/modules/reference/partials/properties/cluster-properties.adoc b/modules/reference/partials/properties/cluster-properties.adoc index 76f6b4d589..6ce12fec6c 100644 --- a/modules/reference/partials/properties/cluster-properties.adoc +++ b/modules/reference/partials/properties/cluster-properties.adoc @@ -10067,7 +10067,7 @@ endif::[] === kafka_max_message_size_upper_limit_bytes -The maximum value you can set for the xref:./topic-properties.adoc#maxmessagebytes[`max.message.bytes`] topic property. When set to `null`, no limit is enforced. +The maximum value you can set for the xref:./topic-properties.adoc#max-message-bytes[`max.message.bytes`] topic property. When set to `null`, no limit is enforced. [cols="1s,2a"] |=== @@ -10110,7 +10110,7 @@ ifndef::env-cloud[] endif::[] | Related topics -|xref:reference:properties/topic-properties.adoc#maxmessagebytes[`max.message.bytes`] +|xref:reference:properties/topic-properties.adoc#max-message-bytes[`max.message.bytes`] |=== @@ -11936,7 +11936,7 @@ endif::[] Default cleanup policy for topic logs. -The topic property xref:./topic-properties.adoc#cleanuppolicy[`cleanup.policy`] overrides the value of `log_cleanup_policy` at the topic level. +The topic property xref:./topic-properties.adoc#cleanup-policy[`cleanup.policy`] overrides the value of `log_cleanup_policy` at the topic level. [cols="1s,2a"] |=== @@ -11985,7 +11985,7 @@ endif::[] `compact,delete` | Related topics -|xref:reference:properties/topic-properties.adoc#cleanuppolicy[`cleanup.policy`] +|xref:reference:properties/topic-properties.adoc#cleanup-policy[`cleanup.policy`] |=== @@ -12343,7 +12343,7 @@ IMPORTANT: This property is ignored regardless of the value specified. The behav Default for the Kafka-compatible compression.type property. Redpanda does not recompress data. -The topic property xref:./topic-properties.adoc#compressiontype[`compression.type`] overrides the value of `log_compression_type` at the topic level. +The topic property xref:./topic-properties.adoc#compression-type[`compression.type`] overrides the value of `log_compression_type` at the topic level. [cols="1s,2a"] |=== @@ -12392,7 +12392,7 @@ endif::[] `snappy` | Related topics -|xref:reference:properties/topic-properties.adoc#compressiontype[`compression.type`] +|xref:reference:properties/topic-properties.adoc#compression-type[`compression.type`] |=== @@ -12440,7 +12440,7 @@ endif::[] === log_message_timestamp_after_max_ms -The maximum allowed time difference when a record's timestamp is in the future compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the future. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#messagetimestampaftermaxms[`message.timestamp.after.max.ms`] overrides this cluster-level setting. +The maximum allowed time difference when a record's timestamp is in the future compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the future. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#message-timestamp-after-max-ms[`message.timestamp.after.max.ms`] overrides this cluster-level setting. [cols="1s,2a"] |=== @@ -12483,14 +12483,14 @@ ifndef::env-cloud[] endif::[] | Related topics -|xref:reference:properties/topic-properties.adoc#messagetimestampaftermaxms[`message.timestamp.after.max.ms`] +|xref:reference:properties/topic-properties.adoc#message-timestamp-after-max-ms[`message.timestamp.after.max.ms`] |=== === log_message_timestamp_before_max_ms -The maximum allowed time difference when a record's timestamp is in the past compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the past. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#messagetimestampbeforemaxms[`message.timestamp.before.max.ms`] overrides this cluster-level setting. +The maximum allowed time difference when a record's timestamp is in the past compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the past. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#message-timestamp-before-max-ms[`message.timestamp.before.max.ms`] overrides this cluster-level setting. [cols="1s,2a"] |=== @@ -12533,7 +12533,7 @@ ifndef::env-cloud[] endif::[] | Related topics -|xref:reference:properties/topic-properties.adoc#messagetimestampbeforemaxms[`message.timestamp.before.max.ms`] +|xref:reference:properties/topic-properties.adoc#message-timestamp-before-max-ms[`message.timestamp.before.max.ms`] |=== @@ -12542,7 +12542,7 @@ endif::[] Default timestamp type for topic messages (CreateTime or LogAppendTime). -The topic property xref:./topic-properties.adoc#messagetimestamptype[`message.timestamp.type`] overrides the value of `log_message_timestamp_type` at the topic level. +The topic property xref:./topic-properties.adoc#message-timestamp-type[`message.timestamp.type`] overrides the value of `log_message_timestamp_type` at the topic level. [cols="1s,2a"] |=== @@ -12591,7 +12591,7 @@ endif::[] `LogAppendTime` | Related topics -|xref:reference:properties/topic-properties.adoc#messagetimestamptype[`message.timestamp.type`] +|xref:reference:properties/topic-properties.adoc#message-timestamp-type[`message.timestamp.type`] |=== @@ -12703,7 +12703,7 @@ endif::[] ifndef::env-cloud[] | Related topics -|xref:reference:properties/topic-properties.adoc#segmentms[`segment.ms`] +|xref:reference:properties/topic-properties.adoc#segment-ms[`segment.ms`] endif::[] |=== @@ -13136,7 +13136,7 @@ ifndef::env-cloud[] endif::[] | Related topics -|xref:reference:properties/topic-properties.adoc#max.compaction.lag.ms[`max.compaction.lag.ms`] +|xref:reference:properties/topic-properties.adoc#max-compaction-lag-ms[`max.compaction.lag.ms`] |=== @@ -13824,7 +13824,7 @@ ifndef::env-cloud[] endif::[] | Related topics -|xref:reference:properties/topic-properties.adoc#min.compaction.lag.ms[`min.compaction.lag.ms`] +|xref:reference:properties/topic-properties.adoc#min-compaction-lag-ms[`min.compaction.lag.ms`] |=== @@ -19901,7 +19901,7 @@ The default write caching mode to apply to user topics. Write caching acknowledg Fsyncs follow <> and <>, whichever is reached first. -The `write_caching_default` cluster property can be overridden with the xref:reference:properties/topic-properties.adoc#writecaching[`write.caching`] topic property. +The `write_caching_default` cluster property can be overridden with the xref:reference:properties/topic-properties.adoc#write-caching[`write.caching`] topic property. [cols="1s,2a"] |=== @@ -19951,7 +19951,7 @@ endif::[] | Related topics | -* xref:reference:properties/topic-properties.adoc#writecaching[`write.caching`] +* xref:reference:properties/topic-properties.adoc#write-caching[`write.caching`] * xref:develop:manage-topics/config-topics.adoc#configure-write-caching[Write caching] diff --git a/modules/reference/partials/properties/object-storage-properties.adoc b/modules/reference/partials/properties/object-storage-properties.adoc index ed37c029f1..11de3b2f0d 100644 --- a/modules/reference/partials/properties/object-storage-properties.adoc +++ b/modules/reference/partials/properties/object-storage-properties.adoc @@ -2237,7 +2237,7 @@ ifndef::env-cloud[] endif::[] | Related topics -|xref:properties/topic-properties.adoc#redpandaremoteallowgaps[`redpanda.remote.allowgaps`] +|xref:properties/topic-properties.adoc#redpanda-remote-allowgaps[`redpanda.remote.allowgaps`] |=== From 3494c0c8a1f9bd250253a789fed267faa3805b3c Mon Sep 17 00:00:00 2001 From: Joyce Fee Date: Fri, 5 Jun 2026 15:01:50 -0400 Subject: [PATCH 3/3] fix(DOC-2226): normalize xref paths and clean up broken anchor refs Addresses PR review feedback on the anchor sweep. Two passes: 1. Path normalization: convert every non-canonical xref targeting topic-properties.adoc or cluster-properties.adoc to the full Antora resource ID `xref:reference:properties/{topic,cluster}-properties.adoc`. Covers `xref:./`, `xref:../`, `xref:properties/`, `xref:cluster-properties.adoc`, and `xref:reference:cluster-properties.adoc` variants across property-overrides.json, transactions.adoc, k-manage-topics.adoc, tiered-storage.adoc, and the matching generated partials and attachment JSON. 2. Broken anchor cleanup: 8 renames where target moved/renamed (cloud_storage_enabled and cloud_storage_enable_remote_* now in object-storage-properties; initial_retention_local_target_* and retention_local_target_* gained `_default` suffix). 4 entries dropped where the target property is no longer documented (compaction_strategy, flush_bytes, flush_ms, redpanda-iceberg-enabled). Validated: all 317 canonical xrefs across the 7 modified files now resolve to existing anchors; 0 broken refs remain. Co-Authored-By: Claude Opus 4.7 (1M context) --- docs-data/property-overrides.json | 74 ++++++------ modules/develop/pages/transactions.adoc | 2 +- .../pages/kubernetes/k-manage-topics.adoc | 4 +- modules/manage/partials/tiered-storage.adoc | 2 +- .../redpanda-properties-v26.1.9.json | 86 +++++++------- .../properties/cluster-properties.adoc | 21 ++-- .../partials/properties/topic-properties.adoc | 107 ++++++++---------- 7 files changed, 135 insertions(+), 161 deletions(-) diff --git a/docs-data/property-overrides.json b/docs-data/property-overrides.json index cb61956094..9d34ab7769 100644 --- a/docs-data/property-overrides.json +++ b/docs-data/property-overrides.json @@ -137,9 +137,9 @@ "description": "Network addresses of the Kafka API servers to which the HTTP Proxy client should connect." }, "cleanup.policy": { - "description": "The cleanup policy to apply for log segments of a topic.\nWhen `cleanup.policy` is set, it overrides the cluster property xref:cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`] for the topic.\n\n**Values**:\n\n- `delete` - Deletes data according to size-based or time-based retention limits, or both.\n- `compact` - Deletes data according to a key-based retention policy, discarding all but the latest value for each key.\n- `compact,delete` - The latest values are kept for each key, while the remaining data is deleted according to retention limits.", + "description": "The cleanup policy to apply for log segments of a topic.\nWhen `cleanup.policy` is set, it overrides the cluster property xref:reference:properties/cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`] for the topic.\n\n**Values**:\n\n- `delete` - Deletes data according to size-based or time-based retention limits, or both.\n- `compact` - Deletes data according to a key-based retention policy, discarding all but the latest value for each key.\n- `compact,delete` - The latest values are kept for each key, while the remaining data is deleted according to retention limits.", "related_topics": [ - "xref:cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`]", + "xref:reference:properties/cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`]", "xref:manage:cluster-maintenance/disk-utilization.adoc#configure-segment-size[Configure segment size]", "xref:manage:tiered-storage.adoc#compacted-topics-in-tiered-storage[Compacted topics in Tiered Storage]", "xref:reference:properties/cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`]" @@ -197,7 +197,7 @@ "description": "AWS or GCP bucket that should be used to store data.\n\nWARNING: Modifying this property after writing data to a bucket could cause data loss." }, "cloud_storage_cache_directory": { - "description": "Directory for archival cache. Set when the xref:reference:properties/cluster-properties.adoc#cloud_storage_enabled[`cloud_storage_enabled`] cluster property is enabled. If not specified, Redpanda uses a default path within the data directory.", + "description": "Directory for archival cache. Set when the xref:reference:properties/object-storage-properties.adoc#cloud_storage_enabled[`cloud_storage_enabled`] cluster property is enabled. If not specified, Redpanda uses a default path within the data directory.", "example": [ "[,yaml]", "----", @@ -208,7 +208,7 @@ "Replace `` with the full path to your desired cache directory." ], "related_topics": [ - "xref:reference:properties/cluster-properties.adoc#cloud_storage_enabled[`cloud_storage_enabled`]" + "xref:reference:properties/object-storage-properties.adoc#cloud_storage_enabled[`cloud_storage_enabled`]" ], "config_scope": "broker", "category": "redpanda" @@ -221,9 +221,9 @@ }, "cloud_storage_cache_size_percent": { "related_topics": [ - "xref:reference:cluster-properties.adoc#disk_reservation_percent[`disk_reservation_percent`]" + "xref:reference:properties/cluster-properties.adoc#disk_reservation_percent[`disk_reservation_percent`]" ], - "description": "Maximum size of the cache as a percentage, minus the space that Redpanda avoids using defined by the xref:reference:cluster-properties.adoc#disk_reservation_percent[`disk_reservation_percent`] cluster property. This is calculated at startup and dynamically updated if either this property, `disk_reservation_percent`, or <> changes.\n\nThis property works together with <> to define cache behavior:\n\n- When both properties are set, Redpanda uses the smaller calculated value of the two, in bytes.\n\n- If one of these properties is set to `0`, Redpanda uses the non-zero value.\n\n- These properties cannot both be `0`.\n\n- `cloud_storage_cache_size` cannot be `0` while `cloud_storage_cache_size_percent` is `null`.", + "description": "Maximum size of the cache as a percentage, minus the space that Redpanda avoids using defined by the xref:reference:properties/cluster-properties.adoc#disk_reservation_percent[`disk_reservation_percent`] cluster property. This is calculated at startup and dynamically updated if either this property, `disk_reservation_percent`, or <> changes.\n\nThis property works together with <> to define cache behavior:\n\n- When both properties are set, Redpanda uses the smaller calculated value of the two, in bytes.\n\n- If one of these properties is set to `0`, Redpanda uses the non-zero value.\n\n- These properties cannot both be `0`.\n\n- `cloud_storage_cache_size` cannot be `0` while `cloud_storage_cache_size_percent` is `null`.", "config_scope": "cluster" }, "cloud_storage_cache_trim_threshold_percent_objects": { @@ -306,7 +306,7 @@ "cloud_storage_enable_segment_uploads": { "description": "Controls the upload of log segments to Tiered Storage. If set to `false`, this property temporarily pauses all log segment uploads from the Redpanda cluster. When the uploads are paused, the <> cluster configuration and `redpanda.remote.allowgaps` topic properties control local retention behavior.", "related_topics": [ - "xref:properties/topic-properties.adoc#redpanda-remote-allowgaps[`redpanda.remote.allowgaps`]" + "xref:reference:properties/topic-properties.adoc#redpanda-remote-allowgaps[`redpanda.remote.allowgaps`]" ] }, "cloud_storage_enabled": { @@ -608,7 +608,6 @@ "compaction.strategy": { "description": "Specifies the strategy used to determine which records to remove during log compaction. The compaction strategy controls how Redpanda identifies and removes duplicate records while preserving the latest value for each key.", "related_topics": [ - "xref:reference:properties/cluster-properties.adoc#compaction_strategy[`compaction_strategy`]" ], "config_scope": "topic" }, @@ -617,7 +616,7 @@ "config_scope": "cluster" }, "compression.type": { - "description": "Redpanda ignores this property and always uses producer compression semantics. If producers send compressed data, Redpanda stores and serves it as-is. If producers send uncompressed data, Redpanda stores it uncompressed.\n\nThis property exists for Apache Kafka compatibility. Configure compression in your producers instead of using this topic property.\n\nCompression reduces message size and improves throughput, but increases CPU utilization. Enable producer batching to increase compression efficiency.\n\nWhen set, this property overrides the cluster property xref:./cluster-properties.adoc#log_compression_type[`log_compression_type`] for the topic.", + "description": "Redpanda ignores this property and always uses producer compression semantics. If producers send compressed data, Redpanda stores and serves it as-is. If producers send uncompressed data, Redpanda stores it uncompressed.\n\nThis property exists for Apache Kafka compatibility. Configure compression in your producers instead of using this topic property.\n\nCompression reduces message size and improves throughput, but increases CPU utilization. Enable producer batching to increase compression efficiency.\n\nWhen set, this property overrides the cluster property xref:reference:properties/cluster-properties.adoc#log_compression_type[`log_compression_type`] for the topic.", "related_topics": [ "xref:reference:properties/cluster-properties.adoc#log_compression_type[`log_compression_type`]", "xref:develop:produce-data/configure-producers.adoc#message-batching[Message batching]", @@ -900,14 +899,12 @@ "flush.bytes": { "description": "The maximum bytes not fsynced per partition. If this configured threshold is reached, the log is automatically fsynced, even though it wasn't explicitly requested.", "related_topics": [ - "xref:reference:properties/cluster-properties.adoc#flush_bytes[`flush_bytes`]" ], "config_scope": "topic" }, "flush.ms": { "description": "The maximum delay (in ms) between two subsequent fsyncs. After this delay, the log is automatically fsynced.", "related_topics": [ - "xref:reference:properties/cluster-properties.adoc#flush_ms[`flush_ms`]" ], "config_scope": "topic" }, @@ -963,7 +960,6 @@ "iceberg_enabled": { "description": "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.", "related_topics": [ - "self-managed-only: xref:reference:properties/topic-properties.adoc#redpanda-iceberg-enabled[`redpanda.iceberg.enabled`]" ], "config_scope": "cluster" }, @@ -1088,7 +1084,7 @@ "initial.retention.local.target.bytes": { "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:\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).", "related_topics": [ - "xref:reference:properties/cluster-properties.adoc#initial_retention_local_target_bytes[`initial_retention_local_target_bytes`]", + "xref:reference:properties/cluster-properties.adoc#initial_retention_local_target_bytes_default[`initial_retention_local_target_bytes`]", "xref:manage:tiered-storage.adoc#fast-commission-and-decommission[Fast commission and decommission through Tiered Storage]" ], "config_scope": "topic" @@ -1096,7 +1092,7 @@ "initial.retention.local.target.ms": { "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:\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).", "related_topics": [ - "xref:reference:properties/cluster-properties.adoc#initial_retention_local_target_ms[`initial_retention_local_target_ms`]", + "xref:reference:properties/cluster-properties.adoc#initial_retention_local_target_ms_default[`initial_retention_local_target_ms`]", "xref:manage:tiered-storage.adoc#fast-commission-and-decommission[Fast commission and decommission through Tiered Storage]" ], "config_scope": "topic" @@ -1248,7 +1244,7 @@ "related_topics": [ "xref:reference:properties/topic-properties.adoc#max-message-bytes[`max.message.bytes`]" ], - "description": "The maximum value you can set for the xref:./topic-properties.adoc#max-message-bytes[`max.message.bytes`] topic property. When set to `null`, no limit is enforced.", + "description": "The maximum value you can set for the xref:reference:properties/topic-properties.adoc#max-message-bytes[`max.message.bytes`] topic property. When set to `null`, no limit is enforced.", "config_scope": "cluster" }, "kafka_nodelete_topics": { @@ -1295,8 +1291,8 @@ }, "kafka_throughput_replenish_threshold": { "related_topics": [ - "xref:reference:cluster-properties.adoc#kafka_throughput_limit_node_in_bps[`kafka_throughput_limit_node_in_bps`]", - "xref:reference:cluster-properties.adoc#kafka_throughput_limit_node_out_bps[`kafka_throughput_limit_node_out_bps`]", + "xref:reference:properties/cluster-properties.adoc#kafka_throughput_limit_node_in_bps[`kafka_throughput_limit_node_in_bps`]", + "xref:reference:properties/cluster-properties.adoc#kafka_throughput_limit_node_out_bps[`kafka_throughput_limit_node_out_bps`]", "xref:manage:cluster-maintenance/manage-throughput.adoc[Manage Throughput]" ], "config_scope": "cluster", @@ -1324,7 +1320,7 @@ "config_scope": "cluster" }, "log_cleanup_policy": { - "description": "Default cleanup policy for topic logs.\n\nThe topic property xref:./topic-properties.adoc#cleanup-policy[`cleanup.policy`] overrides the value of `log_cleanup_policy` at the topic level.", + "description": "Default cleanup policy for topic logs.\n\nThe topic property xref:reference:properties/topic-properties.adoc#cleanup-policy[`cleanup.policy`] overrides the value of `log_cleanup_policy` at the topic level.", "related_topics": [ "xref:reference:properties/topic-properties.adoc#cleanup-policy[`cleanup.policy`]" ], @@ -1348,7 +1344,7 @@ "config_scope": "cluster" }, "log_compression_type": { - "description": "IMPORTANT: This property is ignored regardless of the value specified. The behavior is always the same as the `producer` value. Redpanda brokers do not compress or recompress data based on this property. If producers send compressed data, Redpanda stores it as-is; if producers send uncompressed data, Redpanda stores it uncompressed. Other listed values are accepted for Apache Kafka compatibility but are ignored by the broker. This property may appear in Admin API and `rpk topic describe` outputs for compatibility.\n\nDefault for the Kafka-compatible compression.type property. Redpanda does not recompress data.\n\nThe topic property xref:./topic-properties.adoc#compression-type[`compression.type`] overrides the value of `log_compression_type` at the topic level.", + "description": "IMPORTANT: This property is ignored regardless of the value specified. The behavior is always the same as the `producer` value. Redpanda brokers do not compress or recompress data based on this property. If producers send compressed data, Redpanda stores it as-is; if producers send uncompressed data, Redpanda stores it uncompressed. Other listed values are accepted for Apache Kafka compatibility but are ignored by the broker. This property may appear in Admin API and `rpk topic describe` outputs for compatibility.\n\nDefault for the Kafka-compatible compression.type property. Redpanda does not recompress data.\n\nThe topic property xref:reference:properties/topic-properties.adoc#compression-type[`compression.type`] overrides the value of `log_compression_type` at the topic level.", "related_topics": [ "xref:reference:properties/topic-properties.adoc#compression-type[`compression.type`]" ], @@ -1358,16 +1354,16 @@ "related_topics": [ "xref:reference:properties/topic-properties.adoc#message-timestamp-after-max-ms[`message.timestamp.after.max.ms`]" ], - "description": "The maximum allowed time difference when a record's timestamp is in the future compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the future. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#message-timestamp-after-max-ms[`message.timestamp.after.max.ms`] overrides this cluster-level setting." + "description": "The maximum allowed time difference when a record's timestamp is in the future compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the future. This property has no effect on topics using <> timestamps. The topic property xref:reference:properties/topic-properties.adoc#message-timestamp-after-max-ms[`message.timestamp.after.max.ms`] overrides this cluster-level setting." }, "log_message_timestamp_before_max_ms": { "related_topics": [ "xref:reference:properties/topic-properties.adoc#message-timestamp-before-max-ms[`message.timestamp.before.max.ms`]" ], - "description": "The maximum allowed time difference when a record's timestamp is in the past compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the past. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#message-timestamp-before-max-ms[`message.timestamp.before.max.ms`] overrides this cluster-level setting." + "description": "The maximum allowed time difference when a record's timestamp is in the past compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the past. This property has no effect on topics using <> timestamps. The topic property xref:reference:properties/topic-properties.adoc#message-timestamp-before-max-ms[`message.timestamp.before.max.ms`] overrides this cluster-level setting." }, "log_message_timestamp_type": { - "description": "Default timestamp type for topic messages (CreateTime or LogAppendTime).\n\nThe topic property xref:./topic-properties.adoc#message-timestamp-type[`message.timestamp.type`] overrides the value of `log_message_timestamp_type` at the topic level.", + "description": "Default timestamp type for topic messages (CreateTime or LogAppendTime).\n\nThe topic property xref:reference:properties/topic-properties.adoc#message-timestamp-type[`message.timestamp.type`] overrides the value of `log_message_timestamp_type` at the topic level.", "related_topics": [ "xref:reference:properties/topic-properties.adoc#message-timestamp-type[`message.timestamp.type`]" ], @@ -1400,7 +1396,7 @@ "config_scope": "cluster" }, "max.compaction.lag.ms": { - "description": "The maximum amount of time (in ms) that a log segment can remain unaltered before it is eligible for compaction in a compact topic. Overrides the cluster property xref:cluster-properties.adoc#max_compaction_lag_ms[`max_compaction_lag_ms`] for the topic.", + "description": "The maximum amount of time (in ms) that a log segment can remain unaltered before it is eligible for compaction in a compact topic. Overrides the cluster property xref:reference:properties/cluster-properties.adoc#max_compaction_lag_ms[`max_compaction_lag_ms`] for the topic.", "related_topics": [ "xref:reference:properties/cluster-properties.adoc#max_compaction_lag_ms[`max_compaction_lag_ms`]", "xref:manage:cluster-maintenance/compaction-settings.adoc#configuration-options[Configure maximum compaction lag]" @@ -1408,7 +1404,7 @@ "config_scope": "topic" }, "max.message.bytes": { - "description": "The maximum size of a message or batch of a topic. If a compression type is enabled, `max.message.bytes` sets the maximum size of the compressed message or batch.\n\nIf `max.message.bytes` is set to a positive value, it overrides the cluster property xref:./cluster-properties.adoc#kafka_batch_max_bytes[`kafka_batch_max_bytes`] for the topic.\n\nSet an upper limit for `max.message.bytes` using the cluster property config_ref:kafka_max_message_size_upper_limit_bytes,true,properties/cluster-properties[`kafka_max_message_size_upper_limit_bytes`].", + "description": "The maximum size of a message or batch of a topic. If a compression type is enabled, `max.message.bytes` sets the maximum size of the compressed message or batch.\n\nIf `max.message.bytes` is set to a positive value, it overrides the cluster property xref:reference:properties/cluster-properties.adoc#kafka_batch_max_bytes[`kafka_batch_max_bytes`] for the topic.\n\nSet an upper limit for `max.message.bytes` using the cluster property config_ref:kafka_max_message_size_upper_limit_bytes,true,properties/cluster-properties[`kafka_max_message_size_upper_limit_bytes`].", "related_topics": [ "xref:reference:properties/cluster-properties.adoc#kafka_batch_max_bytes[`kafka_batch_max_bytes`]", "xref:develop:produce-data/configure-producers.adoc#message-batching[Message batching]", @@ -1460,7 +1456,7 @@ ] }, "message.timestamp.type": { - "description": "The source of a message's timestamp: either the message's creation time or its log append time.\n\nWhen `message.timestamp.type` is set, it overrides the cluster property xref:./cluster-properties.adoc#log_message_timestamp_type[`log_message_timestamp_type`] for the topic.", + "description": "The source of a message's timestamp: either the message's creation time or its log append time.\n\nWhen `message.timestamp.type` is set, it overrides the cluster property xref:reference:properties/cluster-properties.adoc#log_message_timestamp_type[`log_message_timestamp_type`] for the topic.", "related_topics": [ "xref:reference:properties/cluster-properties.adoc#log_message_timestamp_type[`log_message_timestamp_type`]" ], @@ -1478,9 +1474,9 @@ "config_scope": "topic" }, "min.compaction.lag.ms": { - "description": "The minimum amount of time (in ms) that a log segment must remain unaltered before it can be compacted in a compact topic. Overrides the cluster property xref:cluster-properties.adoc#min_compaction_lag_ms[`min_compaction_lag_ms`] for the topic.", + "description": "The minimum amount of time (in ms) that a log segment must remain unaltered before it can be compacted in a compact topic. Overrides the cluster property xref:reference:properties/cluster-properties.adoc#min_compaction_lag_ms[`min_compaction_lag_ms`] for the topic.", "related_topics": [ - "xref:cluster-properties.adoc#min_compaction_lag_ms[`min_compaction_lag_ms`]", + "xref:reference:properties/cluster-properties.adoc#min_compaction_lag_ms[`min_compaction_lag_ms`]", "xref:reference:properties/cluster-properties.adoc#min_compaction_lag_ms[`min_compaction_lag_ms`]", "xref:manage:cluster-maintenance/compaction-settings.adoc#configure-min-compaction-lag[Configure minimum compaction lag]" ], @@ -1678,7 +1674,7 @@ ], "config_scope": "broker", "category": "redpanda", - "description": "A label that identifies a failure zone. Apply the same label to all brokers in the same failure zone. When xref:./cluster-properties.adoc#enable_rack_awareness[enable_rack_awareness] is set to `true` at the cluster level, the system uses the rack labels to spread partition replicas across different failure zones." + "description": "A label that identifies a failure zone. Apply the same label to all brokers in the same failure zone. When xref:reference:properties/cluster-properties.adoc#enable_rack_awareness[enable_rack_awareness] is set to `true` at the cluster level, the system uses the rack labels to spread partition replicas across different failure zones." }, "raft_max_buffered_follower_append_entries_bytes_per_shard": { "description": "The total size of append entry requests that may be cached per shard, using the Raft-buffered protocol. When an entry is cached, the leader can continue serving requests because the ordering of the cached requests cannot change. When the total size of cached requests reaches the set limit, back pressure is applied to throttle producers.", @@ -1855,7 +1851,7 @@ "config_scope": "topic" }, "replication.factor": { - "description": "The number of replicas of a topic to save in different nodes (brokers) of a cluster.\n\nIf `replication.factor` is set to a positive value, it overrides the cluster property xref:./cluster-properties.adoc#default_topic_replication[default_topic_replication] for the topic.\n\nNOTE: Although `replication.factor` isn't returned or displayed by xref:reference:rpk/rpk-topic/rpk-topic-describe.adoc[`rpk topic describe`] as a valid Kafka property, you can set it using xref:reference:rpk/rpk-topic/rpk-topic-alter-config.adoc[`rpk topic alter-config`]. When the `replication.factor` of a topic is altered, it isn't simply a property value that's updated, but rather the actual replica sets of topic partitions that are changed.", + "description": "The number of replicas of a topic to save in different nodes (brokers) of a cluster.\n\nIf `replication.factor` is set to a positive value, it overrides the cluster property xref:reference:properties/cluster-properties.adoc#default_topic_replication[default_topic_replication] for the topic.\n\nNOTE: Although `replication.factor` isn't returned or displayed by xref:reference:rpk/rpk-topic/rpk-topic-describe.adoc[`rpk topic describe`] as a valid Kafka property, you can set it using xref:reference:rpk/rpk-topic/rpk-topic-alter-config.adoc[`rpk topic alter-config`]. When the `replication.factor` of a topic is altered, it isn't simply a property value that's updated, but rather the actual replica sets of topic partitions that are changed.", "related_topics": [ "xref:reference:rpk/rpk-topic/rpk-topic-describe.adoc[`rpk topic describe`]", "xref:reference:rpk/rpk-topic/rpk-topic-alter-config.adoc[`rpk topic alter-config`]", @@ -1867,7 +1863,7 @@ "config_scope": "topic" }, "retention.bytes": { - "description": "A size-based retention limit that configures the maximum size that a topic partition can grow before becoming eligible for cleanup.\n\nIf `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.\n\nWhen both size-based (`retention.bytes`) and time-based (`retention.ms`) retention limits are set, cleanup occurs when either limit is reached.\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: Disables size-based retention for this topic.", + "description": "A size-based retention limit that configures the maximum size that a topic partition can grow before becoming eligible for cleanup.\n\nIf `retention.bytes` is set to a positive value, it overrides the cluster property xref:reference:properties/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.\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: Disables size-based retention for this topic.", "related_topics": [ "xref:reference:properties/cluster-properties.adoc#retention_bytes[`retention_bytes`]", "xref:manage:cluster-maintenance/disk-utilization.adoc#configure-message-retention[Configure message retention]" @@ -1877,7 +1873,7 @@ "retention.local.target.bytes": { "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 <> without Tiered Storage.\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: Disables size-based local retention override for this topic.", "related_topics": [ - "xref:reference:properties/cluster-properties.adoc#retention_local_target_bytes[`retention_local_target_bytes`]", + "xref:reference:properties/cluster-properties.adoc#retention_local_target_bytes_default[`retention_local_target_bytes`]", "xref:manage:tiered-storage.adoc[Tiered Storage]" ], "config_scope": "topic" @@ -1885,14 +1881,14 @@ "retention.local.target.ms": { "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. It applies per partition and is equivalent to <> without Tiered Storage.\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: Disables time-based local retention override for this topic.", "related_topics": [ - "xref:reference:properties/cluster-properties.adoc#retention_local_target_ms[`retention_local_target_ms`]", + "xref:reference:properties/cluster-properties.adoc#retention_local_target_ms_default[`retention_local_target_ms`]", "xref:manage:tiered-storage.adoc[Tiered Storage]", "xref:manage:remote-read-replicas.adoc[Remote Read Replicas]" ], "config_scope": "topic" }, "retention.ms": { - "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\nIf `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.\n\nWhen both size-based (`retention.bytes`) and time-based (`retention.ms`) retention limits are set, the earliest occurring limit applies.\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: Disables time-based retention for this topic.", + "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\nIf `retention.ms` is set to a positive value, it overrides the cluster property xref:reference:properties/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.\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: Disables time-based retention for this topic.", "related_topics": [ "xref:reference:properties/cluster-properties.adoc#log_retention_ms[`log_retention_ms`]", "xref:manage:cluster-maintenance/disk-utilization.adoc#configure-message-retention[Configure message retention]" @@ -2046,9 +2042,9 @@ "version": "v26.1.1" }, "schema_registry_replication_factor": { - "description": "Replication factor for internal `_schemas` topic. If unset, defaults to the xref:../cluster-properties.adoc#default_topic_replication[`default_topic_replication`] cluster property.", + "description": "Replication factor for internal `_schemas` topic. If unset, defaults to the xref:reference:properties/cluster-properties.adoc#default_topic_replication[`default_topic_replication`] cluster property.", "related_topics": [ - "xref:../cluster-properties.adoc#default_topic_replication[`default_topic_replication`]" + "xref:reference:properties/cluster-properties.adoc#default_topic_replication[`default_topic_replication`]" ], "config_scope": "broker", "category": "schema-registry", @@ -2118,7 +2114,7 @@ "category": "redpanda" }, "segment.bytes": { - "description": "The maximum size of an active log segment for a topic. When the size of an active segment exceeds `segment.bytes`, the segment is closed and a new active segment is created. The closed, inactive segment is then eligible to be cleaned up according to retention properties.\n\nWhen `segment.bytes` is set to a positive value, it overrides the cluster property:\n\n* xref:./cluster-properties.adoc#log_segment_size[`log_segment_size`] for non-compacted topics\n* xref:./cluster-properties.adoc#compacted_log_segment_size[`compacted_log_segment_size`] for compacted topics (when `cleanup.policy=compact`)", + "description": "The maximum size of an active log segment for a topic. When the size of an active segment exceeds `segment.bytes`, the segment is closed and a new active segment is created. The closed, inactive segment is then eligible to be cleaned up according to retention properties.\n\nWhen `segment.bytes` is set to a positive value, it overrides the cluster property:\n\n* xref:reference:properties/cluster-properties.adoc#log_segment_size[`log_segment_size`] for non-compacted topics\n* xref:reference:properties/cluster-properties.adoc#compacted_log_segment_size[`compacted_log_segment_size`] for compacted topics (when `cleanup.policy=compact`)", "related_topics": [ "xref:reference:properties/cluster-properties.adoc#log_segment_size[`log_segment_size`]", "xref:manage:cluster-maintenance/disk-utilization.adoc#configure-segment-size[Configure segment size]", @@ -2129,7 +2125,7 @@ "config_scope": "topic" }, "segment.ms": { - "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\nIf 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`.\n\nFor topics with compaction enabled, `max.compaction.lag.ms` also acts as a limit to `segment.ms`.\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: Disables time-based segment rolling for this topic.", + "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\nIf set to a positive duration, `segment.ms` overrides the cluster property xref:reference:properties/cluster-properties.adoc#log_segment_ms[`log_segment_ms`]. Values are automatically clamped between the cluster bounds set by xref:reference:properties/cluster-properties.adoc#log_segment_ms_min[`log_segment_ms_min`] (default: 10 minutes) and xref:reference:properties/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`.\n\nFor topics with compaction enabled, `max.compaction.lag.ms` also acts as a limit to `segment.ms`.\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: Disables time-based segment rolling for this topic.", "related_topics": [ "xref:reference:properties/cluster-properties.adoc#log_segment_ms[`log_segment_ms`]", "xref:reference:properties/cluster-properties.adoc#log_segment_ms_min[`log_segment_ms_min`]", @@ -2264,12 +2260,12 @@ ] }, "write.caching": { - "description": "The write caching mode to apply to a topic.\n\nWhen `write.caching` is set, it overrides the cluster property xref:cluster-properties.adoc#write_caching_default[`write_caching_default`]. Write caching acknowledges a message as soon as it is received and acknowledged on a majority of brokers, without waiting for it to be written to disk. With `acks=all`, this provides lower latency while still ensuring that a majority of brokers acknowledge the write. Fsyncs follow <> and <>, whichever is reached first.", + "description": "The write caching mode to apply to a topic.\n\nWhen `write.caching` is set, it overrides the cluster property xref:reference:properties/cluster-properties.adoc#write_caching_default[`write_caching_default`]. Write caching acknowledges a message as soon as it is received and acknowledged on a majority of brokers, without waiting for it to be written to disk. With `acks=all`, this provides lower latency while still ensuring that a majority of brokers acknowledge the write. Fsyncs follow <> and <>, whichever is reached first.", "related_topics": [ "xref:develop:manage-topics/config-topics.adoc#configure-write-caching[Write caching]", "xref:manage:tiered-storage.adoc[Tiered Storage]", "xref:reference:properties/cluster-properties.adoc#write_caching_default[`write_caching_default`]", - "xref:cluster-properties.adoc#write_caching_default[`write_caching_default`]" + "xref:reference:properties/cluster-properties.adoc#write_caching_default[`write_caching_default`]" ], "config_scope": "topic" }, diff --git a/modules/develop/pages/transactions.adoc b/modules/develop/pages/transactions.adoc index 8c63976ec3..246becf6c0 100644 --- a/modules/develop/pages/transactions.adoc +++ b/modules/develop/pages/transactions.adoc @@ -323,7 +323,7 @@ Different transactions require different approaches to handling failures within Transactions are supported on topics with compaction configured. The compaction process removes aborted transaction data from the log. The resulting compacted segment contains only committed data batches (and potentially harmless gaps in the offsets due to skipped batches). ifndef::env-cloud[] -At a cluster-level, compaction is set when xref:reference:cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`] or xref:reference:topic-properties.adoc#cleanup-policy[`cleanup.policy`] are set to either `compact` or `compact,delete`. +At a cluster-level, compaction is set when xref:reference:cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`] or xref:reference:properties/topic-properties.adoc#cleanup-policy[`cleanup.policy`] are set to either `compact` or `compact,delete`. Optionally, you can enable removal of transactional control batches (commit and abort markers) during compaction by setting xref:reference:properties/cluster-properties.adoc#log_compaction_tx_batch_removal_enabled[`log_compaction_tx_batch_removal_enabled`] to `true`. When enabled, the topic's xref:reference:properties/topic-properties.adoc#delete-retention-ms[`delete.retention.ms`] setting is applied to these markers. For topics with a `compact` only cleanup policy, you must explicitly set `delete.retention.ms` at the topic level. This feature is not applied when Tiered Storage is enabled. See xref:manage:cluster-maintenance/compaction-settings.adoc#transactional-control-batch-removal[Transactional control batch removal]. diff --git a/modules/manage/pages/kubernetes/k-manage-topics.adoc b/modules/manage/pages/kubernetes/k-manage-topics.adoc index 4e4e18bc06..a8297e1def 100644 --- a/modules/manage/pages/kubernetes/k-manage-topics.adoc +++ b/modules/manage/pages/kubernetes/k-manage-topics.adoc @@ -326,7 +326,7 @@ With `write_caching` enabled at the cluster level, Redpanda fsyncs to disk accor === Configure at topic level -To override the cluster-level setting at the topic level, set the topic-level property xref:reference:topic-properties.adoc#write-caching[`write.caching`]: +To override the cluster-level setting at the topic level, set the topic-level property xref:reference:properties/topic-properties.adoc#write-caching[`write.caching`]: .`example-topic.yaml` [,yaml,indent=0] @@ -334,7 +334,7 @@ To override the cluster-level setting at the topic level, set the topic-level pr include::manage:example$kubernetes/topic-crds.feature[tags=write-caching-topic-example,indent=0] ---- -With `write.caching` enabled at the topic level, Redpanda fsyncs to disk according to xref:reference:topic-properties.adoc#flush-ms[`flush.ms`] and xref:reference:topic-properties.adoc#flush-bytes[`flush.bytes`], whichever is reached first. +With `write.caching` enabled at the topic level, Redpanda fsyncs to disk according to xref:reference:properties/topic-properties.adoc#flush-ms[`flush.ms`] and xref:reference:properties/topic-properties.adoc#flush-bytes[`flush.bytes`], whichever is reached first. == Verify a topic diff --git a/modules/manage/partials/tiered-storage.adoc b/modules/manage/partials/tiered-storage.adoc index 775dd96f9f..bf940b4326 100644 --- a/modules/manage/partials/tiered-storage.adoc +++ b/modules/manage/partials/tiered-storage.adoc @@ -1015,7 +1015,7 @@ See also: xref:manage:cluster-maintenance/disk-utilization.adoc#configure-messag ==== Compacted topics in Tiered Storage -When you set xref:reference:topic-properties.adoc#cleanup-policy[`cleanup.policy`] for a topic to `compact`, nothing gets deleted from object storage based on retention settings. When set to `compact,delete`, compacted segments are deleted from object storage based on `retention.ms` and `retention.bytes`. +When you set xref:reference:properties/topic-properties.adoc#cleanup-policy[`cleanup.policy`] for a topic to `compact`, nothing gets deleted from object storage based on retention settings. When set to `compact,delete`, compacted segments are deleted from object storage based on `retention.ms` and `retention.bytes`. For compacted topics, Redpanda compacts segments after they have been uploaded to object storage. Redpanda initially uploads all uncompacted segments. It then re-uploads the segments with compaction applied. It's likely that some segments in object storage are not compacted, but the Tiered Storage read path can manage this. diff --git a/modules/reference/attachments/redpanda-properties-v26.1.9.json b/modules/reference/attachments/redpanda-properties-v26.1.9.json index 8356577193..be57c66827 100644 --- a/modules/reference/attachments/redpanda-properties-v26.1.9.json +++ b/modules/reference/attachments/redpanda-properties-v26.1.9.json @@ -921,7 +921,7 @@ "corresponding_cluster_property": "log_cleanup_policy", "default": "delete", "defined_in": "src/v/kafka/protocol/topic_properties.h", - "description": "The cleanup policy to apply for log segments of a topic.\nWhen `cleanup.policy` is set, it overrides the cluster property xref:cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`] for the topic.\n\n**Values**:\n\n- `delete` - Deletes data according to size-based or time-based retention limits, or both.\n- `compact` - Deletes data according to a key-based retention policy, discarding all but the latest value for each key.\n- `compact,delete` - The latest values are kept for each key, while the remaining data is deleted according to retention limits.", + "description": "The cleanup policy to apply for log segments of a topic.\nWhen `cleanup.policy` is set, it overrides the cluster property xref:reference:properties/cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`] for the topic.\n\n**Values**:\n\n- `delete` - Deletes data according to size-based or time-based retention limits, or both.\n- `compact` - Deletes data according to a key-based retention policy, discarding all but the latest value for each key.\n- `compact,delete` - The latest values are kept for each key, while the remaining data is deleted according to retention limits.", "enum": [ "none", "delete", @@ -933,7 +933,7 @@ "name": "cleanup.policy", "needs_restart": false, "related_topics": [ - "xref:cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`]", + "xref:reference:properties/cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`]", "xref:manage:cluster-maintenance/disk-utilization.adoc#configure-segment-size[Configure segment size]", "xref:manage:tiered-storage.adoc#compacted-topics-in-tiered-storage[Compacted topics in Tiered Storage]", "xref:reference:properties/cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`]" @@ -1330,7 +1330,7 @@ "config_scope": "broker", "default": null, "defined_in": "src/v/config/node_config.cc", - "description": "Directory for archival cache. Set when the xref:reference:properties/cluster-properties.adoc#cloud_storage_enabled[`cloud_storage_enabled`] cluster property is enabled. If not specified, Redpanda uses a default path within the data directory.", + "description": "Directory for archival cache. Set when the xref:reference:properties/object-storage-properties.adoc#cloud_storage_enabled[`cloud_storage_enabled`] cluster property is enabled. If not specified, Redpanda uses a default path within the data directory.", "example": "[,yaml]\n----\nredpanda:\n cloud_storage_cache_directory: \n----\n\n\nReplace `` with the full path to your desired cache directory.", "is_deprecated": false, "is_enterprise": false, @@ -1338,7 +1338,7 @@ "needs_restart": true, "nullable": true, "related_topics": [ - "xref:reference:properties/cluster-properties.adoc#cloud_storage_enabled[`cloud_storage_enabled`]" + "xref:reference:properties/object-storage-properties.adoc#cloud_storage_enabled[`cloud_storage_enabled`]" ], "type": "string", "visibility": "user" @@ -1413,7 +1413,7 @@ "config_scope": "cluster", "default": 20.0, "defined_in": "src/v/config/configuration.cc", - "description": "Maximum size of the cache as a percentage, minus the space that Redpanda avoids using defined by the xref:reference:cluster-properties.adoc#disk_reservation_percent[`disk_reservation_percent`] cluster property. This is calculated at startup and dynamically updated if either this property, `disk_reservation_percent`, or <> changes.\n\nThis property works together with <> to define cache behavior:\n\n- When both properties are set, Redpanda uses the smaller calculated value of the two, in bytes.\n\n- If one of these properties is set to `0`, Redpanda uses the non-zero value.\n\n- These properties cannot both be `0`.\n\n- `cloud_storage_cache_size` cannot be `0` while `cloud_storage_cache_size_percent` is `null`.", + "description": "Maximum size of the cache as a percentage, minus the space that Redpanda avoids using defined by the xref:reference:properties/cluster-properties.adoc#disk_reservation_percent[`disk_reservation_percent`] cluster property. This is calculated at startup and dynamically updated if either this property, `disk_reservation_percent`, or <> changes.\n\nThis property works together with <> to define cache behavior:\n\n- When both properties are set, Redpanda uses the smaller calculated value of the two, in bytes.\n\n- If one of these properties is set to `0`, Redpanda uses the non-zero value.\n\n- These properties cannot both be `0`.\n\n- `cloud_storage_cache_size` cannot be `0` while `cloud_storage_cache_size_percent` is `null`.", "example": "`20.0`", "is_deprecated": false, "is_enterprise": false, @@ -1421,7 +1421,7 @@ "needs_restart": false, "nullable": true, "related_topics": [ - "xref:reference:cluster-properties.adoc#disk_reservation_percent[`disk_reservation_percent`]" + "xref:reference:properties/cluster-properties.adoc#disk_reservation_percent[`disk_reservation_percent`]" ], "type": "number", "visibility": "user" @@ -2007,7 +2007,7 @@ "needs_restart": false, "nullable": false, "related_topics": [ - "xref:properties/topic-properties.adoc#redpanda-remote-allowgaps[`redpanda.remote.allowgaps`]" + "xref:reference:properties/topic-properties.adoc#redpanda-remote-allowgaps[`redpanda.remote.allowgaps`]" ], "type": "boolean", "visibility": "tunable" @@ -4085,9 +4085,7 @@ "is_topic_property": true, "name": "compaction.strategy", "needs_restart": false, - "related_topics": [ - "xref:reference:properties/cluster-properties.adoc#compaction_strategy[`compaction_strategy`]" - ], + "related_topics": [], "type": "string" }, "compaction_ctrl_backlog_size": { @@ -4237,7 +4235,7 @@ "corresponding_cluster_property": "log_compression_type", "default": "producer", "defined_in": "src/v/kafka/protocol/topic_properties.h", - "description": "Redpanda ignores this property and always uses producer compression semantics. If producers send compressed data, Redpanda stores and serves it as-is. If producers send uncompressed data, Redpanda stores it uncompressed.\n\nThis property exists for Apache Kafka compatibility. Configure compression in your producers instead of using this topic property.\n\nCompression reduces message size and improves throughput, but increases CPU utilization. Enable producer batching to increase compression efficiency.\n\nWhen set, this property overrides the cluster property xref:./cluster-properties.adoc#log_compression_type[`log_compression_type`] for the topic.", + "description": "Redpanda ignores this property and always uses producer compression semantics. If producers send compressed data, Redpanda stores and serves it as-is. If producers send uncompressed data, Redpanda stores it uncompressed.\n\nThis property exists for Apache Kafka compatibility. Configure compression in your producers instead of using this topic property.\n\nCompression reduces message size and improves throughput, but increases CPU utilization. Enable producer batching to increase compression efficiency.\n\nWhen set, this property overrides the cluster property xref:reference:properties/cluster-properties.adoc#log_compression_type[`log_compression_type`] for the topic.", "enum": [ "none", "gzip", @@ -6444,9 +6442,7 @@ "is_topic_property": true, "name": "flush.bytes", "needs_restart": false, - "related_topics": [ - "xref:reference:properties/cluster-properties.adoc#flush_bytes[`flush_bytes`]" - ], + "related_topics": [], "type": "integer" }, "flush.ms": { @@ -6470,9 +6466,7 @@ "is_topic_property": true, "name": "flush.ms", "needs_restart": false, - "related_topics": [ - "xref:reference:properties/cluster-properties.adoc#flush_ms[`flush_ms`]" - ], + "related_topics": [], "type": "integer" }, "group_initial_rebalance_delay": { @@ -6949,9 +6943,7 @@ "name": "iceberg_enabled", "needs_restart": true, "nullable": false, - "related_topics": [ - "self-managed-only: xref:reference:properties/topic-properties.adoc#redpanda-iceberg-enabled[`redpanda.iceberg.enabled`]" - ], + "related_topics": [], "type": "boolean", "visibility": "user" }, @@ -7584,7 +7576,7 @@ "name": "initial.retention.local.target.bytes", "needs_restart": false, "related_topics": [ - "xref:reference:properties/cluster-properties.adoc#initial_retention_local_target_bytes[`initial_retention_local_target_bytes`]", + "xref:reference:properties/cluster-properties.adoc#initial_retention_local_target_bytes_default[`initial_retention_local_target_bytes`]", "xref:manage:tiered-storage.adoc#fast-commission-and-decommission[Fast commission and decommission through Tiered Storage]" ], "type": "integer" @@ -7610,7 +7602,7 @@ "name": "initial.retention.local.target.ms", "needs_restart": false, "related_topics": [ - "xref:reference:properties/cluster-properties.adoc#initial_retention_local_target_ms[`initial_retention_local_target_ms`]", + "xref:reference:properties/cluster-properties.adoc#initial_retention_local_target_ms_default[`initial_retention_local_target_ms`]", "xref:manage:tiered-storage.adoc#fast-commission-and-decommission[Fast commission and decommission through Tiered Storage]" ], "type": "integer" @@ -8042,7 +8034,7 @@ "config_scope": "cluster", "default": 104857600, "defined_in": "src/v/config/configuration.cc", - "description": "The maximum value you can set for the xref:./topic-properties.adoc#max-message-bytes[`max.message.bytes`] topic property. When set to `null`, no limit is enforced.", + "description": "The maximum value you can set for the xref:reference:properties/topic-properties.adoc#max-message-bytes[`max.message.bytes`] topic property. When set to `null`, no limit is enforced.", "is_deprecated": false, "is_enterprise": false, "maximum": 2147483647, @@ -8650,8 +8642,8 @@ "needs_restart": false, "nullable": true, "related_topics": [ - "xref:reference:cluster-properties.adoc#kafka_throughput_limit_node_in_bps[`kafka_throughput_limit_node_in_bps`]", - "xref:reference:cluster-properties.adoc#kafka_throughput_limit_node_out_bps[`kafka_throughput_limit_node_out_bps`]", + "xref:reference:properties/cluster-properties.adoc#kafka_throughput_limit_node_in_bps[`kafka_throughput_limit_node_in_bps`]", + "xref:reference:properties/cluster-properties.adoc#kafka_throughput_limit_node_out_bps[`kafka_throughput_limit_node_out_bps`]", "xref:manage:cluster-maintenance/manage-throughput.adoc[Manage Throughput]" ], "type": "integer", @@ -8885,7 +8877,7 @@ "config_scope": "cluster", "default": "delete", "defined_in": "src/v/config/configuration.cc", - "description": "Default cleanup policy for topic logs.\n\nThe topic property xref:./topic-properties.adoc#cleanup-policy[`cleanup.policy`] overrides the value of `log_cleanup_policy` at the topic level.", + "description": "Default cleanup policy for topic logs.\n\nThe topic property xref:reference:properties/topic-properties.adoc#cleanup-policy[`cleanup.policy`] overrides the value of `log_cleanup_policy` at the topic level.", "enum": [ "none", "delete", @@ -9064,7 +9056,7 @@ "config_scope": "cluster", "default": "producer", "defined_in": "src/v/config/configuration.cc", - "description": "IMPORTANT: This property is ignored regardless of the value specified. The behavior is always the same as the `producer` value. Redpanda brokers do not compress or recompress data based on this property. If producers send compressed data, Redpanda stores it as-is; if producers send uncompressed data, Redpanda stores it uncompressed. Other listed values are accepted for Apache Kafka compatibility but are ignored by the broker. This property may appear in Admin API and `rpk topic describe` outputs for compatibility.\n\nDefault for the Kafka-compatible compression.type property. Redpanda does not recompress data.\n\nThe topic property xref:./topic-properties.adoc#compression-type[`compression.type`] overrides the value of `log_compression_type` at the topic level.", + "description": "IMPORTANT: This property is ignored regardless of the value specified. The behavior is always the same as the `producer` value. Redpanda brokers do not compress or recompress data based on this property. If producers send compressed data, Redpanda stores it as-is; if producers send uncompressed data, Redpanda stores it uncompressed. Other listed values are accepted for Apache Kafka compatibility but are ignored by the broker. This property may appear in Admin API and `rpk topic describe` outputs for compatibility.\n\nDefault for the Kafka-compatible compression.type property. Redpanda does not recompress data.\n\nThe topic property xref:reference:properties/topic-properties.adoc#compression-type[`compression.type`] overrides the value of `log_compression_type` at the topic level.", "enum": [ "none", "gzip", @@ -9114,7 +9106,7 @@ "default": 3600000, "default_human_readable": "1 hour", "defined_in": "src/v/config/configuration.cc", - "description": "The maximum allowed time difference when a record's timestamp is in the future compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the future. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#message-timestamp-after-max-ms[`message.timestamp.after.max.ms`] overrides this cluster-level setting.", + "description": "The maximum allowed time difference when a record's timestamp is in the future compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the future. This property has no effect on topics using <> timestamps. The topic property xref:reference:properties/topic-properties.adoc#message-timestamp-after-max-ms[`message.timestamp.after.max.ms`] overrides this cluster-level setting.", "is_deprecated": false, "is_enterprise": false, "maximum": 17592186044415, @@ -9137,7 +9129,7 @@ "config_scope": "cluster", "default": 9223372036854, "defined_in": "src/v/config/configuration.cc", - "description": "The maximum allowed time difference when a record's timestamp is in the past compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the past. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#message-timestamp-before-max-ms[`message.timestamp.before.max.ms`] overrides this cluster-level setting.", + "description": "The maximum allowed time difference when a record's timestamp is in the past compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the past. This property has no effect on topics using <> timestamps. The topic property xref:reference:properties/topic-properties.adoc#message-timestamp-before-max-ms[`message.timestamp.before.max.ms`] overrides this cluster-level setting.", "is_deprecated": false, "is_enterprise": false, "maximum": 17592186044415, @@ -9160,7 +9152,7 @@ "config_scope": "cluster", "default": "CreateTime", "defined_in": "src/v/config/configuration.cc", - "description": "Default timestamp type for topic messages (CreateTime or LogAppendTime).\n\nThe topic property xref:./topic-properties.adoc#message-timestamp-type[`message.timestamp.type`] overrides the value of `log_message_timestamp_type` at the topic level.", + "description": "Default timestamp type for topic messages (CreateTime or LogAppendTime).\n\nThe topic property xref:reference:properties/topic-properties.adoc#message-timestamp-type[`message.timestamp.type`] overrides the value of `log_message_timestamp_type` at the topic level.", "enum": [ "CreateTime", "LogAppendTime" @@ -9386,7 +9378,7 @@ "corresponding_cluster_property": "max_compaction_lag_ms", "default": 9223372036854, "defined_in": "src/v/kafka/protocol/topic_properties.h", - "description": "The maximum amount of time (in ms) that a log segment can remain unaltered before it is eligible for compaction in a compact topic. Overrides the cluster property xref:cluster-properties.adoc#max_compaction_lag_ms[`max_compaction_lag_ms`] for the topic.", + "description": "The maximum amount of time (in ms) that a log segment can remain unaltered before it is eligible for compaction in a compact topic. Overrides the cluster property xref:reference:properties/cluster-properties.adoc#max_compaction_lag_ms[`max_compaction_lag_ms`] for the topic.", "is_deprecated": false, "is_enterprise": false, "is_topic_property": true, @@ -9412,7 +9404,7 @@ "corresponding_cluster_property": "kafka_batch_max_bytes", "default": 1048576, "defined_in": "src/v/kafka/protocol/topic_properties.h", - "description": "The maximum size of a message or batch of a topic. If a compression type is enabled, `max.message.bytes` sets the maximum size of the compressed message or batch.\n\nIf `max.message.bytes` is set to a positive value, it overrides the cluster property xref:./cluster-properties.adoc#kafka_batch_max_bytes[`kafka_batch_max_bytes`] for the topic.\n\nSet an upper limit for `max.message.bytes` using the cluster property config_ref:kafka_max_message_size_upper_limit_bytes,true,properties/cluster-properties[`kafka_max_message_size_upper_limit_bytes`].", + "description": "The maximum size of a message or batch of a topic. If a compression type is enabled, `max.message.bytes` sets the maximum size of the compressed message or batch.\n\nIf `max.message.bytes` is set to a positive value, it overrides the cluster property xref:reference:properties/cluster-properties.adoc#kafka_batch_max_bytes[`kafka_batch_max_bytes`] for the topic.\n\nSet an upper limit for `max.message.bytes` using the cluster property config_ref:kafka_max_message_size_upper_limit_bytes,true,properties/cluster-properties[`kafka_max_message_size_upper_limit_bytes`].", "is_deprecated": false, "is_enterprise": false, "is_topic_property": true, @@ -9695,7 +9687,7 @@ "corresponding_cluster_property": "log_message_timestamp_type", "default": "CreateTime", "defined_in": "src/v/kafka/protocol/topic_properties.h", - "description": "The source of a message's timestamp: either the message's creation time or its log append time.\n\nWhen `message.timestamp.type` is set, it overrides the cluster property xref:./cluster-properties.adoc#log_message_timestamp_type[`log_message_timestamp_type`] for the topic.", + "description": "The source of a message's timestamp: either the message's creation time or its log append time.\n\nWhen `message.timestamp.type` is set, it overrides the cluster property xref:reference:properties/cluster-properties.adoc#log_message_timestamp_type[`log_message_timestamp_type`] for the topic.", "enum": [ "CreateTime", "LogAppendTime" @@ -9873,14 +9865,14 @@ "default": 0, "default_human_readable": "0 milliseconds", "defined_in": "src/v/kafka/protocol/topic_properties.h", - "description": "The minimum amount of time (in ms) that a log segment must remain unaltered before it can be compacted in a compact topic. Overrides the cluster property xref:cluster-properties.adoc#min_compaction_lag_ms[`min_compaction_lag_ms`] for the topic.", + "description": "The minimum amount of time (in ms) that a log segment must remain unaltered before it can be compacted in a compact topic. Overrides the cluster property xref:reference:properties/cluster-properties.adoc#min_compaction_lag_ms[`min_compaction_lag_ms`] for the topic.", "is_deprecated": false, "is_enterprise": false, "is_topic_property": true, "name": "min.compaction.lag.ms", "needs_restart": false, "related_topics": [ - "xref:cluster-properties.adoc#min_compaction_lag_ms[`min_compaction_lag_ms`]", + "xref:reference:properties/cluster-properties.adoc#min_compaction_lag_ms[`min_compaction_lag_ms`]", "xref:reference:properties/cluster-properties.adoc#min_compaction_lag_ms[`min_compaction_lag_ms`]", "xref:manage:cluster-maintenance/compaction-settings.adoc#configure-min-compaction-lag[Configure minimum compaction lag]" ], @@ -10751,7 +10743,7 @@ "config_scope": "broker", "default": null, "defined_in": "src/v/config/node_config.cc", - "description": "A label that identifies a failure zone. Apply the same label to all brokers in the same failure zone. When xref:./cluster-properties.adoc#enable_rack_awareness[enable_rack_awareness] is set to `true` at the cluster level, the system uses the rack labels to spread partition replicas across different failure zones.", + "description": "A label that identifies a failure zone. Apply the same label to all brokers in the same failure zone. When xref:reference:properties/cluster-properties.adoc#enable_rack_awareness[enable_rack_awareness] is set to `true` at the cluster level, the system uses the rack labels to spread partition replicas across different failure zones.", "is_deprecated": false, "is_enterprise": false, "name": "rack", @@ -11837,7 +11829,7 @@ "corresponding_cluster_property": null, "default": null, "defined_in": "src/v/kafka/protocol/topic_properties.h", - "description": "The number of replicas of a topic to save in different nodes (brokers) of a cluster.\n\nIf `replication.factor` is set to a positive value, it overrides the cluster property xref:./cluster-properties.adoc#default_topic_replication[default_topic_replication] for the topic.\n\nNOTE: Although `replication.factor` isn't returned or displayed by xref:reference:rpk/rpk-topic/rpk-topic-describe.adoc[`rpk topic describe`] as a valid Kafka property, you can set it using xref:reference:rpk/rpk-topic/rpk-topic-alter-config.adoc[`rpk topic alter-config`]. When the `replication.factor` of a topic is altered, it isn't simply a property value that's updated, but rather the actual replica sets of topic partitions that are changed.", + "description": "The number of replicas of a topic to save in different nodes (brokers) of a cluster.\n\nIf `replication.factor` is set to a positive value, it overrides the cluster property xref:reference:properties/cluster-properties.adoc#default_topic_replication[default_topic_replication] for the topic.\n\nNOTE: Although `replication.factor` isn't returned or displayed by xref:reference:rpk/rpk-topic/rpk-topic-describe.adoc[`rpk topic describe`] as a valid Kafka property, you can set it using xref:reference:rpk/rpk-topic/rpk-topic-alter-config.adoc[`rpk topic alter-config`]. When the `replication.factor` of a topic is altered, it isn't simply a property value that's updated, but rather the actual replica sets of topic partitions that are changed.", "is_deprecated": false, "is_enterprise": false, "is_topic_property": true, @@ -11867,7 +11859,7 @@ "corresponding_cluster_property": "retention_bytes", "default": null, "defined_in": "src/v/kafka/protocol/topic_properties.h", - "description": "A size-based retention limit that configures the maximum size that a topic partition can grow before becoming eligible for cleanup.\n\nIf `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.\n\nWhen both size-based (`retention.bytes`) and time-based (`retention.ms`) retention limits are set, cleanup occurs when either limit is reached.\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: Disables size-based retention for this topic.", + "description": "A size-based retention limit that configures the maximum size that a topic partition can grow before becoming eligible for cleanup.\n\nIf `retention.bytes` is set to a positive value, it overrides the cluster property xref:reference:properties/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.\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: Disables size-based retention for this topic.", "is_deprecated": false, "is_enterprise": false, "is_topic_property": true, @@ -11900,7 +11892,7 @@ "name": "retention.local.target.bytes", "needs_restart": false, "related_topics": [ - "xref:reference:properties/cluster-properties.adoc#retention_local_target_bytes[`retention_local_target_bytes`]", + "xref:reference:properties/cluster-properties.adoc#retention_local_target_bytes_default[`retention_local_target_bytes`]", "xref:manage:tiered-storage.adoc[Tiered Storage]" ], "type": "integer" @@ -11927,7 +11919,7 @@ "name": "retention.local.target.ms", "needs_restart": false, "related_topics": [ - "xref:reference:properties/cluster-properties.adoc#retention_local_target_ms[`retention_local_target_ms`]", + "xref:reference:properties/cluster-properties.adoc#retention_local_target_ms_default[`retention_local_target_ms`]", "xref:manage:tiered-storage.adoc[Tiered Storage]", "xref:manage:remote-read-replicas.adoc[Remote Read Replicas]" ], @@ -11948,7 +11940,7 @@ "default": 604800000, "default_human_readable": "1 week", "defined_in": "src/v/kafka/protocol/topic_properties.h", - "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\nIf `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.\n\nWhen both size-based (`retention.bytes`) and time-based (`retention.ms`) retention limits are set, the earliest occurring limit applies.\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: Disables time-based retention for this topic.", + "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\nIf `retention.ms` is set to a positive value, it overrides the cluster property xref:reference:properties/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.\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: Disables time-based retention for this topic.", "is_deprecated": false, "is_enterprise": false, "is_topic_property": true, @@ -12793,7 +12785,7 @@ "config_scope": "broker", "default": null, "defined_in": "src/v/pandaproxy/schema_registry/configuration.cc", - "description": "Replication factor for internal `_schemas` topic. If unset, defaults to the xref:../cluster-properties.adoc#default_topic_replication[`default_topic_replication`] cluster property.", + "description": "Replication factor for internal `_schemas` topic. If unset, defaults to the xref:reference:properties/cluster-properties.adoc#default_topic_replication[`default_topic_replication`] cluster property.", "example": "[,yaml]\n----\npandaproxy:\n pandaproxy_api:\n address: 0.0.0.0\n port: 8082\n authentication_method: http_basic\n client_cache_max_size: 10\n client_keep_alive: 300000\n consumer_instance_timeout_ms: 300000\n----", "is_deprecated": false, "is_enterprise": false, @@ -12803,7 +12795,7 @@ "needs_restart": true, "nullable": true, "related_topics": [ - "xref:../cluster-properties.adoc#default_topic_replication[`default_topic_replication`]" + "xref:reference:properties/cluster-properties.adoc#default_topic_replication[`default_topic_replication`]" ], "type": "integer" }, @@ -12882,7 +12874,7 @@ "corresponding_cluster_property": "log_segment_size", "default": 134217728, "defined_in": "src/v/kafka/server/handlers/topics/types.h", - "description": "The maximum size of an active log segment for a topic. When the size of an active segment exceeds `segment.bytes`, the segment is closed and a new active segment is created. The closed, inactive segment is then eligible to be cleaned up according to retention properties.\n\nWhen `segment.bytes` is set to a positive value, it overrides the cluster property:\n\n* xref:./cluster-properties.adoc#log_segment_size[`log_segment_size`] for non-compacted topics\n* xref:./cluster-properties.adoc#compacted_log_segment_size[`compacted_log_segment_size`] for compacted topics (when `cleanup.policy=compact`)", + "description": "The maximum size of an active log segment for a topic. When the size of an active segment exceeds `segment.bytes`, the segment is closed and a new active segment is created. The closed, inactive segment is then eligible to be cleaned up according to retention properties.\n\nWhen `segment.bytes` is set to a positive value, it overrides the cluster property:\n\n* xref:reference:properties/cluster-properties.adoc#log_segment_size[`log_segment_size`] for non-compacted topics\n* xref:reference:properties/cluster-properties.adoc#compacted_log_segment_size[`compacted_log_segment_size`] for compacted topics (when `cleanup.policy=compact`)", "is_deprecated": false, "is_enterprise": false, "is_topic_property": true, @@ -12911,7 +12903,7 @@ "corresponding_cluster_property": "log_segment_ms", "default": "2 weeks", "defined_in": "src/v/kafka/server/handlers/topics/types.h", - "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\nIf 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`.\n\nFor topics with compaction enabled, `max.compaction.lag.ms` also acts as a limit to `segment.ms`.\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: Disables time-based segment rolling for this topic.", + "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\nIf set to a positive duration, `segment.ms` overrides the cluster property xref:reference:properties/cluster-properties.adoc#log_segment_ms[`log_segment_ms`]. Values are automatically clamped between the cluster bounds set by xref:reference:properties/cluster-properties.adoc#log_segment_ms_min[`log_segment_ms_min`] (default: 10 minutes) and xref:reference:properties/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`.\n\nFor topics with compaction enabled, `max.compaction.lag.ms` also acts as a limit to `segment.ms`.\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: Disables time-based segment rolling for this topic.", "is_deprecated": false, "is_enterprise": false, "is_topic_property": true, @@ -14004,7 +13996,7 @@ "corresponding_cluster_property": "write_caching_default", "default": "false", "defined_in": "src/v/kafka/server/handlers/topics/types.h", - "description": "The write caching mode to apply to a topic.\n\nWhen `write.caching` is set, it overrides the cluster property xref:cluster-properties.adoc#write_caching_default[`write_caching_default`]. Write caching acknowledges a message as soon as it is received and acknowledged on a majority of brokers, without waiting for it to be written to disk. With `acks=all`, this provides lower latency while still ensuring that a majority of brokers acknowledge the write. Fsyncs follow <> and <>, whichever is reached first.", + "description": "The write caching mode to apply to a topic.\n\nWhen `write.caching` is set, it overrides the cluster property xref:reference:properties/cluster-properties.adoc#write_caching_default[`write_caching_default`]. Write caching acknowledges a message as soon as it is received and acknowledged on a majority of brokers, without waiting for it to be written to disk. With `acks=all`, this provides lower latency while still ensuring that a majority of brokers acknowledge the write. Fsyncs follow <> and <>, whichever is reached first.", "enum": [ "true", "false", @@ -14019,7 +14011,7 @@ "xref:develop:manage-topics/config-topics.adoc#configure-write-caching[Write caching]", "xref:manage:tiered-storage.adoc[Tiered Storage]", "xref:reference:properties/cluster-properties.adoc#write_caching_default[`write_caching_default`]", - "xref:cluster-properties.adoc#write_caching_default[`write_caching_default`]" + "xref:reference:properties/cluster-properties.adoc#write_caching_default[`write_caching_default`]" ], "type": "string" }, diff --git a/modules/reference/partials/properties/cluster-properties.adoc b/modules/reference/partials/properties/cluster-properties.adoc index 6ce12fec6c..8da5b42d14 100644 --- a/modules/reference/partials/properties/cluster-properties.adoc +++ b/modules/reference/partials/properties/cluster-properties.adoc @@ -7847,11 +7847,6 @@ ifndef::env-cloud[] | User endif::[] -ifndef::env-cloud[] -| Related topics -|xref:reference:properties/topic-properties.adoc#redpanda-iceberg-enabled[`redpanda.iceberg.enabled`] -endif::[] - |=== // end::redpanda-cloud[] @@ -10067,7 +10062,7 @@ endif::[] === kafka_max_message_size_upper_limit_bytes -The maximum value you can set for the xref:./topic-properties.adoc#max-message-bytes[`max.message.bytes`] topic property. When set to `null`, no limit is enforced. +The maximum value you can set for the xref:reference:properties/topic-properties.adoc#max-message-bytes[`max.message.bytes`] topic property. When set to `null`, no limit is enforced. [cols="1s,2a"] |=== @@ -11428,9 +11423,9 @@ endif::[] | Related topics | -* xref:reference:cluster-properties.adoc#kafka_throughput_limit_node_in_bps[`kafka_throughput_limit_node_in_bps`] +* xref:reference:properties/cluster-properties.adoc#kafka_throughput_limit_node_in_bps[`kafka_throughput_limit_node_in_bps`] -* xref:reference:cluster-properties.adoc#kafka_throughput_limit_node_out_bps[`kafka_throughput_limit_node_out_bps`] +* xref:reference:properties/cluster-properties.adoc#kafka_throughput_limit_node_out_bps[`kafka_throughput_limit_node_out_bps`] * xref:manage:cluster-maintenance/manage-throughput.adoc[Manage Throughput] @@ -11936,7 +11931,7 @@ endif::[] Default cleanup policy for topic logs. -The topic property xref:./topic-properties.adoc#cleanup-policy[`cleanup.policy`] overrides the value of `log_cleanup_policy` at the topic level. +The topic property xref:reference:properties/topic-properties.adoc#cleanup-policy[`cleanup.policy`] overrides the value of `log_cleanup_policy` at the topic level. [cols="1s,2a"] |=== @@ -12343,7 +12338,7 @@ IMPORTANT: This property is ignored regardless of the value specified. The behav Default for the Kafka-compatible compression.type property. Redpanda does not recompress data. -The topic property xref:./topic-properties.adoc#compression-type[`compression.type`] overrides the value of `log_compression_type` at the topic level. +The topic property xref:reference:properties/topic-properties.adoc#compression-type[`compression.type`] overrides the value of `log_compression_type` at the topic level. [cols="1s,2a"] |=== @@ -12440,7 +12435,7 @@ endif::[] === log_message_timestamp_after_max_ms -The maximum allowed time difference when a record's timestamp is in the future compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the future. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#message-timestamp-after-max-ms[`message.timestamp.after.max.ms`] overrides this cluster-level setting. +The maximum allowed time difference when a record's timestamp is in the future compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the future. This property has no effect on topics using <> timestamps. The topic property xref:reference:properties/topic-properties.adoc#message-timestamp-after-max-ms[`message.timestamp.after.max.ms`] overrides this cluster-level setting. [cols="1s,2a"] |=== @@ -12490,7 +12485,7 @@ endif::[] === log_message_timestamp_before_max_ms -The maximum allowed time difference when a record's timestamp is in the past compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the past. This property has no effect on topics using <> timestamps. The topic property xref:./topic-properties.adoc#message-timestamp-before-max-ms[`message.timestamp.before.max.ms`] overrides this cluster-level setting. +The maximum allowed time difference when a record's timestamp is in the past compared to the broker's clock. For topics using <> timestamps, Redpanda rejects records with timestamps that are too far in the past. This property has no effect on topics using <> timestamps. The topic property xref:reference:properties/topic-properties.adoc#message-timestamp-before-max-ms[`message.timestamp.before.max.ms`] overrides this cluster-level setting. [cols="1s,2a"] |=== @@ -12542,7 +12537,7 @@ endif::[] Default timestamp type for topic messages (CreateTime or LogAppendTime). -The topic property xref:./topic-properties.adoc#message-timestamp-type[`message.timestamp.type`] overrides the value of `log_message_timestamp_type` at the topic level. +The topic property xref:reference:properties/topic-properties.adoc#message-timestamp-type[`message.timestamp.type`] overrides the value of `log_message_timestamp_type` at the topic level. [cols="1s,2a"] |=== diff --git a/modules/reference/partials/properties/topic-properties.adoc b/modules/reference/partials/properties/topic-properties.adoc index c7d86baeaf..4f180a60fe 100644 --- a/modules/reference/partials/properties/topic-properties.adoc +++ b/modules/reference/partials/properties/topic-properties.adoc @@ -3,7 +3,7 @@ === cleanup.policy The cleanup policy to apply for log segments of a topic. -When `cleanup.policy` is set, it overrides the cluster property xref:cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`] for the topic. +When `cleanup.policy` is set, it overrides the cluster property xref:reference:properties/cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`] for the topic. **Values**: @@ -29,7 +29,7 @@ endif::[] | Corresponding cluster property -| xref:reference:cluster-properties.adoc#log_cleanup_policy[log_cleanup_policy] +| xref:reference:properties/cluster-properties.adoc#log_cleanup_policy[log_cleanup_policy] | Default | @@ -50,7 +50,7 @@ endif::[] | Related topics | -* xref:cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`] +* xref:reference:properties/cluster-properties.adoc#log_cleanup_policy[`log_cleanup_policy`] * xref:manage:cluster-maintenance/disk-utilization.adoc#configure-segment-size[Configure segment size] @@ -93,9 +93,6 @@ ifndef::env-cloud[] | Yes endif::[] -| Related topics -|xref:reference:properties/cluster-properties.adoc#compaction_strategy[`compaction_strategy`] - |=== // end::category-retention-compaction[] @@ -109,7 +106,7 @@ This property exists for Apache Kafka compatibility. Configure compression in yo Compression reduces message size and improves throughput, but increases CPU utilization. Enable producer batching to increase compression efficiency. -When set, this property overrides the cluster property xref:./cluster-properties.adoc#log_compression_type[`log_compression_type`] for the topic. +When set, this property overrides the cluster property xref:reference:properties/cluster-properties.adoc#log_compression_type[`log_compression_type`] for the topic. [cols="1s,2a"] |=== @@ -129,7 +126,7 @@ endif::[] | Corresponding cluster property -| xref:reference:cluster-properties.adoc#log_compression_type[log_compression_type] +| xref:reference:properties/cluster-properties.adoc#log_compression_type[log_compression_type] | Default | @@ -340,7 +337,7 @@ This property supports three states: | Corresponding cluster property -| xref:reference:cluster-properties.adoc#tombstone_retention_ms[tombstone_retention_ms] +| xref:reference:properties/cluster-properties.adoc#tombstone_retention_ms[tombstone_retention_ms] | Default | @@ -387,7 +384,7 @@ The maximum bytes not fsynced per partition. If this configured threshold is rea | Corresponding cluster property -| xref:reference:cluster-properties.adoc#raft_replica_max_pending_flush_bytes[raft_replica_max_pending_flush_bytes] +| xref:reference:properties/cluster-properties.adoc#raft_replica_max_pending_flush_bytes[raft_replica_max_pending_flush_bytes] | Default | @@ -406,9 +403,6 @@ ifndef::env-cloud[] | Yes endif::[] -| Related topics -|xref:reference:properties/cluster-properties.adoc#flush_bytes[`flush_bytes`] - |=== // end::category-performance-cluster[] @@ -431,7 +425,7 @@ The maximum delay (in ms) between two subsequent fsyncs. After this delay, the l | Corresponding cluster property -| xref:reference:cluster-properties.adoc#raft_replica_max_flush_delay_ms[raft_replica_max_flush_delay_ms] +| xref:reference:properties/cluster-properties.adoc#raft_replica_max_flush_delay_ms[raft_replica_max_flush_delay_ms] | Default | @@ -450,9 +444,6 @@ ifndef::env-cloud[] | Yes endif::[] -| Related topics -|xref:reference:properties/cluster-properties.adoc#flush_ms[`flush_ms`] - |=== // end::category-performance-cluster[] @@ -524,7 +515,7 @@ This property supports three states: | Corresponding cluster property -| xref:reference:cluster-properties.adoc#initial_retention_local_target_bytes_default[initial_retention_local_target_bytes_default] +| xref:reference:properties/cluster-properties.adoc#initial_retention_local_target_bytes_default[initial_retention_local_target_bytes_default] | Default | @@ -545,7 +536,7 @@ endif::[] | Related topics | -* xref:reference:properties/cluster-properties.adoc#initial_retention_local_target_bytes[`initial_retention_local_target_bytes`] +* xref:reference:properties/cluster-properties.adoc#initial_retention_local_target_bytes_default[`initial_retention_local_target_bytes`] * xref:manage:tiered-storage.adoc#fast-commission-and-decommission[Fast commission and decommission through Tiered Storage] @@ -577,7 +568,7 @@ This property supports three states: | Corresponding cluster property -| xref:reference:cluster-properties.adoc#initial_retention_local_target_ms_default[initial_retention_local_target_ms_default] +| xref:reference:properties/cluster-properties.adoc#initial_retention_local_target_ms_default[initial_retention_local_target_ms_default] | Default | @@ -598,7 +589,7 @@ endif::[] | Related topics | -* xref:reference:properties/cluster-properties.adoc#initial_retention_local_target_ms[`initial_retention_local_target_ms`] +* xref:reference:properties/cluster-properties.adoc#initial_retention_local_target_ms_default[`initial_retention_local_target_ms`] * xref:manage:tiered-storage.adoc#fast-commission-and-decommission[Fast commission and decommission through Tiered Storage] @@ -609,7 +600,7 @@ endif::[] // tag::category-retention-compaction[] === max.compaction.lag.ms -The maximum amount of time (in ms) that a log segment can remain unaltered before it is eligible for compaction in a compact topic. Overrides the cluster property xref:cluster-properties.adoc#max_compaction_lag_ms[`max_compaction_lag_ms`] for the topic. +The maximum amount of time (in ms) that a log segment can remain unaltered before it is eligible for compaction in a compact topic. Overrides the cluster property xref:reference:properties/cluster-properties.adoc#max_compaction_lag_ms[`max_compaction_lag_ms`] for the topic. [cols="1s,2a"] |=== @@ -624,7 +615,7 @@ The maximum amount of time (in ms) that a log segment can remain unaltered befor | Corresponding cluster property -| xref:reference:cluster-properties.adoc#max_compaction_lag_ms[max_compaction_lag_ms] +| xref:reference:properties/cluster-properties.adoc#max_compaction_lag_ms[max_compaction_lag_ms] | Default | @@ -658,7 +649,7 @@ endif::[] The maximum size of a message or batch of a topic. If a compression type is enabled, `max.message.bytes` sets the maximum size of the compressed message or batch. -If `max.message.bytes` is set to a positive value, it overrides the cluster property xref:./cluster-properties.adoc#kafka_batch_max_bytes[`kafka_batch_max_bytes`] for the topic. +If `max.message.bytes` is set to a positive value, it overrides the cluster property xref:reference:properties/cluster-properties.adoc#kafka_batch_max_bytes[`kafka_batch_max_bytes`] for the topic. Set an upper limit for `max.message.bytes` using the cluster property config_ref:kafka_max_message_size_upper_limit_bytes,true,properties/cluster-properties[`kafka_max_message_size_upper_limit_bytes`]. @@ -675,7 +666,7 @@ Set an upper limit for `max.message.bytes` using the cluster property config_ref | Corresponding cluster property -| xref:reference:cluster-properties.adoc#kafka_batch_max_bytes[kafka_batch_max_bytes] +| xref:reference:properties/cluster-properties.adoc#kafka_batch_max_bytes[kafka_batch_max_bytes] | Default | @@ -724,7 +715,7 @@ The maximum allowable timestamp difference between the broker's timestamp and a | Corresponding cluster property -| xref:reference:cluster-properties.adoc#log_message_timestamp_after_max_ms[log_message_timestamp_after_max_ms] +| xref:reference:properties/cluster-properties.adoc#log_message_timestamp_after_max_ms[log_message_timestamp_after_max_ms] | Default | @@ -768,7 +759,7 @@ The maximum allowable timestamp difference between the broker's timestamp and a | Corresponding cluster property -| xref:reference:cluster-properties.adoc#log_message_timestamp_before_max_ms[log_message_timestamp_before_max_ms] +| xref:reference:properties/cluster-properties.adoc#log_message_timestamp_before_max_ms[log_message_timestamp_before_max_ms] | Default | @@ -799,7 +790,7 @@ endif::[] The source of a message's timestamp: either the message's creation time or its log append time. -When `message.timestamp.type` is set, it overrides the cluster property xref:./cluster-properties.adoc#log_message_timestamp_type[`log_message_timestamp_type`] for the topic. +When `message.timestamp.type` is set, it overrides the cluster property xref:reference:properties/cluster-properties.adoc#log_message_timestamp_type[`log_message_timestamp_type`] for the topic. [cols="1s,2a"] |=== @@ -819,7 +810,7 @@ endif::[] | Corresponding cluster property -| xref:reference:cluster-properties.adoc#log_message_timestamp_type[log_message_timestamp_type] +| xref:reference:properties/cluster-properties.adoc#log_message_timestamp_type[log_message_timestamp_type] | Default | @@ -869,7 +860,7 @@ This property supports three states: | Corresponding cluster property -| xref:reference:cluster-properties.adoc#min_cleanable_dirty_ratio[min_cleanable_dirty_ratio] +| xref:reference:properties/cluster-properties.adoc#min_cleanable_dirty_ratio[min_cleanable_dirty_ratio] | Default | @@ -898,7 +889,7 @@ endif::[] // tag::category-retention-compaction[] === min.compaction.lag.ms -The minimum amount of time (in ms) that a log segment must remain unaltered before it can be compacted in a compact topic. Overrides the cluster property xref:cluster-properties.adoc#min_compaction_lag_ms[`min_compaction_lag_ms`] for the topic. +The minimum amount of time (in ms) that a log segment must remain unaltered before it can be compacted in a compact topic. Overrides the cluster property xref:reference:properties/cluster-properties.adoc#min_compaction_lag_ms[`min_compaction_lag_ms`] for the topic. [cols="1s,2a"] |=== @@ -913,7 +904,7 @@ The minimum amount of time (in ms) that a log segment must remain unaltered befo | Corresponding cluster property -| xref:reference:cluster-properties.adoc#min_compaction_lag_ms[min_compaction_lag_ms] +| xref:reference:properties/cluster-properties.adoc#min_compaction_lag_ms[min_compaction_lag_ms] | Default | @@ -934,7 +925,7 @@ endif::[] | Related topics | -* xref:cluster-properties.adoc#min_compaction_lag_ms[`min_compaction_lag_ms`] +* xref:reference:properties/cluster-properties.adoc#min_compaction_lag_ms[`min_compaction_lag_ms`] * xref:reference:properties/cluster-properties.adoc#min_compaction_lag_ms[`min_compaction_lag_ms`] @@ -1010,7 +1001,7 @@ Whether the corresponding Iceberg table is deleted upon deleting the topic. | Corresponding cluster property -| xref:reference:cluster-properties.adoc#iceberg_delete[iceberg_delete] +| xref:reference:properties/cluster-properties.adoc#iceberg_delete[iceberg_delete] | Default | @@ -1056,7 +1047,7 @@ endif::[] | Corresponding cluster property -| xref:reference:cluster-properties.adoc#iceberg_invalid_record_action[iceberg_invalid_record_action] +| xref:reference:properties/cluster-properties.adoc#iceberg_invalid_record_action[iceberg_invalid_record_action] | Default | @@ -1135,7 +1126,7 @@ The link:https://iceberg.apache.org/docs/nightly/partitioning/[partitioning^] sp | Corresponding cluster property -| xref:reference:cluster-properties.adoc#iceberg_default_partition_spec[iceberg_default_partition_spec] +| xref:reference:properties/cluster-properties.adoc#iceberg_default_partition_spec[iceberg_default_partition_spec] | Default | @@ -1302,7 +1293,7 @@ If the cluster configuration property config_ref:enable_rack_awareness,true,prop | Corresponding cluster property -| xref:reference:cluster-properties.adoc#default_leaders_preference[default_leaders_preference] +| xref:reference:properties/cluster-properties.adoc#default_leaders_preference[default_leaders_preference] | Default | @@ -1345,7 +1336,7 @@ No description available. | Corresponding cluster property -| xref:reference:cluster-properties.adoc#cloud_storage_enable_remote_allow_gaps[cloud_storage_enable_remote_allow_gaps] +| xref:reference:properties/object-storage-properties.adoc#cloud_storage_enable_remote_allow_gaps[cloud_storage_enable_remote_allow_gaps] | Default | @@ -1424,7 +1415,7 @@ A flag for enabling Redpanda to fetch data for a topic from object storage to lo | Corresponding cluster property -| xref:reference:cluster-properties.adoc#cloud_storage_enable_remote_read[cloud_storage_enable_remote_read] +| xref:reference:properties/object-storage-properties.adoc#cloud_storage_enable_remote_read[cloud_storage_enable_remote_read] | Default | @@ -1545,7 +1536,7 @@ A flag for enabling Redpanda to upload data for a topic from local storage to ob | Corresponding cluster property -| xref:reference:cluster-properties.adoc#cloud_storage_enable_remote_write[cloud_storage_enable_remote_write] +| xref:reference:properties/object-storage-properties.adoc#cloud_storage_enable_remote_write[cloud_storage_enable_remote_write] | Default | @@ -1611,7 +1602,7 @@ endif::[] | Corresponding cluster property -| xref:reference:cluster-properties.adoc#default_redpanda_storage_mode[default_redpanda_storage_mode] +| xref:reference:properties/cluster-properties.adoc#default_redpanda_storage_mode[default_redpanda_storage_mode] | Default | @@ -1761,7 +1752,7 @@ endif::[] The number of replicas of a topic to save in different nodes (brokers) of a cluster. -If `replication.factor` is set to a positive value, it overrides the cluster property xref:./cluster-properties.adoc#default_topic_replication[default_topic_replication] for the topic. +If `replication.factor` is set to a positive value, it overrides the cluster property xref:reference:properties/cluster-properties.adoc#default_topic_replication[default_topic_replication] for the topic. NOTE: Although `replication.factor` isn't returned or displayed by xref:reference:rpk/rpk-topic/rpk-topic-describe.adoc[`rpk topic describe`] as a valid Kafka property, you can set it using xref:reference:rpk/rpk-topic/rpk-topic-alter-config.adoc[`rpk topic alter-config`]. When the `replication.factor` of a topic is altered, it isn't simply a property value that's updated, but rather the actual replica sets of topic partitions that are changed. @@ -1817,7 +1808,7 @@ 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. +If `retention.bytes` is set to a positive value, it overrides the cluster property xref:reference:properties/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. When both size-based (`retention.bytes`) and time-based (`retention.ms`) retention limits are set, cleanup occurs when either limit is reached. @@ -1840,7 +1831,7 @@ This property supports three states: | Corresponding cluster property -| xref:reference:cluster-properties.adoc#retention_bytes[retention_bytes] +| xref:reference:properties/cluster-properties.adoc#retention_bytes[retention_bytes] | Default | @@ -1893,7 +1884,7 @@ This property supports three states: | Corresponding cluster property -| xref:reference:cluster-properties.adoc#retention_local_target_bytes_default[retention_local_target_bytes_default] +| xref:reference:properties/cluster-properties.adoc#retention_local_target_bytes_default[retention_local_target_bytes_default] | Default | @@ -1914,7 +1905,7 @@ endif::[] | Related topics | -* xref:reference:properties/cluster-properties.adoc#retention_local_target_bytes[`retention_local_target_bytes`] +* xref:reference:properties/cluster-properties.adoc#retention_local_target_bytes_default[`retention_local_target_bytes`] * xref:manage:tiered-storage.adoc[Tiered Storage] @@ -1946,7 +1937,7 @@ This property supports three states: | Corresponding cluster property -| xref:reference:cluster-properties.adoc#retention_local_target_ms_default[retention_local_target_ms_default] +| xref:reference:properties/cluster-properties.adoc#retention_local_target_ms_default[retention_local_target_ms_default] | Default | @@ -1967,7 +1958,7 @@ endif::[] | Related topics | -* xref:reference:properties/cluster-properties.adoc#retention_local_target_ms[`retention_local_target_ms`] +* xref:reference:properties/cluster-properties.adoc#retention_local_target_ms_default[`retention_local_target_ms`] * xref:manage:tiered-storage.adoc[Tiered Storage] @@ -1982,7 +1973,7 @@ endif::[] 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 `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. +If `retention.ms` is set to a positive value, it overrides the cluster property xref:reference:properties/cluster-properties.adoc#log_retention_ms[`log_retention_ms`] for the topic. When both size-based (`retention.bytes`) and time-based (`retention.ms`) retention limits are set, the earliest occurring limit applies. @@ -2002,7 +1993,7 @@ This property supports three states: | Corresponding cluster property -| xref:reference:cluster-properties.adoc#log_retention_ms[log_retention_ms] +| xref:reference:properties/cluster-properties.adoc#log_retention_ms[log_retention_ms] | Default | @@ -2038,8 +2029,8 @@ The maximum size of an active log segment for a topic. When the size of an activ When `segment.bytes` is set to a positive value, it overrides the cluster property: -* xref:./cluster-properties.adoc#log_segment_size[`log_segment_size`] for non-compacted topics -* xref:./cluster-properties.adoc#compacted_log_segment_size[`compacted_log_segment_size`] for compacted topics (when `cleanup.policy=compact`) +* xref:reference:properties/cluster-properties.adoc#log_segment_size[`log_segment_size`] for non-compacted topics +* xref:reference:properties/cluster-properties.adoc#compacted_log_segment_size[`compacted_log_segment_size`] for compacted topics (when `cleanup.policy=compact`) [cols="1s,2a"] |=== @@ -2054,7 +2045,7 @@ When `segment.bytes` is set to a positive value, it overrides the cluster proper | Corresponding cluster property -| xref:reference:cluster-properties.adoc#log_segment_size[log_segment_size] +| xref:reference:properties/cluster-properties.adoc#log_segment_size[log_segment_size] | Default | @@ -2094,7 +2085,7 @@ endif::[] 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. -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`. +If set to a positive duration, `segment.ms` overrides the cluster property xref:reference:properties/cluster-properties.adoc#log_segment_ms[`log_segment_ms`]. Values are automatically clamped between the cluster bounds set by xref:reference:properties/cluster-properties.adoc#log_segment_ms_min[`log_segment_ms_min`] (default: 10 minutes) and xref:reference:properties/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`. For topics with compaction enabled, `max.compaction.lag.ms` also acts as a limit to `segment.ms`. @@ -2117,7 +2108,7 @@ This property supports three states: | Corresponding cluster property -| xref:reference:cluster-properties.adoc#log_segment_ms[log_segment_ms] +| xref:reference:properties/cluster-properties.adoc#log_segment_ms[log_segment_ms] | Default | @@ -2155,7 +2146,7 @@ endif::[] The write caching mode to apply to a topic. -When `write.caching` is set, it overrides the cluster property xref:cluster-properties.adoc#write_caching_default[`write_caching_default`]. Write caching acknowledges a message as soon as it is received and acknowledged on a majority of brokers, without waiting for it to be written to disk. With `acks=all`, this provides lower latency while still ensuring that a majority of brokers acknowledge the write. Fsyncs follow <> and <>, whichever is reached first. +When `write.caching` is set, it overrides the cluster property xref:reference:properties/cluster-properties.adoc#write_caching_default[`write_caching_default`]. Write caching acknowledges a message as soon as it is received and acknowledged on a majority of brokers, without waiting for it to be written to disk. With `acks=all`, this provides lower latency while still ensuring that a majority of brokers acknowledge the write. Fsyncs follow <> and <>, whichever is reached first. [cols="1s,2a"] |=== @@ -2175,7 +2166,7 @@ endif::[] | Corresponding cluster property -| xref:reference:cluster-properties.adoc#write_caching_default[write_caching_default] +| xref:reference:properties/cluster-properties.adoc#write_caching_default[write_caching_default] | Default | @@ -2202,7 +2193,7 @@ endif::[] * xref:reference:properties/cluster-properties.adoc#write_caching_default[`write_caching_default`] -* xref:cluster-properties.adoc#write_caching_default[`write_caching_default`] +* xref:reference:properties/cluster-properties.adoc#write_caching_default[`write_caching_default`] |===