auto-docs: Update property docs for tag v26.1.3#1664
auto-docs: Update property docs for tag v26.1.3#1664vbotbuildovich wants to merge 1 commit intomainfrom
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis PR updates Redpanda documentation version metadata from 26.1.2 to 26.1.3 and establishes explicit numeric default values for two cluster properties: Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
modules/reference/partials/properties/cluster-properties.adoc (1)
13048-13068:⚠️ Potential issue | 🟠 Major
max_concurrent_producer_idsdescription now contradicts its documented default.Line 13068 sets the default to
100000, but the warning text still says the default is unlimited. Please update the description in the generation source so the warning reflects the new default value.Based on learnings: update property documentation via
docs-data/property-overrides.json, and avoid direct manual edits inmodules/reference/partials/properties/because those files are auto-generated.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/reference/partials/properties/cluster-properties.adoc` around lines 13048 - 13068, The docs warning for the property max_concurrent_producer_ids incorrectly states the default is "unlimited" while the generated doc shows `100000`; update the generation source by editing docs-data/property-overrides.json to change the warning/description for max_concurrent_producer_ids to reflect the actual default of 100000 (and remove or adjust the "unlimited" wording), then re-run the docs generation so modules/reference/partials/properties/* is regenerated with the corrected description.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@modules/reference/attachments/redpanda-properties-v26.1.3.json`:
- Around line 9433-9435: The description for the "Maximum number of active
producer sessions per shard" property conflicts with its JSON default (JSON key
"default": 100000) by saying the default is "unlimited"; update the property's
description to reflect the actual default value (100000) and remove or correct
the sentence that states the default is unlimited, or regenerate the property
docs from the corrected property-overrides source that drives the
auto-generation so the description and the "default" field are consistent.
---
Outside diff comments:
In `@modules/reference/partials/properties/cluster-properties.adoc`:
- Around line 13048-13068: The docs warning for the property
max_concurrent_producer_ids incorrectly states the default is "unlimited" while
the generated doc shows `100000`; update the generation source by editing
docs-data/property-overrides.json to change the warning/description for
max_concurrent_producer_ids to reflect the actual default of 100000 (and remove
or adjust the "unlimited" wording), then re-run the docs generation so
modules/reference/partials/properties/* is regenerated with the corrected
description.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 27bf215c-a90b-498c-8ce4-486a08c747bb
📒 Files selected for processing (4)
antora.ymldocs-data/redpanda-property-changes-v26.1.2-to-v26.1.3.jsonmodules/reference/attachments/redpanda-properties-v26.1.3.jsonmodules/reference/partials/properties/cluster-properties.adoc
| "default": 100000, | ||
| "defined_in": "src/v/config/configuration.cc", | ||
| "description": "Maximum number of active producer sessions per shard. Each shard tracks producer IDs using an LRU (Least Recently Used) eviction policy. When the configured limit is exceeded, the least recently used producer IDs are evicted from the cache.\n\nIf you upgrade from 23.2.x to 23.3.x and encounter `OUT_OF_SEQUENCE` errors, consider increasing this value. In 23.3.x, the configuration changed from a per-partition basis to a per-shard basis.\n\nIMPORTANT: The default value is unlimited, which can lead to unbounded memory growth and out-of-memory (OOM) crashes in production environments with heavy producer usage, especially when using transactions or idempotent producers. Set a reasonable limit in production deployments.", |
There was a problem hiding this comment.
Default value now conflicts with its own description.
At Line 9433, the default is 100000, but Line 9435 still says the default is unlimited. Please update the description to match the new default, or regenerate from corrected source overrides, to avoid misleading operators.
🛠 Suggested doc fix
- "description": "... IMPORTANT: The default value is unlimited, which can lead to unbounded memory growth ..."
+ "description": "... IMPORTANT: The default value is `100000`. In high producer-churn environments, tune this value to avoid memory pressure ..."Based on learnings: Update /docs-data/property-overrides.json to make changes to property documentation - this is the file that drives auto-generation of property reference pages.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@modules/reference/attachments/redpanda-properties-v26.1.3.json` around lines
9433 - 9435, The description for the "Maximum number of active producer sessions
per shard" property conflicts with its JSON default (JSON key "default": 100000)
by saying the default is "unlimited"; update the property's description to
reflect the actual default value (100000) and remove or correct the sentence
that states the default is unlimited, or regenerate the property docs from the
corrected property-overrides source that drives the auto-generation so the
description and the "default" field are consistent.
1 participant
This PR auto-generates updated Redpanda property documentation for v26.1.3.