Skip to content

Commit a1e02ea

Browse files
authored
[doc] Update GitHub pages's home page (#3761)
Signed-off-by: kaihsun <[email protected]>
1 parent 0769a46 commit a1e02ea

File tree

1 file changed

+12
-24
lines changed

1 file changed

+12
-24
lines changed

docs/index.md

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,14 @@
1818
<img src="https://img.shields.io/github/watchers/ray-project/kuberay?style=social" alt="github watchers"/>
1919
<img src="https://img.shields.io/github/stars/ray-project/kuberay?style=social" alt="github stars"/>
2020
<img src="https://img.shields.io/github/forks/ray-project/kuberay?style=social" alt="github forks"/>
21-
<a href="https://hub.docker.com/r/kuberay/operator/">
22-
<img src="https://img.shields.io/docker/pulls/kuberay/operator" alt="docker pulls"/>
23-
</a>
2421
</p>
2522

2623
## KubeRay
2724

25+
> We have moved all documentation to the [ray-project/ray](https://github.com/ray-project/ray) repository.
26+
Please refer to the [Ray docs](https://docs.ray.io/en/latest/cluster/kubernetes/index.html) for the latest information.
27+
The [ray-project/kuberay](https://github.com/ray-project/kuberay) repository hosts the KubeRay source code and community information.
28+
2829
KubeRay is a powerful, open-source Kubernetes operator that simplifies the deployment and management of [Ray](https://github.com/ray-project/ray) applications on Kubernetes. It offers several key components:
2930

3031
**KubeRay core**: This is the official, fully-maintained component of KubeRay that provides three custom resource definitions, RayCluster, RayJob, and RayService. These resources are designed to help you run a wide range of workloads with ease.
@@ -35,27 +36,14 @@ KubeRay is a powerful, open-source Kubernetes operator that simplifies the deplo
3536

3637
* **RayService**: RayService is made up of two parts: a RayCluster and a Ray Serve deployment graph. RayService offers zero-downtime upgrades for RayCluster and high availability.
3738

38-
**Community-managed components (optional)**: Some components are maintained by the KubeRay community.
39-
40-
* **KubeRay APIServer**: It provides a layer of simplified configuration for KubeRay resources. The KubeRay API server is used internally
41-
by some organizations to back user interfaces for KubeRay resource management.
42-
43-
* **KubeRay Python client**: This Python client library provides APIs to handle RayCluster from your Python application.
39+
**KubeRay ecosystem**: Some optional components.
4440

45-
## KubeRay ecosystem
41+
* **Kubectl Plugin** (Beta): Starting from KubeRay v1.3.0, you can use the `kubectl ray` plugin to simplify
42+
common workflows when deploying Ray on Kubernetes. If you aren’t familiar with Kubernetes, this
43+
plugin simplifies running Ray on Kubernetes. See [kubectl-plugin](https://docs.ray.io/en/latest/cluster/kubernetes/user-guides/kubectl-plugin.html#kubectl-plugin) for more details.
4644

47-
* [AWS Application Load Balancer](https://docs.ray.io/en/master/cluster/kubernetes/k8s-ecosystem/ingress.html#aws-application-load-balancer-alb-ingress-support-on-aws-eks)
48-
* [Nginx](https://docs.ray.io/en/master/cluster/kubernetes/k8s-ecosystem/ingress.html#manually-setting-up-nginx-ingress-on-kind)
49-
* [Prometheus and Grafana](https://docs.ray.io/en/master/cluster/kubernetes/k8s-ecosystem/prometheus-grafana.html#kuberay-prometheus-grafana)
50-
* [Volcano](https://docs.ray.io/en/master/cluster/kubernetes/k8s-ecosystem/volcano.html)
51-
* [MCAD](guidance/kuberay-with-MCAD.md)
52-
53-
## Security
54-
55-
**Security and isolation must be enforced outside of the Ray Cluster.** Restrict network access with Kubernetes or other external controls. Refer to [**Ray security documentation**](https://docs.ray.io/en/master/ray-security/index.html) for more guidance on what controls to implement.
56-
57-
Please report security issues to <[email protected]>.
58-
59-
## The Ray docs
45+
* **KubeRay APIServer** (Alpha): It provides a layer of simplified configuration for KubeRay resources. The KubeRay API server is used internally
46+
by some organizations to back user interfaces for KubeRay resource management.
6047

61-
You can find even more information on deployments of Ray on Kubernetes at the [official Ray docs](https://docs.ray.io/en/latest/cluster/kubernetes/index.html).
48+
* **KubeRay Dashboard** (Experimental): Starting from KubeRay v1.4.0, we have introduced a new dashboard that enables users to view and manage KubeRay resources.
49+
While it is not yet production-ready, we welcome your feedback.

0 commit comments

Comments
 (0)