mirror of
https://github.com/hanzo-ml/kuberay.git
synced 2026-10-30 19:48:47 +00:00
Kuberay Kubectl Plugin
Kubectl plugin/extension for Kuberay CLI that provides the ability to manage ray resources.
Prerequisites
- Make sure there is a Kubernetes cluster running with KubeRay installed.
- Make sure
kubectlhas the right context.
Installation
You can install the Kuberay kubectl plugin using one of the following methods:
Install using Krew kubectl plugin manager (Recommended)
- Install Krew.
- Download the plugin list by running
kubectl krew update. - Install the plugin by running
kubectl krew install ray. - Run
kubectl ray --helpto verify the installation.
Download from GitHub releases
Go to the releases page and download the binary for your platform.
For example, to install kubectl plugin version 1.2.2 on Linux amd64:
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
- Run
go build cmd/kubectl-ray.go - Move the binary, which will be named
kubectl-rayto yourPATH
Shell Completion
- Install kubectl plugin-completion plugin.
- Run
kubectl plugin-completion generate. - Add
$HOME/.kubectl-plugin-completiontoPATHin your shell profile.