Files
kuberay/docs/development/development.md
Dmitri GekhtmanandGitHub a8ec758565 [APIServer][Docs] Identify API server as community-managed and optional (#753)
There's some user confusion concerning whether the KubeRay API Server and KubeRay CLI are required components.
This PR adds some clarifying notes and adds maintainer contacts (@Jeffwan @scarlet25151).

Signed-off-by: Dmitri Gekhtman <[email protected]>
2022-11-22 11:51:27 -08:00

953 B

KubeRay Development Guidance

Download this repo locally

mkdir -p $GOPATH/src/github.com/ray-project
cd $GOPATH/src/github.com/ray-project
git clone https://github.com/ray-project/kuberay.git

Develop proto and OpenAPI

Generate go clients and swagger file

make generate

Develop KubeRay Operator

cd ray-operator

# Build codes
make build

# Run test
make test

# Build container image
make docker-build

Develop KubeRay APIServer

cd apiserver

# Build code
go build cmd/main.go

Develop KubeRay CLI

cd cli
go build -o kuberay -a main.go
./kuberay help

Deploy Docs locally

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

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