hiro/ray
1
0
Fork 0
mirror of https://github.com/vale981/ray synced 2025-03-13 22:56:38 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
ray/doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/index.md
Dmitri Gekhtman 3293317c40
[kubernetes][docs] Logging guide, networking info, migration guide, fixes. (#27607) 
This PR

Adds notes and example on logging for Ray/K8s.
Implements an API Reference paging pointing to the configuration guide and the RayCluster CR definition.
Takes managed K8s services out of the tabbed structure, to make that page look less sad.
Adds a comparison of the KubeRay operator and legacy K8s operator
Adds an architecture diagram for the autoscaling sections
Fixes some other minor items
Adds some info about networking to the configuration guide, removes the previously planned networking page

Signed-off-by: Dmitri Gekhtman <dmitri.m.gekhtman@gmail.com>
2022-08-09 00:38:05 -07:00

2.9 KiB
Raw Blame History

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
..
  Find source document here: 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: Try 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: Read the User Guides
        :classes: btn-outline-info btn-block
    ---
    **API Reference**
    ^^^

    Find API references on RayCluster configuration.

    +++
    .. link-button:: kuberay-api-reference
        :type: ref
        :text: Check API references
        :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.