From fad4fd9ca27605fe48ffdeb4a1d8ca2336877f74 Mon Sep 17 00:00:00 2001 From: Chi-Sheng Liu Date: Sat, 19 Oct 2024 01:27:46 +0800 Subject: [PATCH] [Docs][kubectl-plugin] Add instructions for downloading from GitHub release (#2450) Closes: ray-project/kuberay#2449 Signed-off-by: Chi-Sheng Liu --- kubectl-plugin/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/kubectl-plugin/README.md b/kubectl-plugin/README.md index 9ecf671ea3..1d868c5bfb 100644 --- a/kubectl-plugin/README.md +++ b/kubectl-plugin/README.md @@ -9,6 +9,20 @@ Kubectl plugin/extension for Kuberay CLI that provides the ability to manage ray ## Installation +### Download from GitHub releases + +Go to the [releases page](https://github.com/ray-project/kuberay/releases) and download the binary for your platform. + +For example, to install kubectl plugin version 1.2.2 on Linux amd64: + +```bash +curl -LO https://github.com/ray-project/kuberay/releases/download/v1.2.2/kubectl-ray_v1.2.2_linux_amd64.tar.gz +tar -xvf kubectl-ray_v1.2.2_linux_amd64.tar.gz +cp kubectl-ray ~/.local/bin +``` + +Replace `~/.local/bin` with the directory in your `PATH`. + ### Compiling from source 1. Run `go build cmd/kubectl-ray.go`