Document that rpk plugins do not upgrade with rpk - #1883
Conversation
Verified empirically (DOC-2417): upgrading rpk replaces only the rpk binary. Plugins are separate binaries discovered at runtime and stay at their installed version until their own upgrade command runs - a plugin pinned at ai 0.2.30 survived an rpk 26.1.12 to 26.2.1 upgrade untouched, including across invocations, and moved only on rpk ai upgrade. Some plugins self-install the LATEST on first functional use (rpk connect run) but never self-update afterwards. The section sits inside the single-source region, so the cloud-docs rpk-install stub inherits it with no change on that side.
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds an “Upgrade rpk plugins” section to the rpk installation documentation. It explains that plugins are separate binaries with independent versions, shows how to list installed plugins, documents how to upgrade Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
What
Adds an "Upgrade rpk plugins" section to the Install or Update rpk page: plugins are separate binaries, upgrading
rpknever upgrades them,rpk plugin list --localshows what's installed, and each plugin has its ownupgradecommand. A NOTE covers the one nuance that trips people: some plugins (Connect) self-install the latest on first functional use, but never self-update afterwards.Evidence
Every statement is empirically verified (full test log and reproduction steps in the Jira): a plugin pinned at ai 0.2.30 survived an rpk v26.1.12 → v26.2.1 binary upgrade untouched, stayed at 0.2.30 across invocations through the new rpk, and moved to 0.2.34 only when
rpk ai upgraderan.rpk connect runon a clean setup downloaded latest (4.103.1) on first use and did not re-check afterwards.Placement
Inside the
tag::single-source[]region, so the cloud-docsrpk-install.adocstub (a pure include) inherits the section with no change needed in that repo. Companion one-line fixes for the plugin-specific pages: rp-connect-docs and adp-docs PRs linked from the Jira.Jira
Resolves DOC-2417.