Skip to content

Latest commit

 

History

History
108 lines (78 loc) · 3.07 KB

getting-started.rst

File metadata and controls

108 lines (78 loc) · 3.07 KB
Raw

Ray Clusters Overview

Key Concepts <key-concepts> Deploying on Kubernetes <kubernetes/index> Deploying on VMs <vms/index> metrics configure-manage-dashboard Applications Guide <running-applications/index> faq package-overview usage-stats

Ray enables seamless scaling of workloads from a laptop to a large cluster. While Ray works out of the box on single machines with just a call to ray.init, to run Ray applications on multiple nodes you must first deploy a Ray cluster.

A Ray cluster is a set of worker nodes connected to a common Ray head node <cluster-head-node>. Ray clusters can be fixed-size, or they may autoscale up and down <cluster-autoscaler> according to the resources requested by applications running on the cluster.

Where can I deploy Ray clusters?

Ray provides native cluster deployment support on the following technology stacks:

  • On AWS and GCP <cloud-vm-index>. Community-supported Azure, Aliyun and vSphere integrations also exist.
  • On Kubernetes <kuberay-index>, via the officially supported KubeRay project.

Advanced users may want to deploy Ray manually <on-prem> or onto platforms not listed here <ref-cluster-setup>.

Note

Multi-node Ray clusters are only supported on Linux. At your own risk, you may deploy Windows and OSX clusters by setting the environment variable RAY_ENABLE_WINDOWS_OR_OSX_CLUSTER=1 during deployment.

What's next?

1 2 2 2

I want to learn key Ray cluster concepts ^^^ Understand the key concepts and main ways of interacting with a Ray cluster.

+++ .. button-ref:: cluster-key-concepts :color: primary :outline: :expand:

Learn Key Concepts

I want to run Ray on Kubernetes ^^^ Deploy a Ray application to a Kubernetes cluster. You can run the tutorial on a Kubernetes cluster or on your laptop via Kind.

+++ .. button-ref:: kuberay-quickstart :color: primary :outline: :expand:

Get Started with Ray on Kubernetes

I want to run Ray on a cloud provider ^^^ Take a sample application designed to run on a laptop and scale it up in the cloud. Access to an AWS or GCP account is required.

+++ .. button-ref:: vm-cluster-quick-start :color: primary :outline: :expand:

Get Started with Ray on VMs

I want to run my application on an existing Ray cluster ^^^ Guide to submitting applications as Jobs to existing Ray clusters.

+++ .. button-ref:: jobs-quickstart :color: primary :outline: :expand:

Job Submission