From f37a4cce6c059bbdcce7858d557e846ccf172409 Mon Sep 17 00:00:00 2001 From: Chi-Sheng Liu Date: Mon, 21 Oct 2024 21:46:55 +0800 Subject: [PATCH] [Docs][kubectl-plugin] Add doc for install via Krew (#2458) Closes: ray-project/kuberay#2457 Signed-off-by: Chi-Sheng Liu --- kubectl-plugin/README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/kubectl-plugin/README.md b/kubectl-plugin/README.md index 1d868c5bfb..cef6329ee0 100644 --- a/kubectl-plugin/README.md +++ b/kubectl-plugin/README.md @@ -9,6 +9,15 @@ Kubectl plugin/extension for Kuberay CLI that provides the ability to manage ray ## Installation +You can install the Kuberay kubectl plugin using one of the following methods: + +### Install using Krew kubectl plugin manager (Recommended) + +1. Install [Krew](https://krew.sigs.k8s.io/docs/user-guide/setup/install/). +2. Download the plugin list by running `kubectl krew update`. +3. Install the plugin by running `kubectl krew install ray`. +4. Run `kubectl ray --help` to verify the installation. + ### Download from GitHub releases Go to the [releases page](https://github.com/ray-project/kuberay/releases) and download the binary for your platform. @@ -28,11 +37,6 @@ Replace `~/.local/bin` with the directory in your `PATH`. 1. Run `go build cmd/kubectl-ray.go` 2. Move the binary, which will be named `kubectl-ray` to your `PATH` -### Using Krew - -1. Install [Krew](https://krew.sigs.k8s.io/docs/user-guide/setup/install/). -2. (TODO: Replace this step with the installation command). - ## Shell Completion 1. Install [kubectl plugin-completion](https://github.com/marckhouzam/kubectl-plugin_completion) plugin.