Skip to content

Document that rpk plugins do not upgrade with rpk #1883

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
JakeSCahill wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −0
Open

Document that rpk plugins do not upgrade with rpk #1883

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
20 changes: 20 additions & 0 deletions modules/get-started/pages/rpk-install.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,26 @@ include::get-started:partial$install-rpk-linux.adoc[]

include::get-started:partial$install-rpk-macos.adoc[]

== Upgrade rpk plugins

Plugins, such as `rpk connect` and `rpk ai`, are separate binaries that `rpk` downloads and runs on your behalf. Upgrading `rpk` does not upgrade its plugins. An installed plugin stays at its version until you upgrade it, even across `rpk` upgrades.

To see which plugins are installed:

[,bash]
----
rpk plugin list --local
----

To upgrade a plugin, run its `upgrade` command. For example:

[,bash]
----
rpk connect upgrade
----

NOTE: Some plugins install themselves the first time you run one of their commands. For example, `rpk connect run` downloads the latest Redpanda Connect if it is not already installed. This happens only on first use. After that, the plugin never updates itself.

== Next steps

For the complete list of `rpk` commands and their syntax, see the xref:reference:rpk/index.adoc[rpk reference].
Expand Down
Loading