diff --git a/doc/source/_toc.yml b/doc/source/_toc.yml index 625f4b9c4..425e63b4c 100644 --- a/doc/source/_toc.yml +++ b/doc/source/_toc.yml @@ -253,6 +253,16 @@ parts: - file: cluster/key-concepts - file: cluster/user-guide - file: cluster/cloud + - file: cluster/kuberay + sections: + - file: cluster/kuberay/quickstart + - file: cluster/kuberay/config + - file: cluster/kuberay/k8s-cluster-setup + - file: cluster/kuberay/logging + - file: cluster/kuberay/networking + - file: cluster/kuberay/gpu + - file: cluster/kuberay/ml-example + - file: cluster/kuberay/kuberay-vs-legacy - file: cluster/deploy - file: cluster/api - file: cluster/usage-stats @@ -268,14 +278,7 @@ parts: sections: - file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/getting-started - file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides - sections: - - file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/config.md - - file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/gpu.md - - file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/networking.md - - file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/kuberay-vs-legacy.md - file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/examples - sections: - - file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/examples/ml-example.md - file: cluster/cluster_under_construction/ray-clusters-on-kubernetes/references - file: cluster/cluster_under_construction/ray-clusters-on-vms/index title: Ray Clusters on VMs diff --git a/doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/getting-started.md b/doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/getting-started.md new file mode 100644 index 000000000..f27cf622f --- /dev/null +++ b/doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/getting-started.md @@ -0,0 +1,4 @@ +# Getting Started +:::{warning} +This page is under construction! +::: diff --git a/doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/index.md b/doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/index.md index 39d61e697..b2ed9de33 100644 --- a/doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/index.md +++ b/doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/index.md @@ -1,40 +1,4 @@ -# Ray on Kubernetes -(kuberay-index)= -## Overview - -You can execute your distributed Ray programs on a Kubernetes cluster. - -The [KubeRay Operator](https://ray-project.github.io/kuberay/components/operator/) provides a Kubernetes-native -interface for managing Ray clusters. Each Ray cluster consist of a head pod and collection of worker 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. - -## Learn More - -The Ray docs present all the information you need to start running Ray workloads on Kubernetes. - -```{eval-rst} -.. 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 -``` -## The KubeRay project - -Ray's Kubernetes support is developed at the [KubeRay GitHub repository](https://github.com/ray-project/kuberay), under the broader [Ray project](https://github.com/ray-project/). - -- Visit the [KubeRay GitHub repo](https://github.com/ray-project/kuberay) to track progress, report bugs, propose new features, or contribute to -the project. -- Check out the [KubeRay docs](https://ray-project.github.io/kuberay/) for further technical information, developer guides, -and discussion of new and upcoming features. +# Index +:::{warning} +This page is under construction! +::: diff --git a/doc/source/cluster/kuberay.md b/doc/source/cluster/kuberay.md new file mode 100644 index 000000000..39d61e697 --- /dev/null +++ b/doc/source/cluster/kuberay.md @@ -0,0 +1,40 @@ +# Ray on Kubernetes +(kuberay-index)= +## Overview + +You can execute your distributed Ray programs on a Kubernetes cluster. + +The [KubeRay Operator](https://ray-project.github.io/kuberay/components/operator/) provides a Kubernetes-native +interface for managing Ray clusters. Each Ray cluster consist of a head pod and collection of worker 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. + +## Learn More + +The Ray docs present all the information you need to start running Ray workloads on Kubernetes. + +```{eval-rst} +.. 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 +``` +## The KubeRay project + +Ray's Kubernetes support is developed at the [KubeRay GitHub repository](https://github.com/ray-project/kuberay), under the broader [Ray project](https://github.com/ray-project/). + +- Visit the [KubeRay GitHub repo](https://github.com/ray-project/kuberay) to track progress, report bugs, propose new features, or contribute to +the project. +- Check out the [KubeRay docs](https://ray-project.github.io/kuberay/) for further technical information, developer guides, +and discussion of new and upcoming features. diff --git a/doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/config.md b/doc/source/cluster/kuberay/config.md similarity index 100% rename from doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/config.md rename to doc/source/cluster/kuberay/config.md diff --git a/doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/gpu.md b/doc/source/cluster/kuberay/gpu.md similarity index 100% rename from doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/gpu.md rename to doc/source/cluster/kuberay/gpu.md diff --git a/doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/k8s-cluster-setup.md b/doc/source/cluster/kuberay/k8s-cluster-setup.md similarity index 100% rename from doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/k8s-cluster-setup.md rename to doc/source/cluster/kuberay/k8s-cluster-setup.md diff --git a/doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/kuberay-vs-legacy.md b/doc/source/cluster/kuberay/kuberay-vs-legacy.md similarity index 100% rename from doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/kuberay-vs-legacy.md rename to doc/source/cluster/kuberay/kuberay-vs-legacy.md diff --git a/doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/logging.md b/doc/source/cluster/kuberay/logging.md similarity index 100% rename from doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/logging.md rename to doc/source/cluster/kuberay/logging.md diff --git a/doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/examples/ml-example.md b/doc/source/cluster/kuberay/ml-example.md similarity index 100% rename from doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/examples/ml-example.md rename to doc/source/cluster/kuberay/ml-example.md diff --git a/doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/networking.md b/doc/source/cluster/kuberay/networking.md similarity index 100% rename from doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/user-guides/networking.md rename to doc/source/cluster/kuberay/networking.md diff --git a/doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/getting-started.ipynb b/doc/source/cluster/kuberay/quickstart.ipynb similarity index 100% rename from doc/source/cluster/cluster_under_construction/ray-clusters-on-kubernetes/getting-started.ipynb rename to doc/source/cluster/kuberay/quickstart.ipynb