docs: enhance upgrade version steps #1228
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 📝 WalkthroughWalkthroughThe documentation for upgrading Redpanda was updated to provide more explicit instructions for both Fedora/RedHat and Debian/Ubuntu systems. The changes include steps to verify the current Redpanda version, list all available versions, and perform a version-specific upgrade rather than a generic update. Additionally, the instructions for restarting the Redpanda broker were changed from using Sequence Diagram(s)sequenceDiagram
participant User
participant System
User->>System: List available Redpanda versions (yum/apt)
User->>System: Check current Redpanda broker version (rpk)
User->>System: Upgrade to specific Redpanda version (yum/apt)
User->>System: Restart Redpanda service (systemctl)
Estimated code review effort2 (~15 minutes) ✨ 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: 0
🧹 Nitpick comments (5)
modules/upgrade/partials/rolling-upgrades/restart-the-broker.adoc (1)
3-8: Consider adding a quick post-restart verification step.Most operators double-check service health immediately after a restart. Suggest appending a
systemctl status redpanda(orrpk cluster health) example so readers can confirm the broker came back up without having to hunt elsewhere in the docs.sudo systemctl restart redpanda +sudo systemctl status redpanda # Verify the service is activemodules/upgrade/partials/rolling-upgrades/upgrade-your-version.adoc (4)
14-24:rpk redpanda admin brokers listmay fail if the broker is already down.During staged upgrades, the node you’re working on is often stopped. In that case,
rpk … brokers listerrors out. Consider offering a package-manager alternative (rpm -q redpandaordpkg -l redpanda) as a fallback so the step is always actionable.
25-30: Preferdnfoveryumon modern Fedora/RHEL and show the full NEVRA.
yumis symlinked but the official tooling isdnf. Also, the package name must include the release suffix (e.g.,25.1.7-1). Clarify to prevent “No package redpanda- available” confusion.-sudo yum update redpanda-<version> +sudo dnf install redpanda-<version>-1 # example: redpanda-25.1.7-1
34-43: Same availability caveat for Debian/Ubuntu current-version check.If the broker is stopped,
rpkfails here too. Suggestdpkg -l | grep redpandaas an alternative.
45-51: Optional: mention holding the package to avoid accidental upgrades.After installing a specific version, many users run
apt-mark hold redpandaso unattended upgrades don’t bump the package unexpectedly. Adding this one-liner reinforces deterministic rollouts.sudo apt install redpanda=<version> +sudo apt-mark hold redpanda # Prevent unintended auto-upgrades
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
modules/upgrade/partials/rolling-upgrades/restart-the-broker.adoc(1 hunks)modules/upgrade/partials/rolling-upgrades/upgrade-your-version.adoc(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: Feediver1
PR: redpanda-data/docs#1153
File: antora.yml:3-5
Timestamp: 2025-07-14T19:28:43.296Z
Learning: In Redpanda docs, during beta releases, the version metadata may intentionally show inconsistencies where the header displays the beta version (e.g., 25.2 Beta) while internal attributes like full-version, latest-redpanda-tag, operator-beta-tag still reference the stable version (e.g., 25.1). This is resolved during the GA merge process when all version references are synchronized.
Learnt from: paulohtb6
PR: redpanda-data/docs#0
File: :0-0
Timestamp: 2025-07-15T20:38:27.458Z
Learning: In Redpanda documentation, "Redpanda Data" refers to the company name, while "Redpanda" refers to the product name. These terms should be used appropriately based on context.
Learnt from: JakeSCahill
PR: redpanda-data/docs#1192
File: modules/deploy/partials/requirements.adoc:91-93
Timestamp: 2025-07-02T14:54:03.506Z
Learning: In Redpanda documentation, use GiB (binary units, powers of 2) for Kubernetes-specific memory requirements because Kubernetes treats memory units like Mi, Gi as binary units. Use GB (decimal units, powers of 10) for general broker memory requirements in non-Kubernetes contexts.
Learnt from: kbatuigas
PR: redpanda-data/docs#1113
File: modules/manage/partials/iceberg/use-iceberg-catalogs.adoc:100-107
Timestamp: 2025-05-07T01:06:00.937Z
Learning: In AsciiDoc documentation for Redpanda, the syntax `+` and `--` around content blocks within a `[tabs]` section are valid AsciiDoc formatting elements for tabbed content. The `+` after a tab name (like `rpk::`) indicates that the following block belongs to that tab, and the `--` markers enclose the content for that tab. These are not diff artifacts and should not be removed.
Learnt from: Feediver1
PR: redpanda-data/docs#1153
File: modules/reference/pages/properties/topic-properties.adoc:45-50
Timestamp: 2025-07-16T19:33:20.420Z
Learning: In the Redpanda documentation, topic property cross-references like <<max.compaction.lag.ms>> and <<min.compaction.lag.ms>> require corresponding property definition sections with anchors like [[maxcompactionlagms]] and [[mincompactionlagms]] to prevent broken links.
modules/upgrade/partials/rolling-upgrades/upgrade-your-version.adoc (2)
Learnt from: Feediver1
PR: #1153
File: antora.yml:3-5
Timestamp: 2025-07-14T19:28:43.296Z
Learning: In Redpanda docs, during beta releases, the version metadata may intentionally show inconsistencies where the header displays the beta version (e.g., 25.2 Beta) while internal attributes like full-version, latest-redpanda-tag, operator-beta-tag still reference the stable version (e.g., 25.1). This is resolved during the GA merge process when all version references are synchronized.
Learnt from: kbatuigas
PR: #1113
File: modules/manage/partials/iceberg/use-iceberg-catalogs.adoc:100-107
Timestamp: 2025-05-07T01:06:00.937Z
Learning: In AsciiDoc documentation for Redpanda, the syntax + and -- around content blocks within a [tabs] section are valid AsciiDoc formatting elements for tabbed content. The + after a tab name (like rpk::) indicates that the following block belongs to that tab, and the -- markers enclose the content for that tab. These are not diff artifacts and should not be removed.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
modules/upgrade/partials/rolling-upgrades/upgrade-your-version.adoc
Outdated
Show resolved
Hide resolved
modules/upgrade/partials/rolling-upgrades/upgrade-your-version.adoc
Outdated
Show resolved
Hide resolved
modules/upgrade/partials/rolling-upgrades/restart-the-broker.adoc
Outdated
Show resolved
Hide resolved
modules/upgrade/partials/rolling-upgrades/upgrade-your-version.adoc
Outdated
Show resolved
Hide resolved
modules/upgrade/partials/rolling-upgrades/upgrade-your-version.adoc
Outdated
Show resolved
Hide resolved
Co-authored-by: Joyce Fee <[email protected]>
vuldin
left a comment
vuldin
left a comment
There was a problem hiding this comment.
Thanks, these new instructions allow for the user to select the proper next Redpanda version. LGTM
Description
Resolves https://redpandadata.atlassian.net/browse/DOC-1501
Review deadline: 30th july
Page previews
Checks