Skip to content

auto-docs: Update property docs for tag v26.1.7 #1693

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.7 #1693

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.6
latest-redpanda-tag: 'v26.1.6'
full-version: 26.1.7
latest-redpanda-tag: 'v26.1.7'
Comment on lines +20 to +21
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 8, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify that tag v26.1.7 exists in redpanda-data/redpanda repository
# and check if the commit hash needs updating.

# Check if tag v26.1.7 exists
echo "Checking if tag v26.1.7 exists..."
gh api repos/redpanda-data/redpanda/git/refs/tags/v26.1.7 --jq '{tag: .ref, commit: .object.sha}' 2>&1

# Get the current commit hash from the file for comparison
echo -e "\nCurrent commit hash in antora.yml: 35a825c9c1880ebeedf4c18bb8c6cceaa63566c1"

Repository: redpanda-data/docs

Length of output: 253

Update latest-release-commit to match the v26.1.7 tag.

The tag v26.1.7 exists in the Redpanda repository, but points to commit b85ee3cde96881e289beb114f1fbdfe103f4c6e9. Line 23 has latest-release-commit: '35a825c9c1880ebeedf4c18bb8c6cceaa63566c1', which does not match. Update line 23 to point to the correct commit for this release.

🤖 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 `@antora.yml` around lines 20 - 21, The metadata currently sets full-version:
26.1.7 and latest-redpanda-tag: 'v26.1.7' but latest-release-commit is pointing
to the wrong SHA; update the latest-release-commit value to the correct commit
SHA b85ee3cde96881e289beb114f1fbdfe103f4c6e9 so it matches the v26.1.7 tag (look
for the latest-release-commit key in the same file and replace its value).

latest-console-tag: 'v3.3.1'
latest-release-commit: '35a825c9c1880ebeedf4c18bb8c6cceaa63566c1'
latest-operator-version: 'v2.3.8-24.3.6'
Expand Down
10 changes: 8 additions & 2 deletions docs-data/property-overrides.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1300,7 +1300,10 @@
"leader_balancer_mode": {
"_comment": "greedy mode excluded from docs - internal use only (added in v26.1.2)",
"description": "Mode of the leader balancer optimization strategy.\n\nAccepted values:\n\n* `calibrated` (default): An adaptive strategy that samples potential moves and prioritizes high-impact transfers. Minimizes unnecessary leader movement while achieving balance over time. Best for most production workloads.\n* `random`: Accepts the first random move that improves balance. Less efficient than `calibrated` because it doesn't prioritize high-impact moves. Available as a fallback if `calibrated` causes unexpected behavior.\n\nLegacy values `greedy_balanced_shards` and `random_hill_climbing` are treated as `calibrated`.",
"accepted_values": ["calibrated", "random"],
"accepted_values": [
"calibrated",
"random"
],
"config_scope": "cluster"
},
"leader_balancer_mute_timeout": {
Expand Down Expand Up @@ -1540,6 +1543,9 @@
"oidc_group_claim_path": {
"version": "v26.1.1"
},
"oidc_http_proxy_url": {
"version": "v26.1.7"
},
"oidc_principal_mapping": {
"description": "Rule for mapping JWT payload claim to a Redpanda user principal.",
"related_topics": [
Expand Down Expand Up @@ -2269,4 +2275,4 @@
"description": "The default write caching mode to apply to user topics. Write caching acknowledges a message as soon as it is received and acknowledged on a majority of brokers, without waiting for it to be written to disk. With `acks=all`, this provides lower latency while still ensuring that a majority of brokers acknowledge the write. \n\nFsyncs follow <<raft_replica_max_pending_flush_bytes,`raft_replica_max_pending_flush_bytes`>> and <<raft_replica_max_flush_delay_ms,`raft_replica_max_flush_delay_ms`>>, whichever is reached first.\n\nThe `write_caching_default` cluster property can be overridden with the xref:reference:properties/topic-properties.adoc#writecaching[`write.caching`] topic property."
}
}
}
}
17 changes: 12 additions & 5 deletions ...-property-changes-v26.1.5-to-v26.1.6.json → ...-property-changes-v26.1.6-to-v26.1.7.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"comparison": {
"oldVersion": "v26.1.5",
"newVersion": "v26.1.6",
"timestamp": "2026-04-22T01:41:17.013Z"
"oldVersion": "v26.1.6",
"newVersion": "v26.1.7",
"timestamp": "2026-05-08T12:54:30.491Z"
},
"summary": {
"newProperties": 0,
"newProperties": 1,
"changedDefaults": 0,
"changedDescriptions": 0,
"changedTypes": 0,
Expand All @@ -15,7 +15,14 @@
"emptyDescriptions": 2
},
"details": {
"newProperties": [],
"newProperties": [
{
"name": "oidc_http_proxy_url",
"type": "string",
"default": null,
"description": "URL of the HTTP forward proxy used for OIDC discovery and JWKS fetches. Accepts http://host:port or https://host:port. When set, oidc_discovery_url must use https:// — plaintext OIDC origins cannot be routed through a forward proxy."
}
],
"changedDefaults": [],
"changedDescriptions": [],
"changedTypes": [],
Expand Down
18 changes: 18 additions & 0 deletions ...achments/redpanda-properties-v26.1.6.json → ...achments/redpanda-properties-v26.1.7.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10103,6 +10103,24 @@
"version": "v26.1.1",
"visibility": "user"
},
"oidc_http_proxy_url": {
"c_type": "ss::sstring",
"cloud_byoc_only": false,
"cloud_editable": false,
"cloud_readonly": false,
"cloud_supported": false,
"config_scope": "cluster",
"default": null,
"defined_in": "src/v/config/configuration.cc",
"description": "URL of the HTTP forward proxy used for OIDC discovery and JWKS fetches. Accepts http://host:port or https://host:port. When set, oidc_discovery_url must use https:// \u2014 plaintext OIDC origins cannot be routed through a forward proxy.",
"is_deprecated": false,
"is_enterprise": false,
"name": "oidc_http_proxy_url",
"needs_restart": false,
"nullable": true,
"type": "string",
"visibility": "user"
},
"oidc_keys_refresh_interval": {
"c_type": "std::chrono::seconds",
"cloud_byoc_only": false,
Expand Down
41 changes: 41 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 @@ -14083,6 +14083,47 @@ endif::[]
|===


=== oidc_http_proxy_url

URL of the HTTP forward proxy used for OIDC discovery and JWKS fetches. Accepts http://host:port or https://host:port. When set, oidc_discovery_url must use https:// — plaintext OIDC origins cannot be routed through a forward proxy.

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

| Type
| `string`



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

| Nullable
| Yes

| 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::[]

|===


=== oidc_keys_refresh_interval

The frequency of refreshing the JSON Web Keys (JWKS) used to validate access tokens.
Expand Down
Loading