Update Properties with the latest in v26.1#1581
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
So many of these indicate they were added in 25.3. I suspect most of the remaining ones are specific to 26.1. The tricky part here--given that no doc went out for Cloud Topics in 25.3, I think it might be confusing for users to see that and then find nothing in the 25.3 docs for Cloud Topics. I'll ask @mattschumpert about this today @paulohtb6. |
|
Also note that Cloud Topics requires an enterprise license, so should be "Cloud Topics". |
|
We should consider all cloud topics properties as 'new' for 26.1 (even if added in 25.3) because for everybody except 1-2 private beta customers, they are new. We could also throw the 25.3 ones into the cloud topics 25.3 private beta doc if its easy, but not the property refernece of course. |
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
- Add all Cloud Topics properties (25 total) to address Matt's comment that all Cloud Topics properties should be considered "new" for 26.1 - Add Enterprise license requirement note for Cloud Topics - Capitalize "Cloud Topics" per Feediver's feedback - Add Object storage section with cloud_storage_prefetch_segments_max - Improve property descriptions for brevity and clarity
Resolve conflicts by placing feature sections before configuration properties
63458e5 to
0bd3dcf
Compare
Update both storage mode properties in property-overrides.json and the generated property docs to explicitly state that 'if not set explicitly' means when the property value is 'unset': - redpanda.storage.mode (topic property) - default_redpanda_storage_mode (cluster property) Also fix capitalization: 'Tiered Storage' instead of 'tiered storage'.
0bd3dcf to
774942e
Compare
Add 10 Cloud Topics properties that existed in v25.3.x but were in private beta. Per product team guidance (Matt's comment), all Cloud Topics properties should be documented as 'new' for v26.1 since they were only available to 1-2 private beta customers before this release. Added properties from v25.3.x: - cloud_topics_epoch_service_epoch_increment_interval (v25.3.3) - cloud_topics_epoch_service_local_epoch_cache_duration (v25.3.3) - cloud_topics_long_term_garbage_collection_interval - cloud_topics_produce_batching_size_threshold - cloud_topics_produce_cardinality_threshold - cloud_topics_produce_upload_interval - cloud_topics_reconciliation_interval - cloud_topics_short_term_gc_backoff_interval (v25.3.3) - cloud_topics_short_term_gc_interval (v25.3.3) - cloud_topics_short_term_gc_minimum_object_age (v25.3.3) Total Cloud Topics properties now in what's new: 35
Add version tags to property-overrides.json and 'Introduced in' tags to generated cluster-properties.adoc, verified against Redpanda repo: New in v26.1 (32 properties): - 28 Cloud Topics properties (new in v26.1): adaptive reconciliation, compaction, metastore, parallel fetch, and other features - default_redpanda_storage_mode, redpanda.storage.mode - cloud_storage_prefetch_segments_max - delete_topic_enable, internal_rpc_request_timeout_ms - nested_group_behavior, oidc_group_claim_path - partition_autobalancing_node_autodecommission_timeout_sec - schema_registry_enable_qualified_subjects Introduced in v25.3.8: - log_compaction_max_priority_wait_ms Introduced in v25.3.3: - cloud_topics_epoch_service_epoch_increment_interval - cloud_topics_epoch_service_local_epoch_cache_duration - cloud_topics_short_term_gc_backoff_interval - cloud_topics_short_term_gc_interval - cloud_topics_short_term_gc_minimum_object_age
Change all v26.1 version tags to v26.1.1 to follow the convention of always using full patch versions. Updated: - property-overrides.json: 32 properties changed from v26.1 to v26.1.1 - cluster-properties.adoc: 'Introduced in v26.1' changed to 'Introduced in v26.1.1'
Add category: tiered-storage to redpanda.storage.mode in property- overrides.json so it's grouped with other Tiered Storage properties (redpanda.remote.read, redpanda.remote.write, etc.) instead of 'other'. Note: This change requires regenerating property docs to take effect in the generated topic-properties.adoc file.
Add missing version tag to redpanda.storage.mode topic property. Note: This change requires regenerating property docs to add the 'Introduced in v26.1.1' tag to the generated topic-properties.adoc.
No properties were newly deprecated in v26.1.1. The 8 properties listed were actually removed (they had been deprecated before v25.3.1).
…e docs These properties were completely removed from Redpanda in v26.1.1 (not just deprecated), so they should not appear in the deprecated properties list or have reference documentation sections. Removed from deprecated-properties.adoc: 47 properties Removed from cluster-properties.adoc: 45 deprecated sections (2 were broker properties) Remaining deprecated properties: 12 (still exist in v26.1.1 but are deprecated)
Cloud Topics is now documented in v26.1, so these 7 properties should be included in the generated reference documentation: - cloud_topics_disable_reconciliation_loop - cloud_topics_enabled - cloud_topics_long_term_garbage_collection_interval - cloud_topics_produce_batching_size_threshold - cloud_topics_produce_cardinality_threshold - cloud_topics_produce_upload_interval - cloud_topics_reconciliation_interval
Regenerated all property reference documentation to include v26.1.1 properties: - Added 12 Cloud Topics properties that were new in v26.1.1 - Now includes all 39 cloud_topics properties in cluster-properties.adoc - Removed 47 properties that were deleted in v26.1.1 from deprecated list - Updated antora.yml full-version to 26.1.1 and latest-redpanda-tag to v26.1.1-rc5 - Automation auto-added version tags to new properties in property-overrides.json - Preserved exclude_from_docs removals for Cloud Topics properties New cloud_topics properties now documented: - cloud_topics_allow_materialization_failure - cloud_topics_epoch_service_max_same_epoch_duration - cloud_topics_gc_health_check_interval - cloud_topics_long_term_file_deletion_delay - cloud_topics_metastore_lsm_apply_timeout_ms - cloud_topics_metastore_replication_timeout_ms - cloud_topics_num_metastore_partitions - cloud_topics_preregistered_object_ttl - cloud_topics_produce_no_pid_concurrency - cloud_topics_produce_write_inflight_limit - cloud_topics_reconciliation_parallelism - cloud_topics_upload_part_size
Changed version for 5 properties that were auto-tagged by the property automation: - cloud_storage_gc_max_segments_per_run - cloud_topics_disable_level_zero_gc_for_tests - cloud_topics_disable_metastore_flush_loop_for_tests - cloud_topics_epoch_service_max_same_epoch_duration - schema_registry_avro_use_named_references We always use full patch versions without RC suffixes in docs.
Restores the enhanced description for cloud_storage_gc_max_segments_per_run that was previously improved but lost during property docs regeneration. The improved description better explains the rate limiting purpose and API impact. Changes: - Add improved description to property-overrides.json to persist through future regenerations - Update what's new page with more descriptive text and housekeeping link - Update reference documentation with enhanced description and version tag Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Adds the remaining 24 properties that were removed in v26.1.1 (PR #29521) to the "Other removed properties" section. These properties were deprecated placeholders that have been silently ignored and will continue to be ignored after removal, so no user action is required. All 47 removed properties are now documented: - 8 RPC timeout properties (with replacement) - 5 client quota properties (with replacement) - 5 quota balancer properties (with replacement) - 2 timestamp alert properties (with replacement) - 27 other properties (no replacement needed) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Resolved conflicts in property documentation files: - docs-data/property-overrides.json: Kept v26.1.1 version tags - modules/reference/attachments/redpanda-properties-v25.3.11.json: Used improved description from v-WIP/26.1 - modules/reference/partials/properties/*.adoc: Kept generated files with v26.1.1 versions Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Update redpanda.storage.mode description to be clearer and more concise - Fix replication.factor links to use correct path (manage-topics/config-topics.adoc) - Remove exclude_from_docs from redpanda.cloud_topic.enabled Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
modules/reference/partials/properties/object-storage-properties.adoc
Outdated
Show resolved
Hide resolved
docs-data/property-overrides.json
Outdated
| "version": "v26.1.1-rc2" | ||
| "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:manage:tiered-storage.adoc#cloud-topics[cloud topics].", | ||
| "related_topics": [ | ||
| "xref:manage:tiered-storage.adoc[Tiered Storage]" |
There was a problem hiding this comment.
The Manage Cloud Topics page should be a related topic
| * `cloud`: Store data primarily in object storage using xref:manage:tiered-storage.adoc#cloud-topics[cloud topics]. | ||
|
|
||
| This property overrides the cluster-wide config_ref:default_redpanda_storage_mode,true,properties/cluster-properties[] setting for individual topics. | ||
| If not set explicitly (that is, when the property value is `unset`), the topic inherits the cluster-level default from config_ref:default_redpanda_storage_mode,true,properties/cluster-properties[]. |
There was a problem hiding this comment.
Incorrect sentence:
If not set explicitly (that is, when the property value is
unset)...
See my explanation here for why:
Not quite. Explicitly specifying
unsetmeans the topic will beunset. Only if no value is provided forredpanda.storage.modeto the topic creation command is the cluster defaultdefault_redpanda_storage_modeused.Concrete examples to explain the point:
$ rpk cluster config set default_redpanda_storage_mode=local $ rpk topic create topic_a -c redpanda.storage.mode=unset [ topic_a is created with redpanda.storage.mode=unset] $ rpk topic create topic_b [ topic_b is created with redpanda.storage.mode=default_redpanda_storage_mode=local
When the property is unset, the property is unset.
| | | ||
| * xref:manage:tiered-storage.adoc[Tiered Storage] | ||
| * xref:develop:manage-topics/cloud-topics.adoc[Manage Cloud Topics] | ||
| |xref:manage:tiered-storage.adoc[Tiered Storage] |
There was a problem hiding this comment.
Manage Cloud Topics should be a related topic
| **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 |
There was a problem hiding this comment.
superseding the legacy
redpanda.remote.readandredpanda.remote.writeproperties
I'm happy with this language if @mattschumpert is.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Regenerated property partials with updated overrides - Fixed redpanda.storage.mode description (clearer, more concise) - Fixed replication.factor xref links (manage-topics/config-topics.adoc) - Removed exclude_from_docs from redpanda.cloud_topic.enabled - Added full description for cloud_topics_enabled property - Improved redpanda.cloud_topic.enabled with deprecation notice - All 39 cloud_topics cluster properties now documented - Cleaned up old property JSON files (v25.3.11, v26.1.1-rc2) - Cleaned up old diff files Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Property override improvements: - Add longer, detailed descriptions for rps_limit_* properties (rate limits for controller operations) - Fix __consumer_offsets to use backticks in log_compaction_max_priority_wait_ms - Add "Manage Cloud Topics" as related topic to redpanda.storage.mode and default_redpanda_storage_mode - Change redpanda.cloud_topic.enabled from false deprecation notice to helpful TIP pointing to redpanda.storage.mode All property documentation regenerated for v26.1.1-rc5 with corrected overrides. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Description
Redpanda Property Changes: v25.3.7 → v26.1.1-rc5
New Properties (22)
Changed defaults
cloud_topics_reconciliation_intervallog_compaction_tx_batch_removal_enabledtls_v1_2_cipher_suitesPage previews
Cluster properties
Topic properties
What's new
Checks