Files
kuberay/README.md
Dmitri GekhtmanandGitHub f0abc1d1fa [0.4.0 Release] Minor doc improvements (#780)
Minor improvements to the docs ahead of the release.
I verified that all instructions in the edited files works as expected with master branch configs.

Signed-off-by: Dmitri Gekhtman <[email protected]>
2022-12-01 20:37:04 -08:00

2.9 KiB

KubeRay

Build Status Go Report Card

KubeRay is an open source toolkit to run Ray applications on Kubernetes. It provides several tools to simplify managing Ray clusters on Kubernetes.

  • Ray Operator
  • Backend services to create/delete cluster resources
  • Kubectl plugin/CLI to operate CRD objects
  • Native Job and Serving integration with Clusters
  • Data Scientist centric workspace for fast prototyping (incubating)
  • Kubernetes event dumper for ray clusters/pod/services (future work)
  • Operator Integration with Kubernetes node problem detector (future work)

Documentation

You can view detailed documentation and guides at https://ray-project.github.io/kuberay/.

We also recommend checking out the official Ray guides for deploying on Kubernetes at https://docs.ray.io/en/latest/cluster/kubernetes/index.html.

Quick Start

Use YAML

Please choose the version you would like to install. The example below uses the latest stable version v0.3.0.

Version Stable Suggested Kubernetes Version
master N v1.19 - v1.24
v0.3.0 Y v1.19 - v1.24

Make sure your Kubernetes and Kubectl versions are both within the suggested range.

export KUBERAY_VERSION=v0.3.0
kubectl create -k "github.com/ray-project/kuberay/manifests/cluster-scope-resources?ref=${KUBERAY_VERSION}&timeout=90s"
kubectl apply -k "github.com/ray-project/kuberay/manifests/base?ref=${KUBERAY_VERSION}&timeout=90s"

Observe that we must use kubectl create to install cluster-scoped resources. The corresponding kubectl apply command will not work. See KubeRay issue #271.

Use Helm

A helm chart is a collection of files that describe a related set of Kubernetes resources. It can help users to deploy ray-operator and ray clusters conveniently. Please read kuberay-operator to deploy an operator and ray-cluster to deploy a custom cluster.

Development

Please read our CONTRIBUTING guide before making a pull request. Refer to our DEVELOPMENT to build and run tests locally.

Security

If you discover a potential security issue in this project, or think you may have discovered a security issue, we ask that you notify KubeRay Security via our Slack Channel. Please do not create a public GitHub issue.

License

This project is licensed under the Apache-2.0 License.