ray/doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/index.md
Philipp Moritz 64fc1155b7
[docs] K8s docs intro polish and KubeRay architecture diagram (#27488)
* Save work

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* Update

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* consistency

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* update

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* fixes

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* simplify

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* update

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* fix

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* update

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* wording

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>

* update

Signed-off-by: Philipp Moritz <pcmoritz@gmail.com>
2022-08-04 10:07:15 -07:00

2.7 KiB

Ray on Kubernetes

(kuberay-index)=

Overview

In this section we cover how to execute your distributed Ray programs on a Kubernetes cluster.

Using the KubeRay Operator is the recommended way to do so. The operator provides a Kubernetes-native way to manage Ray clusters. Each Ray cluster consists of a head node pod and a collection of worker node pods. Optional autoscaling support allows the KubeRay Operator to size your Ray clusters according to the requirements of your Ray workload, adding and removing Ray pods as needed. KubeRay supports heterogenous compute nodes (including GPUs) as well as running multiple Ray clusters with different Ray versions in the same Kubernetes cluster.

.. image:: /cluster/cluster_under_construction/ray-clusters-on-kubernetes/images/ray_on_kubernetes.png
    :align: center

..
  https://docs.google.com/drawings/d/1E3FQgWWLuj8y2zPdKXjoWKrfwgYXw6RV_FWRwK8dVlg/edit

Concretely you will learn how to:

  • Set up and configure Ray on a Kubernetes cluster
  • Deploy and monitor Ray applications
  • Integrate Ray applications with Kubernetes networking

Learn More

The Ray docs present all the information you need to start running Ray workloads on Kubernetes.

.. panels::
    :container: text-center
    :column: col-lg-12 p-2
    :card:

    **Getting Started**
    ^^^

    Learn how to start a Ray cluster and deploy Ray applications on Kubernetes.

    +++
    .. link-button:: kuberay-quickstart
        :type: ref
        :text: Get Started with Ray on Kubernetes
        :classes: btn-outline-info btn-block
    ---
    **Examples**
    ^^^

    Try example Ray workloads on Kubernetes.

    +++
    .. link-button:: kuberay-examples
        :type: ref
        :text: Example workloads
        :classes: btn-outline-info btn-block
    ---
    **User Guides**
    ^^^

    Learn best practices for configuring Ray clusters on Kubernetes.

    +++
    .. link-button:: kuberay-guides
        :type: ref
        :text: User Guides
        :classes: btn-outline-info btn-block

The KubeRay project

Ray's Kubernetes support is developed at the KubeRay GitHub repository, under the broader Ray project. KubeRay is used by several companies to run production Ray deployments.

  • Visit the KubeRay GitHub repo to track progress, report bugs, propose new features, or contribute to the project.
  • Check out the KubeRay docs for further technical information, developer guides, and discussion of new and upcoming features.