Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[APIServer][Docs] Identify API server as community-managed and optional #753

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions apiserver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
# KubeRay APIServer
# KubeRay ApiServer

The KubeRay ApiServer provides gRPC and HTTP APIs to manage KubeRay resources.

!!! note

The KubeRay ApiServer is an optional component. It provides a layer of simplified
configuration for KubeRay resources. The KubeRay API server is used internally
by some organizations to back user interfaces for KubeRay resource management.

The KubeRay ApiServer is community-managed and is not officially endorsed by the
Ray maintainers. At this time, the only officially supported methods for
managing KubeRay resources are

- Direct management of KubeRay custom resources via kubectl, kustomize, and Kubernetes language clients.
- Helm charts.

KubeRay ApiServer maintainer contacts (GitHub handles):
@Jeffwan @scarlet25151

KubeRay APIServer provides the gRPC and HTTP API to manage kuberay resources.

## Usage

Expand Down
15 changes: 15 additions & 0 deletions cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@

KubeRay CLI provides the ability to manage kuberay resources (ray clusters, compute templates etc) through command line interface.

!!! note

The KubeRay CLI is an optional interface backed by the KubeRay API server.
It provides a layer of simplified configuration for KubeRay resources.

The KubeRay CLI is community-managed and is not officially endorsed by the
Ray maintainers. At this time, the only officially supported methods for
managing KubeRay resources are

- Direct management of KubeRay custom resources via kubectl, kustomize, and Kubernetes language clients.
- Helm charts.

KubeRay CLI maintainer contacts (GitHub handles):
@Jeffwan @scarlet25151

## Installation

Please check [release page](https://github.com/ray-project/kuberay/releases) and download the binaries.
Expand Down
5 changes: 3 additions & 2 deletions docs/development/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,11 @@ go build -o kuberay -a main.go

### Deploy Docs locally

We don't need to configure `mkdocs` environment. To check the static website locally, run the command
We don't need to configure `mkdocs` environment. To check the static website locally, run
the following command from the root of your clone of the KubeRay repo:

```
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
```

and access `http://0.0.0.0:8000/kuberay/` in your web browser.
Then access `http://0.0.0.0:8000/kuberay/` in your web browser.