diff --git a/apiserver/README.md b/apiserver/README.md index 393ba5e11f8..d6e9be2cb2e 100644 --- a/apiserver/README.md +++ b/apiserver/README.md @@ -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 diff --git a/cli/README.md b/cli/README.md index 12f706ccd80..6baf03a5d92 100644 --- a/cli/README.md +++ b/cli/README.md @@ -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. diff --git a/docs/development/development.md b/docs/development/development.md index 1e3a6f9fe9d..5303e7ebbd9 100644 --- a/docs/development/development.md +++ b/docs/development/development.md @@ -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.