/kuberay

A toolkit to run Ray applications on Kubernetes

Primary LanguageGoApache License 2.0Apache-2.0

KubeRay

Build Status Go Report Card

KubeRay is an open source toolkit to run Ray applications on Kubernetes.

KubeRay provides several tools to improve running and managing Ray's experience on Kubernetes.

  • Ray Operator
  • Backend services to create/delete cluster resources (incubating)
  • Kubectl plugin/CLI to operate CRD objects (future work)
  • Kubernetes event dumper for ray clusters/pod/services (future work)
  • Operator Integration with Kubernetes node problem detector (future work)
  • Kubernetes based workspace to easily submit ray jobs (future work)

Quick Start

Use Yaml

kubectl apply -k manifests/cluster-scope-resources
kubectl apply -k manifests/base

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.

Setup on Kind

For a local kind environment setup, you can follow the Jupyter Notebook example: KubeRay-on-kind.

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.