Release v25.2 docs #1250
Release v25.2 docs #1250
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThis update makes extensive changes to the Redpanda documentation set. It removes all references to beta versions across compatibility matrices, release notes, and navigation, replacing them with stable version numbers (e.g., 25.1.x, 25.2.x). Numerous documentation files are updated to add or clarify support for new features in Redpanda 25.2, such as JSON Schema support for Iceberg topics, explicit SASL configuration for HTTP Proxy, and new compaction lag properties. The documentation for deploying and managing Redpanda in Kubernetes is modularized using reusable partials, and the guidance for Kafka Connect deployment is revised to focus on a standalone connectors Helm chart. Navigation and context switchers are added to Console documentation to distinguish between v2.x and v3.x. Deprecated or obsolete sections, especially related to Flux integration and beta deployment guides, are removed. Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation Portal
participant Redpanda Operator
participant Kubernetes
participant Helm
User->>Documentation Portal: Accesses deployment or configuration guide
Documentation Portal-->>User: Presents modularized instructions (includes partials)
User->>Kubernetes: Applies CRDs/installs Operator via Helm (per partial)
User->>Helm: Installs Redpanda/Connectors using updated charts
User->>Documentation Portal: Uses version context switcher for Console docs
Documentation Portal-->>User: Shows v2.x or v3.x Console instructions and version notes
User->>Documentation Portal: Looks up property/feature (e.g., compaction lag, Iceberg JSON Schema)
Documentation Portal-->>User: Presents updated property/feature documentation
User->>Documentation Portal: Reads breaking change note for HTTP Proxy credentials
Documentation Portal-->>User: Displays explicit SASL configuration instructions
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ 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: 10
🔭 Outside diff range comments (4)
modules/manage/partials/tiered-storage.adoc (1)
333-338: Wrong credentials source for GCS in Helm--setexampleThe example sets
cloud_storage_credentials_source=aws_instance_metadata, which is incorrect for Google Cloud.
This breaks authentication for users copy-pasting the command.- --set storage.tiered.config.cloud_storage_credentials_source=aws_instance_metadata \ + --set storage.tiered.config.cloud_storage_credentials_source=gcp_instance_metadata \modules/reference/pages/properties/broker-properties.adoc (1)
781-789: Document accepted values & restart requirement for new HTTP-Proxy client SASL propsThe three updated properties expose auth configuration but still miss two standard metadata sections used elsewhere in this file:
*Accepted values:*– forsasl_mechanismwe should list the supported mechanisms (PLAIN,SCRAM-SHA-256,SCRAM-SHA-512,OAUTHBEARER).*Requires restart:*– the rest of the HTTP-Proxy client properties explicitly state whether a restart is needed. Add the field for parity (it isYes, same as the other client props).Without these sections users cannot quickly scan the table for valid options, and automated doc tests flag the omission.
:::: sasl_mechanism section :::: -*Visibility:* `user` -*Type:* string -*Default:* `null` +*Visibility:* `user` +*Type:* string +*Accepted values:* `PLAIN`, `SCRAM-SHA-256`, `SCRAM-SHA-512`, `OAUTHBEARER` +*Requires restart:* Yes +*Default:* `null` :::: scram_password / scram_username sections :::: -*Visibility:* `user` -*Type:* string -*Default:* `null` +*Visibility:* `user` +*Type:* string +*Requires restart:* Yes +*Default:* `null`Also applies to: 795-803, 809-817
modules/manage/partials/iceberg/about-iceberg-topics.adoc (1)
279-283: Broken JSON in the Avro schema example
The stray period after the closing brace renders the example invalid JSON/Avro and will confuse readers or copy-paste tooling.- "type": "string" - }. + "type": "string" + },modules/reference/pages/properties/topic-properties.adoc (1)
160-170: Cross-refs use spaces/case that won’t match generated IDs
<<Tolerations>>and<<Affinity rules>>(Line 128) as well as any other mixed-case / space-containing references will fail. Auto-generated IDs are lower-case, hyphenated (tolerations,affinity-rules). Fix the targets.
🧹 Nitpick comments (38)
modules/deploy/pages/deployment-option/self-hosted/kubernetes/eks-guide.adoc (1)
376-380: Make alias cleanup persistent
unalias internal-rpkremoves the alias only for the current shell session. If users added the alias to a startup file ( ~/.bashrc, ~/.zshrc ), they must delete that line as well; otherwise the alias is re-created in new sessions.Consider adding a brief note right after the code block:
unalias internal-rpk + +NOTE: If you added the alias to a shell startup file (for example, +`~/.bashrc` or `~/.zshrc`), remove that line as well so the alias does not +re-appear in new terminal sessions.antora.yml (1)
3-5: Align fallback version attributes before GA
versionhas moved to 25.2 butfull-version,latest-redpanda-tag, and related fallback attributes still reference 25.1.x. This is expected during beta (per prior process), but remember to update (or remove) these once 25.2 reaches GA to avoid confusing search results and context switchers.local-antora-playbook.yml (1)
18-18: Flow-sequence element has no space after the comma – YAML is tolerant but brittle
[main, v/*, api, shared, site-search,'!v-end-of-life/*']lacks a space before the last element. While parsers accept it, adding the space avoids future lint noise and mis-diffs.- branches: [main, v/*, api, shared, site-search,'!v-end-of-life/*'] + branches: [main, v/*, api, shared, site-search, '!v-end-of-life/*']modules/console/partials/operator-console-version-note.adoc (1)
10-18: Shell examples: quote the namespace placeholder to avoid word-splitting
kubectl get deployment -n <namespace> …is fine, but for copy-paste safety consider"<namespace>"(same for pod & logs commands).
Minor, but prevents surprises when users paste a namespace containing spaces.modules/manage/partials/whole-cluster-restore.adoc (1)
155-156: Repeated include may duplicate the same TIP multiple times
include::manage:partial$kubernetes/extraclusterconfig.adoc[]is now added inside this procedure, but the Tiered Storage docs already pull the same partial.
Consider whether the reader benefits from seeing the same TIP again, or if a single mention earlier in the doc is sufficient.modules/manage/partials/tiered-storage.adoc (1)
142-145:extraclusterconfig.adocis included six times – consider deduplicatingThe same TIP block appears after every provider section. That inflates the page and may annoy readers scrolling through.
Recommend showing it once (for example right after the first provider heading) and linking back to it if needed.Also applies to: 262-265, 349-352, 470-473, 578-583, 683-686
modules/shared/partials/http-proxy-ephemeral-credentials-breaking-change-short.adoc (1)
1-1: Add reference link for deeper guidance
Consider appending a short link to the full “HTTP Proxy credentials” breaking-change section so readers can immediately jump to the detailed migration steps.modules/deploy/pages/deployment-option/self-hosted/kubernetes/aks-guide.adoc (1)
129-134: Alias removal may still persist in shell startup files
unalias internal-rpkremoves the alias only from the current shell. If the alias was added to~/.bashrc,~/.zshrc, or similar, advise the reader to delete that line as well:To remove the convenience alias created during the quickstart: ```bash unalias internal-rpk + +# If you added the alias to a shell profile, remove the line too: +# sed -i '/alias internal-rpk/d' ~/.bashrc # adjust for your shell</blockquote></details> <details> <summary>modules/console/pages/config/enterprise-license.adoc (1)</summary><blockquote> `3-5`: **Repeated switcher + note boilerplate suggests a partial could DRY this** Every Console page now duplicates the identical `:page-context-switcher:` JSON plus the `operator-console-version-note.adoc` include. Consider extracting both lines into a small partial (for example `console:partial$console-version-switcher.adoc`) and including that instead. Benefits: single-point maintenance when versions change, less merge noise. </blockquote></details> <details> <summary>modules/console/pages/ui/schema-reg.adoc (1)</summary><blockquote> `5-7`: **Minor JSON style nit – drop trailing spaces for consistency** While the switcher JSON is syntactically fine, the spaces before the closing `}` and `]` are unnecessary and inconsistent with other docs JSON blocks. ```diff -:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/schema-reg.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/schema-reg.adoc"},{"name": "Redpanda Console v3.x", "to": "current"}]modules/console/pages/ui/record-deserialization.adoc (1)
4-6: Stray change marker on blank Line 10 – safe to drop
10~marks a touched line that is effectively blank. Removing it avoids a useless diff hunk and keeps history clean.modules/manage/pages/kubernetes/monitoring/k-monitor-connectors.adoc (1)
3-6: Remove duplicate:env-kubernetes:attribute
env-kubernetesis declared twice (Line 3 and Line 6). The second declaration is redundant and can confuse attribute precedence in Antora.:description: Monitor the health of Kafka Connect using managed connector metrics. -:env-kubernetes: true ... :page-categories: Management, Monitoring -:env-kubernetes: true +:env-kubernetes: truemodules/console/pages/config/security/authorization.adoc (1)
164-165: Placement of Kafka-Connect community noteThe community-supported-kc note appears deep inside the Authorization page, disconnected from any Kafka Connect content. Readers may miss the relevance.
Recommend relocating the include to either the top NOTE block or removing it if not required here.modules/console/pages/ui/add-license.adoc (1)
3-4: Keep switcher target in sync with previous release branchYou hard-coded the v2.x target to
24.3. When 24.4 (or 25.1) becomes the maintenance branch you will need to update this manually.
Consider introducing an attribute (for example,{console-v2-stable}) to avoid future churn.modules/console/pages/config/kafka-connect.adoc (1)
4-9: Ordering of informational notesPlacing the community-supported-kc note before the Operator version note breaks the logical flow (users first need to know which Console version they are on, then whether KC is community-supported). Swapping the two includes improves readability:
-include::shared:partial$community-supported-kc.adoc[] -include::console:partial$operator-console-version-note.adoc[] +include::console:partial$operator-console-version-note.adoc[] +include::shared:partial$community-supported-kc.adoc[]modules/console/pages/index.adoc (2)
4-6: Future-proof the switcher targetSame concern as other pages: hard-coding
24.3will require manual updates every minor release. Prefer an attribute for the latest v2.x doc path.
51-52: Avoid repeating community-supported note too oftenWith the partial now included on the Console index page and the dedicated Kafka Connect config page, readers may see the same banner multiple times in quick succession. Consider limiting the include to pages where users are actively configuring KC.
modules/console/pages/ui/edit-topic-configuration.adoc (1)
4-7: Trim trailing space and keep JSON values consistentThe JSON in
:page-context-switcher:has an extra space just before the closing bracket (" } ]). That space becomes part of the attribute value and is then passed verbatim to the context-switcher extension. Upstream pages already omit this space, so the parsers accept slightly different strings across pages. Trim it here (and in other new pages) to keep the attribute values byte-identical and avoid brittle equality checks in the extension or its tests.-:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/edit-topic-configuration.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/edit-topic-configuration.adoc"},{"name": "Redpanda Console v3.x", "to": "current"}]modules/console/pages/ui/programmable-push-filters.adoc (1)
5-8: Synchronize switcher JSON and remove trailing commas/spacesSame whitespace issue as in other pages (see earlier comment). The JSON should be trimmed and the space after each object removed for consistency. This is the only reason some pages re-render while others fail when strict JSON validation is enabled.
-:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/programmable-push-filters.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:ui/programmable-push-filters.adoc"},{"name": "Redpanda Console v3.x", "to": "current"}]modules/console/pages/config/security/authentication.adoc (1)
5-8: Minor JSON formatting nitFor the new
:page-context-switcher:attribute keep the formatting identical to other pages (no space before}or]). Avoid future diffs that are purely cosmetic and make automated style checks easier.-:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/security/authentication.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/security/authentication.adoc"},{"name": "Redpanda Console v3.x", "to": "current"}]modules/console/pages/config/topic-documentation.adoc (1)
4-6: Consistent JSON & whitespaceSame observation: remove the extra spaces inside the
:page-context-switcher:attribute so that all pages share an identical value.-:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/topic-documentation.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ] +:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/topic-documentation.adoc"},{"name": "Redpanda Console v3.x", "to": "current"}]modules/develop/pages/kafka-clients.adoc (1)
52-53: Minor wording tweak to avoid duplication“Simultaneously” already implies concurrency; consider trimming for brevity:
-* Multiple SCRAM mechanisms simultaneously for SASL users; for example, a user having both a `SCRAM-SHA-256` and a `SCRAM-SHA-512` credential. +* Multiple SCRAM mechanisms for a single SASL user (for example, both `SCRAM-SHA-256` and `SCRAM-SHA-512`).modules/migrate/pages/kubernetes/strimzi.adoc (2)
298-303: Cross-reference points to generic deployment guide
xref:deploy:deployment-option/self-hosted/kubernetes/k-deploy-connectors.adocis accurate, but the phrasing “separate … Helm chart” suggests linking directly to the chart overview (k-deploy-connectors.adoc#overview) for quicker context.Optional improvement only.
312-313: External chart link: pin a specific tagLinking to the root of
mainmeans the SHA may change and the docs could drift. Consider appending?ref=<tag>(for example?ref=v0.8.0) so the link always opens the version validated in this release.modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-deployment-overview.adoc (1)
53-56: Minor wording tweak for precision“GitOps compatibility” alone is vague. Consider spelling out that the Operator supports GitOps workflows (Argo CD, Flux, etc.) without additional controllers.
Not blocking, purely stylistic.
modules/deploy/partials/kubernetes/deploy-operator.adoc (2)
4-11: Add--wait --atomicfor safer Helm installsA failed CRD installation leaves the release in a bad state. Including these flags makes the operation transactional:
-helm upgrade --install redpanda-controller redpanda/operator \ +helm upgrade --install redpanda-controller redpanda/operator \ --namespace <namespace> \ --create-namespace \ + --wait --atomic \Optional but strongly recommended for production guides.
16-23: Versioned back-link may driftThe back-link points to
25.1@ROOT:hard-coded. When 25.3 ships this will still reference 25.1 docs.Consider replacing with an attribute (
earlier-operator-docs) or wording “See the documentation for Operator v2.4.x” with a plain URL to avoid future churn.modules/deploy/pages/deployment-option/self-hosted/kubernetes/local-guide.adoc (1)
537-541: Alias-cleanup step should be marked as optional and scoped to the current shellThe
unalias internal-rpkcommand is harmless, but it can confuse readers who never created the alias (for example, those who skipped the earlier “Start streaming” section).
Consider prefacing the block with a short sentence such as “If you created the alias earlier, remove it with:” or wrapping the whole step in an[NOTE]block.modules/deploy/partials/kubernetes/guides/deploy-redpanda.adoc (1)
133-140: Pinning to “latest” undermines reproducibility
--set image.tag={latest-redpanda-tag}makes every install pull whatever tag the docs build currently defines. For production examples, prefer a concrete version (25.2.x) so readers can recreate the exact state later.modules/reference/pages/properties/cluster-properties.adoc (2)
3708-3726:max_compaction_lag_ms– verify cross-doc references & default rationale.Good to see the cluster-level override documented. Two quick checks:
- Cross-references: topic-level docs use the xref
<<max.compaction.lag.ms>>. Make sure an explicit anchor ([[maxcompactionlagms]]) exists on that topic property so this reference resolves (see learned gotcha).- Default value
9223372036854 ms(~292 years) looks like the int64 max-1. If that’s intentional, consider adding a short note like “effectively unlimited” so readers don’t mis-interpret the number.
3973-3993:min_compaction_lag_ms– same cross-doc & clarity concerns.Mirror the checks for
min_compaction_lag_ms:
- Ensure the topic-level property carries an anchor (
[[mincompactionlagms]]) so thexrefresolves.- Accepted range starts at
0; default is0. Mention explicitly that0disables the delay to avoid ambiguity.modules/manage/partials/monitor-connectors.adoc (1)
155-160: Release name mismatch with earlier examplesPrevious install commands use the release name
redpanda-connectors, but the label selector later expectsapp.kubernetes.io/name=connectors.
Double-check that the chart indeed sets that label regardless of release name; otherwise Prometheus will not scrape metrics.modules/get-started/pages/release-notes/helm-charts.adoc (1)
39-46: Consider linking directly to the new connectors chart for quicker adoptionRight after explaining that Kafka Connect was removed, adding an ArtifactHub link (or
helm show valuessnippet) forredpanda/connectorswill shorten the discovery path for operators who upgrade today.modules/manage/pages/kubernetes/k-configure-helm-chart.adoc (1)
283-288: Quote dotted keys in--setfor Bash safetyUnquoted dotted keys are expanded by some shells (
set -o nounset) and can break CI scripts.
Wrap the whole value in single quotes:- --set config.extraClusterConfiguration.iceberg_rest_catalog_client_secret.secretKeyRef.name=iceberg-config \ - --set config.extraClusterConfiguration.iceberg_rest_catalog_client_secret.secretKeyRef.key=iceberg_rest_catalog_client_secret + --set 'config.extraClusterConfiguration.iceberg_rest_catalog_client_secret.secretKeyRef.name=iceberg-config' \ + --set 'config.extraClusterConfiguration.iceberg_rest_catalog_client_secret.secretKeyRef.key=iceberg_rest_catalog_client_secret'modules/manage/partials/authentication.adoc (1)
706-738: Consider extracting duplicate TLS configuration snippets into a shared partial
Both the Schema Registry and the HTTP Proxy sections repeat very similar TLS YAML blocks. Consolidating them into a singleshared:partialreduces maintenance overhead and avoids drift when future TLS options change.modules/manage/pages/kubernetes/k-manage-connectors.adoc (1)
137-144: Relying onkubectl execlimits automation
Executing REST calls from inside the connector Pod works, but scripts become cluster-internal only. Consider documenting a Service-based curl example (e.g.,service/connectors:8083) so CI/CD pipelines outside the cluster can interact with Kafka Connect withoutexec.modules/reference/pages/properties/topic-properties.adoc (1)
655-656:config_ref:macro misuse
config_ref:tombstone_retention_ms,true,properties/cluster-properties[]does not follow the normalconfig_ref:<property>[,true]syntax used elsewhere and renders raw text. Replace with a validconfig_refor plainxref.modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-deploy-connectors.adoc (1)
128-129: Cross-refs<<Tolerations>>/<<Affinity rules>>will breakHeadings generate lowercase, hyphenated IDs (
tolerations,affinity-rules). Update the refs or add explicit anchors.
modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-deploy-connectors.adoc
Show resolved
Hide resolved
modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-production-deployment.adoc
Show resolved
Hide resolved
Co-authored-by: Chris Seto <[email protected]> Co-authored-by: Michele Cyran <[email protected]>
Co-authored-by: Michele Cyran <[email protected]>
Co-authored-by: Paulo Borges <[email protected]> Co-authored-by: Joyce Fee <[email protected]> Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Michele Cyran <[email protected]>
…t-kafka-javascript (#1205) Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Jake Cahill <[email protected]>
Co-authored-by: Michele Cyran <[email protected]>
Co-authored-by: Jake Cahill <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: kbatuigas <[email protected]> Co-authored-by: Ben Pope <[email protected]> Co-authored-by: Michele Cyran <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: micheleRP <[email protected]>
Description
Resolves https://redpandadata.atlassian.net/browse/
Review deadline:
Page previews
Checks