Skip to content
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.

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

DOC-625 update install rpk to include update #801

Merged
merged 6 commits into from
Oct 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
** xref:get-started:licenses.adoc[Redpanda Licensing]
** xref:get-started:rpk/index.adoc[Redpanda CLI]
*** xref:get-started:intro-to-rpk.adoc[Introduction to rpk]
*** xref:get-started:rpk-install.adoc[Install rpk]
*** xref:get-started:rpk-install.adoc[]
*** xref:get-started:config-rpk-profile.adoc[]
*** xref:get-started:broker-admin.adoc[]
*** xref:get-started:admin-addresses.adoc[]
Expand Down
30 changes: 17 additions & 13 deletions modules/get-started/pages/rpk-install.adoc
Original file line number Diff line number Diff line change
@@ -1,36 +1,40 @@
= Install rpk
= Install or Update rpk
:page-aliases: quickstart:rpk-install.adoc
:page-categories: rpk
// Do not put page aliases in the single-sourced content
// tag::single-source[]
:description: pass:q[The `rpk` tool is a single binary application that provides a way to interact with your Redpanda clusters from the command line.]
:description: pass:q[Install or update `rpk` to interact with Redpanda from the command line.]

The `rpk` tool is a single binary application that provides a way to interact with your Redpanda clusters from the command line. For example, you can use `rpk` to:
The `rpk` tool is a single binary application that provides a way to interact with your Redpanda clusters from the command line. For example, you can use `rpk` to do the following:

* Monitor your cluster's health.
* Set up access control lists (ACLs) and other security features.
* Create topics, produce to topics, and consume from topics.
* Monitor your cluster's health
* Create, produce, and consume from topics
* Set up access control lists (ACLs) and other security features

ifndef::env-cloud[]
For Redpanda Self-Managed deployments, the `rpk` binary is automatically installed on each Redpanda broker. So, you can use the locally installed `rpk` binary to communicate with the local Redpanda cluster.
For Redpanda Self-Managed deployments, the `rpk` binary is automatically installed on each Redpanda broker, so you can use the locally installed `rpk` binary to communicate with the local Redpanda cluster.

You can also install `rpk` on your local machine as a standalone binary. With this setup, you can connect to both a Redpanda cluster on your local machine, or an external one on a remote server.
You can also install `rpk` on your local machine as a standalone binary. With this setup, you can connect to a Redpanda cluster on your local machine and to an external one on a remote server. If you use `rpk` as a standalone binary to communicate with a Redpanda cluster, your installed version of `rpk` must match the version of Redpanda running in your cluster.
endif::[]

If you use `rpk` as a standalone binary to communicate with a Redpanda cluster, ensure the version of `rpk` that you install matches the version of Redpanda running in your cluster.
ifdef::env-cloud[]
Redpanda Cloud deployments should always use the latest version of `rpk`.
endif::[]

To install the `rpk` binary as a standalone application, follow the instructions for your operating system.
== Check rpk version

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

== Install rpk on Linux
== Install or update rpk on Linux

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

== Install rpk on macOS
== Install or update rpk on macOS

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

== Next steps

For a list of all `rpk` commands and their syntax, see the xref:reference:rpk/index.adoc[rpk documentation].
For a list of `rpk` commands and their syntax, see the xref:reference:rpk/index.adoc[rpk reference].

// end::single-source[]
11 changes: 4 additions & 7 deletions modules/get-started/partials/install-rpk-apple-silicon.adoc
Original file line number Diff line number Diff line change
@@ -1,22 +1,19 @@
. Install `rpk` for macOS:
+
- To install the latest version of `rpk`:
To install, or update to, the latest version of `rpk` for Apple Silicon, run:
+
```bash
curl -LO https://github.com/redpanda-data/redpanda/releases/latest/download/rpk-darwin-arm64.zip &&
mkdir -p ~/.local/bin &&
export PATH="~/.local/bin:$PATH" &&
unzip rpk-darwin-arm64.zip -d ~/.local/bin/
```
+
// tag::custom-version[]
- To install a version other than the latest:
To install, or update to, a version other than the latest, run:
+
```bash
curl -LO https://github.com/redpanda-data/redpanda/releases/download/v<version>/rpk-darwin-arm64.zip &&
mkdir -p ~/.local/bin &&
export PATH="~/.local/bin:$PATH" &&
unzip rpk-darwin-arm64.zip -d ~/.local/bin/
```
// end::custom-version[]

include::get-started:partial$rpk-version.adoc[]
// end::custom-version[]
4 changes: 1 addition & 3 deletions modules/get-started/partials/install-rpk-homebrew.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
. If you don't have Homebrew installed, https://brew.sh/[install it^].
. Install `rpk`:
. To install or update `rpk`, run:
+
[,bash]
----
brew install redpanda-data/tap/redpanda
----

include::get-started:partial$rpk-version.adoc[]
+
NOTE: This method installs the latest version of `rpk`, which is supported only with the latest version of Redpanda.
12 changes: 5 additions & 7 deletions modules/get-started/partials/install-rpk-intel-macos.adoc
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
. Install `rpk` for macOS:
+
- To install the latest version of `rpk`:

To install, or update to, the latest version of `rpk` for Intel macOS, run:
+
```bash
curl -LO https://github.com/redpanda-data/redpanda/releases/latest/download/rpk-darwin-amd64.zip &&
mkdir -p ~/.local/bin &&
export PATH="~/.local/bin:$PATH" &&
unzip rpk-darwin-amd64.zip -d ~/.local/bin/
```
+
// tag::custom-version[]
- To install a version other than the latest:
To install, or update to, a version other than the latest, run:
+
```bash
curl -LO https://github.com/redpanda-data/redpanda/releases/download/v<version>/rpk-darwin-amd64.zip &&
mkdir -p ~/.local/bin &&
export PATH="~/.local/bin:$PATH" &&
unzip rpk-darwin-amd64.zip -d ~/.local/bin/
```
// end::custom-version[]

include::get-started:partial$rpk-version.adoc[]
// end::custom-version[]
14 changes: 6 additions & 8 deletions modules/get-started/partials/install-rpk-linux.adoc
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@
. Install `rpk` for Linux:
+
- To install the latest version of `rpk`:
+
To install, or update to, the latest version of `rpk` for Linux, run:

```bash
curl -LO https://github.com/redpanda-data/redpanda/releases/latest/download/rpk-linux-amd64.zip &&
mkdir -p ~/.local/bin &&
export PATH="~/.local/bin:$PATH" &&
unzip rpk-linux-amd64.zip -d ~/.local/bin/
```

- To install a version other than the latest:
+
ifndef::env-cloud[]
To install, or update to, a version other than the latest, run:

```bash
curl -LO https://github.com/redpanda-data/redpanda/releases/download/v<version>/rpk-linux-amd64.zip &&
mkdir -p ~/.local/bin &&
export PATH="~/.local/bin:$PATH" &&
unzip rpk-linux-amd64.zip -d ~/.local/bin/
```

include::get-started:partial$rpk-version.adoc[]
endif::[]
2 changes: 1 addition & 1 deletion modules/get-started/partials/install-rpk-macos.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ include::get-started:partial$install-rpk-homebrew.adoc[]
Manual Download::
+
--
To install rpk through a manual download, choose an option that corresponds to your system architecture. For example, if you have an M1 or M2 chip, use the *Apple Silicon* instructions.
To install or update `rpk` through a manual download, choose the option for your system architecture. For example, if you have an M1 or M2 chip, select *Apple Silicon*.

[tabs]
====
Expand Down
10 changes: 6 additions & 4 deletions modules/get-started/partials/rpk-version.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
. Run `rpk --version` to display the version of the rpk binary:
+
To check your current version of the rpk binary, run `rpk --version`.

The following example lists the latest version of `rpk`. If your installed version is lower than this latest version, then update `rpk`. For a list of versions, see https://github.com/redpanda-data/redpanda/releases/[Redpanda releases^].

[,bash]
----
rpk --version
----
+

[,bash,role=no-copy,subs="attributes+"]
----
rpk version {full-version} (rev {latest-release-commit})
----
----