auto-docs: Update property docs for tag v26.1.4#1666
auto-docs: Update property docs for tag v26.1.4#1666vbotbuildovich wants to merge 3 commits intomainfrom
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. 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:
📝 WalkthroughWalkthroughThis pull request updates version metadata and configuration property defaults from v26.1.2 to v26.1.4 across documentation and configuration files. Changes include: updating Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 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 |
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![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 | 🟠 MajorDefault value note conflicts with the new default
The section now sets
max_concurrent_producer_idsdefault to100000(Line 13068), but the note still says “default value is unlimited” (Line 13048). Please update the note so it matches the new default behavior.Suggested doc fix
-IMPORTANT: 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. +IMPORTANT: A high value 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. Tune this limit for your deployment.🤖 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, Update the paragraph that currently states “The default value is unlimited” to reflect the new default of 100000 for the property max_concurrent_producer_ids; specifically, change the note to say that the default is 100000 (not unlimited) and keep the caution that a higher value can cause unbounded memory growth and OOMs in heavy producer/transactional workloads, advising operators to set a reasonable limit in production. Reference the property name max_concurrent_producer_ids and ensure the surrounding text and any conditional blocks (env-cloud/ifndef::env-cloud[]) remain consistent with the new default 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.4.json`:
- Around line 9433-9435: Update the description string for the "Maximum number
of active producer sessions per shard" property (the JSON entry whose
description begins "Maximum number of active producer sessions per shard...") to
reflect the new default of 100000 instead of saying "The default value is
unlimited"; explicitly state the current default is 100000 and retain the
warning about memory growth/OOM and guidance to set a reasonable limit in
production. Ensure the updated description mentions the upgrade note about
23.2.x→23.3.x and the per-shard change remains accurate.
---
Outside diff comments:
In `@modules/reference/partials/properties/cluster-properties.adoc`:
- Around line 13048-13068: Update the paragraph that currently states “The
default value is unlimited” to reflect the new default of 100000 for the
property max_concurrent_producer_ids; specifically, change the note to say that
the default is 100000 (not unlimited) and keep the caution that a higher value
can cause unbounded memory growth and OOMs in heavy producer/transactional
workloads, advising operators to set a reasonable limit in production. Reference
the property name max_concurrent_producer_ids and ensure the surrounding text
and any conditional blocks (env-cloud/ifndef::env-cloud[]) remain consistent
with the new default 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: 432eeb04-5b23-46b2-9801-a170f5077fe9
📒 Files selected for processing (4)
antora.ymldocs-data/redpanda-property-changes-v26.1.2-to-v26.1.4.jsonmodules/reference/attachments/redpanda-properties-v26.1.4.jsonmodules/reference/partials/properties/cluster-properties.adoc
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
@bharathv please confirm if these changes are correct. Do we want to call out this change in our release notes? |
lgtm. Yes this needs a call out. |
3 participants
This PR auto-generates updated Redpanda property documentation for v26.1.4.