Skip to content

Commit

Permalink
[Doc] Remove KubeRay CLI references and add Python client details (ra…
Browse files Browse the repository at this point in the history
…y-project#2521)

Signed-off-by: Dongjun Na <[email protected]>
  • Loading branch information
nadongjun authored Dec 4, 2024
1 parent 3c8904c commit 73eef73
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 9 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ by some organizations to back user interfaces for KubeRay resource management.

* **KubeRay Python client**: This Python client library provides APIs to handle RayCluster from your Python application.

* **KubeRay CLI**: KubeRay CLI provides the ability to manage KubeRay resources through command-line interface.

## Documentation

From September 2023, all user-facing KubeRay documentation will be hosted on the [Ray documentation](https://docs.ray.io/en/latest/cluster/kubernetes/index.html).
Expand Down
1 change: 1 addition & 0 deletions docs/components/pythonapiclient.md
1 change: 1 addition & 0 deletions docs/components/pythonclient.md
6 changes: 2 additions & 4 deletions docs/development/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,8 @@ To learn more about developing and testing the KubeRay Operator, please refer to
The KubeRay APIServer is a central component that exposes the KubeRay API for managing Ray clusters.
For more information about developing and testing the KubeRay APIServer, please refer to the [APIServer Development Guide](https://github.com/ray-project/kuberay/blob/master/apiserver/DEVELOPMENT.md).

## KubeRay CLI

The KubeRay CLI is a command-line interface for interacting with Ray clusters managed by KubeRay.
For more information about developing and testing the KubeRay CLI, please refer to the [CLI Development Guide](https://github.com/ray-project/kuberay/blob/master/cli/README.md).
## KubeRay Python client
The KubeRay Python client library provides APIs to handle RayCluster from your Python application. For more information about developing and testing the KubeRay Python client, please refer to the [Python Client](https://github.com/ray-project/kuberay/blob/master/components/pythonclient.md), [Python API Client](https://github.com/ray-project/kuberay/blob/master/components/pythonapiclient.md).

## Proto and OpenAPI

Expand Down
2 changes: 0 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,6 @@ by some organizations to back user interfaces for KubeRay resource management.

* **KubeRay Python client**: This Python client library provides APIs to handle RayCluster from your Python application.

* **KubeRay CLI**: KubeRay CLI provides the ability to manage KubeRay resources through command-line interface.

## KubeRay ecosystem

* [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)
Expand Down
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ nav:
- Components:
- KubeRay Operator: components/operator.md
- KubeRay API Server: components/apiserver.md
- KubeRay CLI: components/cli.md
- KubeRay Python Client: components/pythonclient.md
- KubeRay Python API Client: components/pythonapiclient.md
- Features:
- RayService: guidance/rayservice.md
- RayJob: guidance/rayjob.md
Expand Down

0 comments on commit 73eef73

Please sign in to comment.