Add missing properties in reference #1353
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThe Topic Properties reference was updated to add and clarify several properties:
Sequence Diagram(s)sequenceDiagram
autonumber
actor Producer
participant Broker as Redpanda Broker
participant Obj as Object Storage
rect rgb(245,245,250)
note over Broker: Tiered Storage upload paused
Producer->>Broker: Produce messages
alt redpanda.remote.allowgaps=false (default)
Broker->>Obj: Upload completed segments (when possible)
note over Broker: Evict only uploaded data
Broker-->>Producer: Throttle if local target would overflow
else redpanda.remote.allowgaps=true
note over Broker: May evict local segments not yet uploaded
note over Broker: Potential offset gaps locally
Broker-->>Producer: Continue (reduced throttling)
end
end
sequenceDiagram
autonumber
actor Producer
participant Broker as Redpanda Broker
participant SR as Schema Registry
rect rgb(245,245,250)
note over Broker: Server-side schema ID validation (new props)
Producer->>Broker: Produce(record with key/value schemas)
alt key schema validation enabled
Broker->>SR: Validate key schema ID (subject strategy)
SR-->>Broker: OK/Fail
end
alt value schema validation enabled
Broker->>SR: Validate value schema ID (subject strategy)
SR-->>Broker: OK/Fail
end
opt confluent.* aliases
note over Broker: Mapped to redpanda.* validation/strategy
end
Broker-->>Producer: Ack or Error
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10–15 minutes Possibly related PRs
Suggested reviewers
Pre-merge checks (4 passed, 1 warning)❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Pre-merge checks (4 passed, 1 warning)❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing touches
🧪 Generate unit tests
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 |
paulohtb6
commented
Sep 11, 2025
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
modules/reference/pages/properties/topic-properties.adoc (1)
763-887: Schema validation properties look good; tighten cross-references and confirm accepted values.
- Convert inline property mentions to cross-refs for easier navigation.
- Confirm the subject-name strategy value lists are exhaustive for both Redpanda and Confluent aliases.
Apply this diff to add cross-refs:
-=== redpanda.key.subject.name.strategy +=== redpanda.key.subject.name.strategy @@ -The subject name strategy for keys when `redpanda.key.schema.id.validation` is enabled. +The subject name strategy for keys when <<redpandakeyschemavalidation,`redpanda.key.schema.id.validation`>> is enabled. @@ -=== redpanda.value.subject.name.strategy +=== redpanda.value.subject.name.strategy @@ -The subject name strategy for values when `redpanda.value.schema.id.validation` is enabled. +The subject name strategy for values when <<redpandavalueschemavalidation,`redpanda.value.schema.id.validation`>> is enabled. @@ -=== confluent.key.subject.name.strategy +=== confluent.key.subject.name.strategy @@ -The subject name strategy for keys when `confluent.key.schema.validation` is enabled. +The subject name strategy for keys when <<confluentkeyschemavalidation,`confluent.key.schema.validation`>> is enabled. @@ -=== confluent.value.subject.name.strategy +=== confluent.value.subject.name.strategy @@ -The subject name strategy for values when `confluent.value.schema.validation` is enabled. +The subject name strategy for values when <<confluentvalueschemavalidation,`confluent.value.schema.validation`>> is enabled.To verify accepted values and defaults against current product behavior, please confirm with engineering or latest docs. If helpful, I can draft a web query.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
modules/reference/pages/properties/topic-properties.adoc(2 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: Feediver1
PR: redpanda-data/docs#1153
File: modules/reference/pages/properties/topic-properties.adoc:45-50
Timestamp: 2025-07-16T19:33:20.420Z
Learning: In the Redpanda documentation, topic property cross-references like <<max.compaction.lag.ms>> and <<min.compaction.lag.ms>> require corresponding property definition sections with anchors like [[maxcompactionlagms]] and [[mincompactionlagms]] to prevent broken links.
📚 Learning: 2025-07-16T19:33:20.420Z
Learnt from: Feediver1
PR: redpanda-data/docs#1153
File: modules/reference/pages/properties/topic-properties.adoc:45-50
Timestamp: 2025-07-16T19:33:20.420Z
Learning: In the Redpanda documentation, topic property cross-references like <<max.compaction.lag.ms>> and <<min.compaction.lag.ms>> require corresponding property definition sections with anchors like [[maxcompactionlagms]] and [[mincompactionlagms]] to prevent broken links.
Applied to files:
modules/reference/pages/properties/topic-properties.adoc
🔇 Additional comments (2)
modules/reference/pages/properties/topic-properties.adoc (2)
760-761: LGTM: Added related topic for Iceberg lag property.Minor doc improvement; no issues.
889-889: Remove dangling bullet and add two missing topic properties
- Remove the dangling bullet in modules/reference/pages/properties/topic-properties.adoc (line ~889). Apply diff:
-- Virtual cluster functionality (requires enabling multiplexing extensions)
Add full sections (with anchors, Type, Default, description, and any cluster-property mappings) for:
- redpanda.virtual.cluster.id
- redpanda.cloud_topic.enabled
Note: I did not find these two properties in topic-properties.adoc. cluster-properties.adoc contains a related flag development_enable_cloud_topics (modules/reference/pages/properties/cluster-properties.adoc:1232,1234) and mentions cloud-topic retention at :5246 — confirm whether redpanda.cloud_topic.enabled should map to that entry and provide authoritative names, defaults, and any constraints (e.g., “requires multiplexing extensions”). I will draft the two sections once you confirm those details.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Resolves https://redpandadata.atlassian.net/browse/DOC-1647
Review deadline: 15th Sept
Page previews
https://deploy-preview-1353--redpanda-docs-preview.netlify.app/current/reference/properties/topic-properties/
Checks