Skip to content

auto-docs: Update property docs for tag v26.1.9 #1711

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
Open

auto-docs: Update property docs for tag v26.1.9 #1711

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.8
latest-redpanda-tag: 'v26.1.8'
full-version: 26.1.9
latest-redpanda-tag: 'v26.1.9'
latest-console-tag: 'v3.3.1'
latest-release-commit: 'ebee215fdb2b8004735c6f800e532564cdcc05e1'
latest-operator-version: 'v2.3.8-24.3.6'
Expand Down
3 changes: 3 additions & 0 deletions docs-data/property-overrides.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -879,6 +879,9 @@
"description": "Enable creating shadow links from this cluster to a remote source cluster for data replication.",
"config_scope": "cluster"
},
"features_auto_finalization": {
"version": "v26.1.9"
},
"fetch_max_read_concurrency": {
"version": "v25.3.3"
},
Expand Down
43 changes: 0 additions & 43 deletions docs-data/redpanda-property-changes-v26.1.7-to-v26.1.8.json
View file
Open in desktop

This file was deleted.

43 changes: 43 additions & 0 deletions docs-data/redpanda-property-changes-v26.1.8-to-v26.1.9.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"comparison": {
"oldVersion": "v26.1.8",
"newVersion": "v26.1.9",
"timestamp": "2026-05-22T12:46:58.695Z"
},
"summary": {
"newProperties": 1,
"changedDefaults": 0,
"changedDescriptions": 0,
"changedTypes": 0,
"deprecatedProperties": 0,
"removedDeprecatedProperties": 0,
"removedProperties": 0,
"emptyDescriptions": 2
},
"details": {
"newProperties": [
{
"name": "features_auto_finalization",
"type": "boolean",
"default": true,
"description": "Whether the cluster active logical version is advanced automatically once all nodes have been upgraded (true), or only in response to an explicit request via the Admin API (false). When false, the cluster remains able to downgrade to the previous version until finalization is requested. Setting this to false is an Enterprise feature and requires a valid license. Note: if upgrade was performed with this set to false and the cluster is ready to finalize, flipping this to true does not reliably trigger finalization. Leave this set to false and use the Admin API to finalize; once the upgrade is complete this can be set back to true to restore automatic finalization for future upgrades."
}
],
"changedDefaults": [],
"changedDescriptions": [],
"changedTypes": [],
"deprecatedProperties": [],
"removedDeprecatedProperties": [],
"removedProperties": [],
"emptyDescriptions": [
{
"name": "redpanda.remote.allowgaps",
"type": "boolean"
},
{
"name": "redpanda.virtual.cluster.id",
"type": "string"
}
]
}
}
26 changes: 26 additions & 0 deletions ...achments/redpanda-properties-v26.1.8.json → ...achments/redpanda-properties-v26.1.9.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6177,6 +6177,31 @@
"type": "boolean",
"visibility": "tunable"
},
"features_auto_finalization": {
"c_type": "bool",
"cloud_byoc_only": false,
"cloud_editable": false,
"cloud_readonly": false,
"cloud_supported": false,
"config_scope": "cluster",
"default": true,
"defined_in": "src/v/config/configuration.cc",
"description": "Whether the cluster active logical version is advanced automatically once all nodes have been upgraded (true), or only in response to an explicit request via the Admin API (false). When false, the cluster remains able to downgrade to the previous version until finalization is requested. Setting this to false is an Enterprise feature and requires a valid license. Note: if upgrade was performed with this set to false and the cluster is ready to finalize, flipping this to true does not reliably trigger finalization. Leave this set to false and use the Admin API to finalize; once the upgrade is complete this can be set back to true to restore automatic finalization for future upgrades.",
"enterprise_constructor": "restricted_only",
"enterprise_restricted_value": [
"false"
],
"enterprise_value": [
"false"
],
"is_deprecated": false,
"is_enterprise": true,
"name": "features_auto_finalization",
"needs_restart": false,
"nullable": false,
"type": "boolean",
"visibility": "user"
},
"fetch_max_bytes": {
"c_type": "size_t",
"cloud_byoc_only": false,
Expand Down Expand Up @@ -7190,6 +7215,7 @@
"needs_restart": true,
"nullable": true,
"type": "string",
"version": "v26.1.8",
"visibility": "user"
},
"iceberg_rest_catalog_credentials_source": {
Expand Down
55 changes: 55 additions & 0 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 @@ -6266,6 +6266,57 @@ endif::[]
|===


=== features_auto_finalization

Whether the cluster active logical version is advanced automatically once all nodes have been upgraded (true), or only in response to an explicit request via the Admin API (false). When false, the cluster remains able to downgrade to the previous version until finalization is requested. Setting this to false is an Enterprise feature and requires a valid license. Note: if upgrade was performed with this set to false and the cluster is ready to finalize, flipping this to true does not reliably trigger finalization. Leave this set to false and use the Admin API to finalize; once the upgrade is complete this can be set back to true to restore automatic finalization for future upgrades.
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 22, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Remove license metadata from the behavior description

Line 6271 mixes behavioral guidance with licensing metadata. Keep the description behavior-focused and rely on the existing license note block below.

Proposed fix 
-Whether the cluster active logical version is advanced automatically once all nodes have been upgraded (true), or only in response to an explicit request via the Admin API (false). When false, the cluster remains able to downgrade to the previous version until finalization is requested. Setting this to false is an Enterprise feature and requires a valid license. Note: if upgrade was performed with this set to false and the cluster is ready to finalize, flipping this to true does not reliably trigger finalization. Leave this set to false and use the Admin API to finalize; once the upgrade is complete this can be set back to true to restore automatic finalization for future upgrades.
+Whether the cluster active logical version is advanced automatically once all nodes have been upgraded (true), or only in response to an explicit request via the Admin API (false). When false, the cluster remains able to downgrade to the previous version until finalization is requested. Note: if upgrade was performed with this set to false and the cluster is ready to finalize, flipping this to true does not reliably trigger finalization. Leave this set to false and use the Admin API to finalize; once the upgrade is complete this can be set back to true to restore automatic finalization for future upgrades.

As per coding guidelines, "In property descriptions, keep descriptions focused on behavior and avoid metadata information like version availability, cloud availability, license requirements, requires restart status, default values, and type information".

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Whether the cluster active logical version is advanced automatically once all nodes have been upgraded (true), or only in response to an explicit request via the Admin API (false). When false, the cluster remains able to downgrade to the previous version until finalization is requested. Setting this to false is an Enterprise feature and requires a valid license. Note: if upgrade was performed with this set to false and the cluster is ready to finalize, flipping this to true does not reliably trigger finalization. Leave this set to false and use the Admin API to finalize; once the upgrade is complete this can be set back to true to restore automatic finalization for future upgrades.
Whether the cluster active logical version is advanced automatically once all nodes have been upgraded (true), or only in response to an explicit request via the Admin API (false). When false, the cluster remains able to downgrade to the previous version until finalization is requested. Note: if upgrade was performed with this set to false and the cluster is ready to finalize, flipping this to true does not reliably trigger finalization. Leave this set to false and use the Admin API to finalize; once the upgrade is complete this can be set back to true to restore automatic finalization for future upgrades.
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@modules/reference/partials/properties/cluster-properties.adoc` at line 6271,
Remove license/entitlement metadata from the property description that starts
"Whether the cluster active logical version is advanced automatically..." by
deleting the sentence "Setting this to false is an Enterprise feature and
requires a valid license." and any similar licensing phrasing; keep only
behavior-focused guidance (including the note about finalization behavior), and
rely on the existing separate license note block below to document licensing
requirements.


ifndef::env-cloud[]
.Enterprise license required
[NOTE]
====
The following values require an Enterprise license: `false`

For license details, see xref:get-started:licensing/index.adoc[Redpanda Licensing].
====
endif::[]

[cols="1s,2a"]
|===
| Property | Value

| Type
| `boolean`



| Default
|
ifdef::env-cloud[]
Available in the Redpanda Cloud Console
endif::[]
ifndef::env-cloud[]
`true`
endif::[]

| Nullable
| No

| Requires restart
| No

ifndef::env-cloud[]
| Restored on xref:manage:whole-cluster-restore.adoc[Whole Cluster Restore]
| Yes
endif::[]

ifndef::env-cloud[]
| Visibility
| User
endif::[]

|===


=== fetch_max_bytes

Maximum number of bytes returned in a fetch request.
Expand Down Expand Up @@ -8378,6 +8429,10 @@ endif::[]

=== iceberg_rest_catalog_credentials_host

ifndef::env-cloud[]
*Introduced in v26.1.8*
endif::[]

The hostname to connect to for retrieving role based credentials for the Iceberg REST catalog. Derived from iceberg_rest_catalog_credentials_source if not set. Only required when using IAM role based access on AWS; does not apply to OAuth-based authentication schemes. Independent of cloud_storage_credentials_host.

[cols="1s,2a"]
Expand Down
Loading