* Add RayJob docs and development docs * Address code review feedbacks
2.6 KiB
KubeRay
KubeRay is an open source toolkit to run Ray applications on Kubernetes. It provides several tools to improve running and managing Ray 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/
Quick Start
Use Yaml
Please choose the version you like to install. We will use nightly version master as an example
| Version | Stable | Suggested Kubernetes Version |
|---|---|---|
| master | N | v1.23 and above |
| v0.2.0 | Yes | v1.19 - 1.22 |
export KUBERAY_VERSION=master
kubectl create -k "github.com/ray-project/kuberay/manifests/cluster-scope-resources?ref=${KUBERAY_VERSION}"
kubectl apply -k "github.com/ray-project/kuberay/manifests/base?ref=${KUBERAY_VERSION}"
Observe that we must use
kubectl createto install cluster-scoped resources. The correspondingkubectl applycommand will not work. See KubeRay issue #271.
Use helm chart
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.