docs: defer upgrade finalization (DOC-2013)#1818
Conversation
New upgrade-module page covering the 26.2 deferred-finalization feature: concept, Linux/rpk procedure, rollback, gated-features table, Admin API v2 FeaturesService, license behavior, limitations, and troubleshooting. Adds a nav entry and a pointer TIP on the Linux rolling-upgrade page. Sourced from the engineering TOI (cupboard engineering/core/toi/v26.2/2026-07-17-unfinalized-upgrades.md). Coordinated with #1816, which owns the Kubernetes procedure and the shared upgrade-limitations partial. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. 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:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
| The v1 Admin API is unchanged and still useful: `GET /v1/features` reports `cluster_version`, `node_latest_version`, and each feature's state (`unavailable` while gated, `active` after finalization). | ||
|
|
||
| == License behavior | ||
|
|
There was a problem hiding this comment.
As noted in Prerequisites, a valid Enterprise license is required to specify deferred finalization. The following behaviors occur if you attempt to use deferred finalization without a license.
| * Finalizing is not license-checked: `rpk cluster upgrade finalize` works even if the license expired during the soak. The enforcement point is setting the property, nothing else. | ||
|
|
||
| == Limitations | ||
|
|
There was a problem hiding this comment.
Before starting, familiarize yourself with the limitations of the deferred finalization feature:
…ix in rolling-upgrade TIP Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Resolves https://redpandadata.atlassian.net/browse/DOC-2013
Adds documentation for deferred upgrade finalization (unfinalized major-version upgrades), new in 26.2.
Changes
modules/upgrade/pages/deferred-finalization.adoc: concept (binary vs. logical version, the three upgrade phases, finalization as the downgrade floor), Linux/rpk procedure (defer, verify the hold, soak, finalize), rollback procedure, the 26.2 gated-features table, Admin API v2FeaturesServiceusage (GetUpgradeStatus/FinalizeUpgradewith response fields and error semantics), license behavior, limitations, and a troubleshooting section covering the async/one-shot finalize semantics, leadership-change caveats, and theIncompatible downgrade detectedguard.rolling-upgrade.adoc: a TIP after the limitations partial pointing to the new page.All content is sourced from the engineering TOI: engineering/core/toi/v26.2/2026-07-17-unfinalized-upgrades.md.
Coordination with #1816 (DOC-2273, Kubernetes) and #1819 (DOC-2217, Shadowing)
cc: @JakeSCahill
Per the split agreed in #1816: this PR owns the concept page and Linux procedure and does not touch
partials/rolling-upgrades/upgrade-limitations.adoc(that edit ships in #1816, phrased generically to serve both pages). The new page's Kubernetes section covers the operator-unaware caveat briefly and links tok-rolling-upgrade.adocat page level.#1819 (DOC-2217) is stacked on this PR: it adds the shadowing-upgrade page, which xrefs
deferred-finalization.adocthroughout, and its base is this branch. Merging this PR retargets #1819 tobetaautomatically.Suggested merge order: #1816 → this PR → #1819. After #1816 merges, the Kubernetes xref here can be tightened to the
#defer-upgrade-finalizationanchor (happy to do that in this PR if #1816 lands first).Review notes
rpk cluster upgrade status|finalizeare mentioned in code font without xrefs: the reference pages arrive with the 26.2 rpk regen.tiered_v2storage mode is not yet documented on beta, so that gated-features row has no link.upgrade_override_checksbypass is deliberately omitted (TOI: support-directed emergencies only, never customer-advised); the troubleshooting entry says to contact support instead.🤖 Generated with Claude Code
Preview pages