You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Add leader_balancer_mode greedy option and preserve conditional xrefs
- Add override for leader_balancer_mode documenting the new greedy strategy
- Embed AsciiDoc conditionals in storage mode property descriptions to preserve
xrefs for self-managed and plain text for cloud docs
Copy file name to clipboardExpand all lines: docs-data/property-overrides.json
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -775,7 +775,7 @@
775
775
"config_scope": "cluster"
776
776
},
777
777
"default_redpanda_storage_mode": {
778
-
"description": "Set the default storage mode for new topics. This value applies to any topic created without an explicit <<redpandastoragemode,`redpanda.storage.mode`>> setting (that is, when the topic's `redpanda.storage.mode` is `unset`).\n\nAccepted values:\n\n* `unset`: Defer to the legacy <<cloud_storage_enable_remote_read,`redpanda.remote.read`>> and <<cloud_storage_enable_remote_write,`redpanda.remote.write`>> topic properties for Tiered Storage configuration.\n* `local`: Store data only on local disks, with no object storage involvement.\n* `tiered`: Store data on local disks and replicate it to object storage using xref:manage:tiered-storage.adoc[Tiered Storage]. Equivalent to setting `redpanda.remote.read` and `redpanda.remote.write` to `true`.\n* `cloud`: Store data primarily in object storage using xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics].",
778
+
"description": "Set the default storage mode for new topics. This value applies to any topic created without an explicit <<redpandastoragemode,`redpanda.storage.mode`>> setting (that is, when the topic's `redpanda.storage.mode` is `unset`).\n\nAccepted values:\n\n* `unset`: Defer to the legacy <<cloud_storage_enable_remote_read,`redpanda.remote.read`>> and <<cloud_storage_enable_remote_write,`redpanda.remote.write`>> topic properties for Tiered Storage configuration.\n* `local`: Store data only on local disks, with no object storage involvement.\nifndef::env-cloud[]\n* `tiered`: Store data on local disks and replicate it to object storage using xref:manage:tiered-storage.adoc[Tiered Storage]. Equivalent to setting `redpanda.remote.read` and `redpanda.remote.write` to `true`.\n* `cloud`: Store data primarily in object storage using xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics].\nendif::[]\nifdef::env-cloud[]\n* `tiered`: Store data on local disks and replicate it to object storage using Tiered Storage. Equivalent to setting `redpanda.remote.read` and `redpanda.remote.write` to `true`.\n* `cloud`: Store data primarily in object storage using Cloud Topics.\nendif::[]",
"description": "Initial local retention size target for partitions of topics with xref:manage:tiered-storage.adoc[Tiered Storage] enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.",
1095
+
"description": "ifndef::env-cloud[]\nInitial local retention size target for partitions of topics with xref:manage:tiered-storage.adoc[Tiered Storage] enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.\nendif::[]\nifdef::env-cloud[]\nInitial local retention size target for partitions of topics with Tiered Storage enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.\nendif::[]",
"description": "Initial local retention time target for partitions of topics with xref:manage:tiered-storage.adoc[Tiered Storage] enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.",
1102
+
"description": "ifndef::env-cloud[]\nInitial local retention time target for partitions of topics with xref:manage:tiered-storage.adoc[Tiered Storage] enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.\nendif::[]\nifdef::env-cloud[]\nInitial local retention time target for partitions of topics with Tiered Storage enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.\nendif::[]",
"description": "The storage mode for a topic. Determines how topic data is stored and whether it is eligible for upload to object storage.\n\nAccepted values:\n\n* `local`: Topic data is stored only on the broker's local disk. Object storage upload is disabled for the topic, regardless of cluster-level Tiered Storage settings.\n* `tiered`: Topic data is stored on local disk and also uploaded to object storage. Enables xref:manage:tiered-storage.adoc[Tiered Storage] for the topic.\n* `cloud`: Topic data is stored in object storage using the xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics] architecture. Local storage is used only as a write buffer.\n* `unset`: Specifies that the topic's storage mode is unset, regardless of the cluster default. The topic may still have Tiered Storage enabled through the legacy properties `redpanda.remote.read` and `redpanda.remote.write`.\n\nThis property overrides the cluster-wide config_ref:default_redpanda_storage_mode,true,properties/cluster-properties[] setting for individual topics.",
1802
+
"description": "The storage mode for a topic. Determines how topic data is stored and whether it is eligible for upload to object storage.\n\nAccepted values:\n\n* `local`: Topic data is stored only on the broker's local disk. Object storage upload is disabled for the topic, regardless of cluster-level Tiered Storage settings.\nifndef::env-cloud[]\n* `tiered`: Topic data is stored on local disk and also uploaded to object storage. Enables xref:manage:tiered-storage.adoc[Tiered Storage] for the topic.\n* `cloud`: Topic data is stored in object storage using the xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics] architecture. Local storage is used only as a write buffer.\nendif::[]\nifdef::env-cloud[]\n* `tiered`: Topic data is stored on local disk and also uploaded to object storage. Enables Tiered Storage for the topic.\n* `cloud`: Topic data is stored in object storage using the Cloud Topics architecture. Local storage is used only as a write buffer.\nendif::[]\n* `unset`: Specifies that the topic's storage mode is unset, regardless of the cluster default. The topic may still have Tiered Storage enabled through the legacy properties `redpanda.remote.read` and `redpanda.remote.write`.\n\nThis property overrides the cluster-wide config_ref:default_redpanda_storage_mode,true,properties/cluster-properties[] setting for individual topics.",
"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 <<raft_replica_max_pending_flush_bytes,`raft_replica_max_pending_flush_bytes`>> and <<raft_replica_max_flush_delay_ms,`raft_replica_max_flush_delay_ms`>>, 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."
Copy file name to clipboardExpand all lines: modules/reference/attachments/redpanda-properties-v26.1.2.json
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -5498,7 +5498,7 @@
5498
5498
"config_scope": "cluster",
5499
5499
"default": "unset",
5500
5500
"defined_in": "src/v/config/configuration.cc",
5501
-
"description": "Set the default storage mode for new topics. This value applies to any topic created without an explicit <<redpandastoragemode,`redpanda.storage.mode`>> setting (that is, when the topic's `redpanda.storage.mode` is `unset`).\n\nAccepted values:\n\n* `unset`: Defer to the legacy <<cloud_storage_enable_remote_read,`redpanda.remote.read`>> and <<cloud_storage_enable_remote_write,`redpanda.remote.write`>> topic properties for Tiered Storage configuration.\n* `local`: Store data only on local disks, with no object storage involvement.\n* `tiered`: Store data on local disks and replicate it to object storage using xref:manage:tiered-storage.adoc[Tiered Storage]. Equivalent to setting `redpanda.remote.read` and `redpanda.remote.write` to `true`.\n* `cloud`: Store data primarily in object storage using xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics].",
5501
+
"description": "Set the default storage mode for new topics. This value applies to any topic created without an explicit <<redpandastoragemode,`redpanda.storage.mode`>> setting (that is, when the topic's `redpanda.storage.mode` is `unset`).\n\nAccepted values:\n\n* `unset`: Defer to the legacy <<cloud_storage_enable_remote_read,`redpanda.remote.read`>> and <<cloud_storage_enable_remote_write,`redpanda.remote.write`>> topic properties for Tiered Storage configuration.\n* `local`: Store data only on local disks, with no object storage involvement.\nifndef::env-cloud[]\n* `tiered`: Store data on local disks and replicate it to object storage using xref:manage:tiered-storage.adoc[Tiered Storage]. Equivalent to setting `redpanda.remote.read` and `redpanda.remote.write` to `true`.\n* `cloud`: Store data primarily in object storage using xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics].\nendif::[]\nifdef::env-cloud[]\n* `tiered`: Store data on local disks and replicate it to object storage using Tiered Storage. Equivalent to setting `redpanda.remote.read` and `redpanda.remote.write` to `true`.\n* `cloud`: Store data primarily in object storage using Cloud Topics.\nendif::[]",
5502
5502
"enum": [
5503
5503
"local",
5504
5504
"tiered",
@@ -7579,7 +7579,7 @@
7579
7579
"config_scope": "cluster",
7580
7580
"default": null,
7581
7581
"defined_in": "src/v/config/configuration.cc",
7582
-
"description": "Initial local retention size target for partitions of topics with xref:manage:tiered-storage.adoc[Tiered Storage] enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.",
7582
+
"description": "ifndef::env-cloud[]\nInitial local retention size target for partitions of topics with xref:manage:tiered-storage.adoc[Tiered Storage] enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.\nendif::[]\nifdef::env-cloud[]\nInitial local retention size target for partitions of topics with Tiered Storage enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.\nendif::[]",
"description": "Initial local retention time target for partitions of topics with xref:manage:tiered-storage.adoc[Tiered Storage] enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.",
7603
+
"description": "ifndef::env-cloud[]\nInitial local retention time target for partitions of topics with xref:manage:tiered-storage.adoc[Tiered Storage] enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.\nendif::[]\nifdef::env-cloud[]\nInitial local retention time target for partitions of topics with Tiered Storage enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.\nendif::[]",
"description": "The storage mode for a topic. Determines how topic data is stored and whether it is eligible for upload to object storage.\n\nAccepted values:\n\n* `local`: Topic data is stored only on the broker's local disk. Object storage upload is disabled for the topic, regardless of cluster-level Tiered Storage settings.\n* `tiered`: Topic data is stored on local disk and also uploaded to object storage. Enables xref:manage:tiered-storage.adoc[Tiered Storage] for the topic.\n* `cloud`: Topic data is stored in object storage using the xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics] architecture. Local storage is used only as a write buffer.\n* `unset`: Specifies that the topic's storage mode is unset, regardless of the cluster default. The topic may still have Tiered Storage enabled through the legacy properties `redpanda.remote.read` and `redpanda.remote.write`.\n\nThis property overrides the cluster-wide config_ref:default_redpanda_storage_mode,true,properties/cluster-properties[] setting for individual topics.",
11626
+
"description": "The storage mode for a topic. Determines how topic data is stored and whether it is eligible for upload to object storage.\n\nAccepted values:\n\n* `local`: Topic data is stored only on the broker's local disk. Object storage upload is disabled for the topic, regardless of cluster-level Tiered Storage settings.\nifndef::env-cloud[]\n* `tiered`: Topic data is stored on local disk and also uploaded to object storage. Enables xref:manage:tiered-storage.adoc[Tiered Storage] for the topic.\n* `cloud`: Topic data is stored in object storage using the xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics] architecture. Local storage is used only as a write buffer.\nendif::[]\nifdef::env-cloud[]\n* `tiered`: Topic data is stored on local disk and also uploaded to object storage. Enables Tiered Storage for the topic.\n* `cloud`: Topic data is stored in object storage using the Cloud Topics architecture. Local storage is used only as a write buffer.\nendif::[]\n* `unset`: Specifies that the topic's storage mode is unset, regardless of the cluster default. The topic may still have Tiered Storage enabled through the legacy properties `redpanda.remote.read` and `redpanda.remote.write`.\n\nThis property overrides the cluster-wide config_ref:default_redpanda_storage_mode,true,properties/cluster-properties[] setting for individual topics.",
Copy file name to clipboardExpand all lines: modules/reference/partials/properties/cluster-properties.adoc
+16Lines changed: 16 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4935,8 +4935,14 @@ Accepted values:
4935
4935
4936
4936
* `unset`: Defer to the legacy <<cloud_storage_enable_remote_read,`redpanda.remote.read`>> and <<cloud_storage_enable_remote_write,`redpanda.remote.write`>> topic properties for Tiered Storage configuration.
4937
4937
* `local`: Store data only on local disks, with no object storage involvement.
4938
+
ifndef::env-cloud[]
4938
4939
* `tiered`: Store data on local disks and replicate it to object storage using xref:manage:tiered-storage.adoc[Tiered Storage]. Equivalent to setting `redpanda.remote.read` and `redpanda.remote.write` to `true`.
4939
4940
* `cloud`: Store data primarily in object storage using xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics].
4941
+
endif::[]
4942
+
ifdef::env-cloud[]
4943
+
* `tiered`: Store data on local disks and replicate it to object storage using Tiered Storage. Equivalent to setting `redpanda.remote.read` and `redpanda.remote.write` to `true`.
4944
+
* `cloud`: Store data primarily in object storage using Cloud Topics.
4945
+
endif::[]
4940
4946
4941
4947
[cols="1s,2a"]
4942
4948
|===
@@ -9164,7 +9170,12 @@ endif::[]
9164
9170
9165
9171
=== initial_retention_local_target_bytes_default
9166
9172
9173
+
ifndef::env-cloud[]
9167
9174
Initial local retention size target for partitions of topics with xref:manage:tiered-storage.adoc[Tiered Storage] enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.
9175
+
endif::[]
9176
+
ifdef::env-cloud[]
9177
+
Initial local retention size target for partitions of topics with Tiered Storage enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.
9178
+
endif::[]
9168
9179
9169
9180
[cols="1s,2a"]
9170
9181
|===
@@ -9210,7 +9221,12 @@ endif::[]
9210
9221
9211
9222
=== initial_retention_local_target_ms_default
9212
9223
9224
+
ifndef::env-cloud[]
9213
9225
Initial local retention time target for partitions of topics with xref:manage:tiered-storage.adoc[Tiered Storage] enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.
9226
+
endif::[]
9227
+
ifdef::env-cloud[]
9228
+
Initial local retention time target for partitions of topics with Tiered Storage enabled. If no initial local target retention is configured, then all locally-retained data will be delivered to the learner when joining the partition replica set.
Copy file name to clipboardExpand all lines: modules/reference/partials/properties/topic-properties.adoc
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1567,8 +1567,14 @@ The storage mode for a topic. Determines how topic data is stored and whether it
1567
1567
Accepted values:
1568
1568
1569
1569
* `local`: Topic data is stored only on the broker's local disk. Object storage upload is disabled for the topic, regardless of cluster-level Tiered Storage settings.
1570
+
ifndef::env-cloud[]
1570
1571
* `tiered`: Topic data is stored on local disk and also uploaded to object storage. Enables xref:manage:tiered-storage.adoc[Tiered Storage] for the topic.
1571
1572
* `cloud`: Topic data is stored in object storage using the xref:develop:manage-topics/cloud-topics.adoc[Cloud Topics] architecture. Local storage is used only as a write buffer.
1573
+
endif::[]
1574
+
ifdef::env-cloud[]
1575
+
* `tiered`: Topic data is stored on local disk and also uploaded to object storage. Enables Tiered Storage for the topic.
1576
+
* `cloud`: Topic data is stored in object storage using the Cloud Topics architecture. Local storage is used only as a write buffer.
1577
+
endif::[]
1572
1578
* `unset`: Specifies that the topic's storage mode is unset, regardless of the cluster default. The topic may still have Tiered Storage enabled through the legacy properties `redpanda.remote.read` and `redpanda.remote.write`.
1573
1579
1574
1580
This property overrides the cluster-wide config_ref:default_redpanda_storage_mode,true,properties/cluster-properties[] setting for individual topics.
0 commit comments