Skip to content

Commit 3490c89

Browse files
committed
Add cloud_topics configs
1 parent 143ff36 commit 3490c89

5 files changed

Lines changed: 13 additions & 41 deletions

File tree

docs-data/property-overrides.json

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -469,31 +469,24 @@
469469
"config_scope": "cluster"
470470
},
471471
"cloud_topics_disable_reconciliation_loop": {
472-
"exclude_from_docs": true,
473472
"config_scope": "cluster"
474473
},
475474
"cloud_topics_enabled": {
476-
"exclude_from_docs": true,
477475
"config_scope": "cluster"
478476
},
479477
"cloud_topics_long_term_garbage_collection_interval": {
480-
"exclude_from_docs": true,
481478
"config_scope": "cluster"
482479
},
483480
"cloud_topics_produce_batching_size_threshold": {
484-
"exclude_from_docs": true,
485481
"config_scope": "cluster"
486482
},
487483
"cloud_topics_produce_cardinality_threshold": {
488-
"exclude_from_docs": true,
489484
"config_scope": "cluster"
490485
},
491486
"cloud_topics_produce_upload_interval": {
492-
"exclude_from_docs": true,
493487
"config_scope": "cluster"
494488
},
495489
"cloud_topics_reconciliation_interval": {
496-
"exclude_from_docs": true,
497490
"config_scope": "cluster"
498491
},
499492
"cluster_id": {
@@ -1678,8 +1671,8 @@
16781671
"xref:reference:rpk/rpk-topic/rpk-topic-describe.adoc[`rpk topic describe`]",
16791672
"xref:reference:rpk/rpk-topic/rpk-topic-alter-config.adoc[`rpk topic alter-config`]",
16801673
"xref:reference:properties/cluster-properties.adoc#default_topic_replication[`default_topic_replication`]",
1681-
"xref:develop:config-topics.adoc#choose-the-replication-factor[Choose the replication factor]",
1682-
"xref:develop:config-topics.adoc#change-the-replication-factor[Change the replication factor]",
1674+
"xref:develop:manage-topics.adoc#choose-the-replication-factor[Choose the replication factor]",
1675+
"xref:develop:manage-topics.adoc#change-the-replication-factor[Change the replication factor]",
16831676
"xref:reference:properties/cluster-properties.adoc#default_topic_replication[default_topic_replication]"
16841677
],
16851678
"config_scope": "topic"
@@ -2060,7 +2053,7 @@
20602053
"write.caching": {
20612054
"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 <<flushms, `flush.ms`>> and <<flushbytes, `flush.bytes`>>, whichever is reached first.",
20622055
"related_topics": [
2063-
"xref:develop:config-topics.adoc#configure-write-caching[Write caching]",
2056+
"xref:develop:manage-topics.adoc#configure-write-caching[Write caching]",
20642057
"xref:manage:tiered-storage.adoc[Tiered Storage]",
20652058
"xref:reference:properties/cluster-properties.adoc#write_caching_default[`write_caching_default`]",
20662059
"xref:cluster-properties.adoc#write_caching_default[`write_caching_default`]"
@@ -2070,7 +2063,7 @@
20702063
"write_caching_default": {
20712064
"related_topics": [
20722065
"xref:reference:properties/topic-properties.adoc#writecaching[`write.caching`]",
2073-
"xref:develop:config-topics.adoc#configure-write-caching[Write caching]"
2066+
"xref:develop:manage-topics.adoc#configure-write-caching[Write caching]"
20742067
],
20752068
"config_scope": "cluster",
20762069
"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."

modules/manage/pages/disaster-recovery/shadowing/overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Shadowing for disaster recovery currently has the following limitations:
4747

4848
To ensure reliable disaster recovery with Shadowing:
4949

50-
* **Avoid write caching on source topics**: Do not shadow source topics that have xref:develop:config-topics.adoc#configure-write-caching[write caching] enabled. Write caching can result in data loss on the source cluster during broker resets, causing cluster divergence if shadow links replicate data before it's lost on the source.
50+
* **Avoid write caching on source topics**: Do not shadow source topics that have xref:develop:manage-topics.adoc#configure-write-caching[write caching] enabled. Write caching can result in data loss on the source cluster during broker resets, causing cluster divergence if shadow links replicate data before it's lost on the source.
5151

5252
* **Do not modify shadow topic properties**: Avoid modifying synced topic properties on shadow topics, as these properties automatically revert to source topic values.
5353

modules/reference/attachments/redpanda-properties-v25.3.1.json

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3207,7 +3207,6 @@
32073207
"default": false,
32083208
"defined_in": "src/v/config/configuration.cc",
32093209
"description": "Disables the cloud topics reconciliation loop. Disabling the loop can negatively impact performance and stability of the cluster.",
3210-
"exclude_from_docs": true,
32113210
"is_deprecated": false,
32123211
"is_enterprise": false,
32133212
"name": "cloud_topics_disable_reconciliation_loop",
@@ -3233,7 +3232,6 @@
32333232
"enterprise_value": [
32343233
"true"
32353234
],
3236-
"exclude_from_docs": true,
32373235
"is_deprecated": false,
32383236
"is_enterprise": true,
32393237
"name": "cloud_topics_enabled",
@@ -3253,7 +3251,6 @@
32533251
"default_human_readable": "5 minutes",
32543252
"defined_in": "src/v/config/configuration.cc",
32553253
"description": "Time interval after which data is garbage collected from long term storage.",
3256-
"exclude_from_docs": true,
32573254
"is_deprecated": false,
32583255
"is_enterprise": false,
32593256
"maximum": 17592186044415,
@@ -3274,7 +3271,6 @@
32743271
"default": 4194304,
32753272
"defined_in": "src/v/config/configuration.cc",
32763273
"description": "The size limit for the object size in cloud topics. When the amount of data on a shard reaches this limit, an upload is triggered.",
3277-
"exclude_from_docs": true,
32783274
"is_deprecated": false,
32793275
"is_enterprise": false,
32803276
"name": "cloud_topics_produce_batching_size_threshold",
@@ -3293,7 +3289,6 @@
32933289
"default": 1000,
32943290
"defined_in": "src/v/config/configuration.cc",
32953291
"description": "Threshold for the object cardinality in cloud topics. When the number of partitions in waiting for the upload reach this limit, an upload is triggered.",
3296-
"exclude_from_docs": true,
32973292
"is_deprecated": false,
32983293
"is_enterprise": false,
32993294
"name": "cloud_topics_produce_cardinality_threshold",
@@ -3313,7 +3308,6 @@
33133308
"default_human_readable": "250 milliseconds",
33143309
"defined_in": "src/v/config/configuration.cc",
33153310
"description": "Time interval after which the upload is triggered.",
3316-
"exclude_from_docs": true,
33173311
"is_deprecated": false,
33183312
"is_enterprise": false,
33193313
"maximum": 17592186044415,
@@ -3335,7 +3329,6 @@
33353329
"default_human_readable": "10 seconds",
33363330
"defined_in": "src/v/config/configuration.cc",
33373331
"description": "Time interval after which data is moved from short term storage to long term storage.",
3338-
"exclude_from_docs": true,
33393332
"is_deprecated": false,
33403333
"is_enterprise": false,
33413334
"maximum": 17592186044415,
@@ -11319,8 +11312,8 @@
1131911312
"xref:reference:rpk/rpk-topic/rpk-topic-describe.adoc[`rpk topic describe`]",
1132011313
"xref:reference:rpk/rpk-topic/rpk-topic-alter-config.adoc[`rpk topic alter-config`]",
1132111314
"xref:reference:properties/cluster-properties.adoc#default_topic_replication[`default_topic_replication`]",
11322-
"xref:develop:config-topics.adoc#choose-the-replication-factor[Choose the replication factor]",
11323-
"xref:develop:config-topics.adoc#change-the-replication-factor[Change the replication factor]",
11315+
"xref:develop:manage-topics.adoc#choose-the-replication-factor[Choose the replication factor]",
11316+
"xref:develop:manage-topics.adoc#change-the-replication-factor[Change the replication factor]",
1132411317
"xref:reference:properties/cluster-properties.adoc#default_topic_replication[default_topic_replication]"
1132511318
],
1132611319
"type": "integer"
@@ -13693,7 +13686,7 @@
1369313686
"name": "write.caching",
1369413687
"needs_restart": false,
1369513688
"related_topics": [
13696-
"xref:develop:config-topics.adoc#configure-write-caching[Write caching]",
13689+
"xref:develop:manage-topics.adoc#configure-write-caching[Write caching]",
1369713690
"xref:manage:tiered-storage.adoc[Tiered Storage]",
1369813691
"xref:reference:properties/cluster-properties.adoc#write_caching_default[`write_caching_default`]",
1369913692
"xref:cluster-properties.adoc#write_caching_default[`write_caching_default`]"
@@ -13723,7 +13716,7 @@
1372313716
"nullable": false,
1372413717
"related_topics": [
1372513718
"xref:reference:properties/topic-properties.adoc#writecaching[`write.caching`]",
13726-
"xref:develop:config-topics.adoc#configure-write-caching[Write caching]"
13719+
"xref:develop:manage-topics.adoc#configure-write-caching[Write caching]"
1372713720
],
1372813721
"type": "string",
1372913722
"visibility": "user"

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

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -860,7 +860,6 @@ endif::[]
860860

861861
// end::redpanda-cloud[]
862862

863-
// tag::exclude-from-docs[]
864863
=== cloud_topics_disable_reconciliation_loop
865864

866865
Disables the cloud topics reconciliation loop. Disabling the loop can negatively impact performance and stability of the cluster.
@@ -901,9 +900,7 @@ endif::[]
901900

902901
|===
903902

904-
// end::exclude-from-docs[]
905903

906-
// tag::exclude-from-docs[]
907904
=== cloud_topics_enabled
908905

909906
Enable cloud topics.
@@ -954,9 +951,7 @@ endif::[]
954951

955952
|===
956953

957-
// end::exclude-from-docs[]
958954

959-
// tag::exclude-from-docs[]
960955
=== cloud_topics_long_term_garbage_collection_interval
961956

962957
Time interval after which data is garbage collected from long term storage.
@@ -1000,9 +995,7 @@ endif::[]
1000995

1001996
|===
1002997

1003-
// end::exclude-from-docs[]
1004998

1005-
// tag::exclude-from-docs[]
1006999
=== cloud_topics_produce_batching_size_threshold
10071000

10081001
The size limit for the object size in cloud topics. When the amount of data on a shard reaches this limit, an upload is triggered.
@@ -1043,9 +1036,7 @@ endif::[]
10431036

10441037
|===
10451038

1046-
// end::exclude-from-docs[]
10471039

1048-
// tag::exclude-from-docs[]
10491040
=== cloud_topics_produce_cardinality_threshold
10501041

10511042
Threshold for the object cardinality in cloud topics. When the number of partitions in waiting for the upload reach this limit, an upload is triggered.
@@ -1086,9 +1077,7 @@ endif::[]
10861077

10871078
|===
10881079

1089-
// end::exclude-from-docs[]
10901080

1091-
// tag::exclude-from-docs[]
10921081
=== cloud_topics_produce_upload_interval
10931082

10941083
Time interval after which the upload is triggered.
@@ -1132,9 +1121,7 @@ endif::[]
11321121

11331122
|===
11341123

1135-
// end::exclude-from-docs[]
11361124

1137-
// tag::exclude-from-docs[]
11381125
=== cloud_topics_reconciliation_interval
11391126

11401127
Time interval after which data is moved from short term storage to long term storage.
@@ -1178,7 +1165,6 @@ endif::[]
11781165

11791166
|===
11801167

1181-
// end::exclude-from-docs[]
11821168

11831169
=== cluster_id
11841170

@@ -19472,7 +19458,7 @@ endif::[]
1947219458
|
1947319459
* xref:reference:properties/topic-properties.adoc#writecaching[`write.caching`]
1947419460

19475-
* xref:develop:config-topics.adoc#configure-write-caching[Write caching]
19461+
* xref:develop:manage-topics.adoc#configure-write-caching[Write caching]
1947619462

1947719463
|===
1947819464

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1686,9 +1686,9 @@ endif::[]
16861686

16871687
* xref:reference:properties/cluster-properties.adoc#default_topic_replication[`default_topic_replication`]
16881688

1689-
* xref:develop:config-topics.adoc#choose-the-replication-factor[Choose the replication factor]
1689+
* xref:develop:manage-topics.adoc#choose-the-replication-factor[Choose the replication factor]
16901690

1691-
* xref:develop:config-topics.adoc#change-the-replication-factor[Change the replication factor]
1691+
* xref:develop:manage-topics.adoc#change-the-replication-factor[Change the replication factor]
16921692

16931693
* xref:reference:properties/cluster-properties.adoc#default_topic_replication[default_topic_replication]
16941694

@@ -2050,7 +2050,7 @@ endif::[]
20502050

20512051
| Related topics
20522052
|
2053-
* xref:develop:config-topics.adoc#configure-write-caching[Write caching]
2053+
* xref:develop:manage-topics.adoc#configure-write-caching[Write caching]
20542054

20552055
* xref:manage:tiered-storage.adoc[Tiered Storage]
20562056

0 commit comments

Comments
 (0)