Skip to content

auto-docs: Update property docs for tag v26.1.3 #1664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vbotbuildovich wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −11
Open

auto-docs: Update property docs for tag v26.1.3 #1664

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions antora.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ asciidoc:
# Fallback versions
# We try to fetch the latest versions from GitHub at build time
# --
full-version: 26.1.2
latest-redpanda-tag: 'v26.1.2'
full-version: 26.1.3
latest-redpanda-tag: 'v26.1.3'
latest-console-tag: 'v3.3.1'
latest-release-commit: '35a825c9c1880ebeedf4c18bb8c6cceaa63566c1'
latest-operator-version: 'v2.3.8-24.3.6'
Expand Down
21 changes: 16 additions & 5 deletions ...-property-changes-v26.1.1-to-v26.1.2.json → ...-property-changes-v26.1.2-to-v26.1.3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"comparison": {
"oldVersion": "v26.1.1",
"newVersion": "v26.1.2",
"timestamp": "2026-04-03T17:46:32.769Z"
"oldVersion": "v26.1.2",
"newVersion": "v26.1.3",
"timestamp": "2026-04-10T13:31:18.169Z"
},
"summary": {
"newProperties": 0,
"changedDefaults": 0,
"changedDefaults": 2,
"changedDescriptions": 0,
"changedTypes": 0,
"deprecatedProperties": 0,
Expand All @@ -16,7 +16,18 @@
},
"details": {
"newProperties": [],
"changedDefaults": [],
"changedDefaults": [
{
"name": "max_concurrent_producer_ids",
"oldDefault": "Maximum value",
"newDefault": 100000
},
{
"name": "max_transactions_per_coordinator",
"oldDefault": "Maximum value",
"newDefault": 10000
}
],
"changedDescriptions": [],
"changedTypes": [],
"deprecatedProperties": [],
Expand Down
4 changes: 2 additions & 2 deletions ...achments/redpanda-properties-v26.1.2.json → ...achments/redpanda-properties-v26.1.3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9430,7 +9430,7 @@
"cloud_readonly": false,
"cloud_supported": false,
"config_scope": "cluster",
"default": "Maximum value",
"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.",
Comment on lines +9433 to 9435
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

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.

"is_deprecated": false,
Expand Down Expand Up @@ -9512,7 +9512,7 @@
"cloud_readonly": false,
"cloud_supported": false,
"config_scope": "cluster",
"default": "Maximum value",
"default": 10000,
"defined_in": "src/v/config/configuration.cc",
"description": "Specifies the maximum number of active transaction sessions per coordinator. When the threshold is passed Redpanda terminates old sessions. When an idle producer corresponding to the terminated session wakes up and produces, it leads to its batches being rejected with invalid producer epoch or invalid_producer_id_mapping error (depends on the transaction execution phase).\n\nFor details, see xref:develop:transactions#transaction-usage-tips[Transaction usage tips].",
"is_deprecated": false,
Expand Down
4 changes: 2 additions & 2 deletions modules/reference/partials/properties/cluster-properties.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13065,7 +13065,7 @@ ifdef::env-cloud[]
Available in the Redpanda Cloud Console
endif::[]
ifndef::env-cloud[]
`Maximum value`
`100000`
endif::[]

| Nullable
Expand Down Expand Up @@ -13248,7 +13248,7 @@ ifdef::env-cloud[]
Available in the Redpanda Cloud Console
endif::[]
ifndef::env-cloud[]
`Maximum value`
`10000`
endif::[]

| Nullable
Expand Down
Loading