From 129730ff1f49600bc1da28eaf36e91f6d0c0b381 Mon Sep 17 00:00:00 2001 From: "Paul S. Schweigert" Date: Mon, 6 Feb 2023 11:59:58 -0500 Subject: [PATCH 1/4] update apiserver chart location in readme Signed-off-by: Paul S. Schweigert --- apiserver/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apiserver/README.md b/apiserver/README.md index d84723bfd8..b947a0859c 100644 --- a/apiserver/README.md +++ b/apiserver/README.md @@ -74,7 +74,7 @@ EOF 1. Deploy the KubeRay APIServer within the same cluster of KubeRay operator ```bash -helm -n ray-system install kuberay-apiserver kuberay/helm-chart/kuberay-apiserver +helm -n ray-system install kuberay-apiserver kuberay/kuberay-apiserver ``` 2. The APIServer expose service using `NodePort` by default. You can test access by your host and port, the default port is set to `31888`. From 4f9e0550d774c4692f967eb89b5753af671f386e Mon Sep 17 00:00:00 2001 From: "Paul S. Schweigert" Date: Tue, 7 Feb 2023 09:33:16 -0500 Subject: [PATCH 2/4] reviewer feedback Signed-off-by: Paul S. Schweigert --- apiserver/README.md | 58 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 56 insertions(+), 2 deletions(-) diff --git a/apiserver/README.md b/apiserver/README.md index b947a0859c..640d35f6b3 100644 --- a/apiserver/README.md +++ b/apiserver/README.md @@ -18,10 +18,63 @@ The KubeRay APIServer provides gRPC and HTTP APIs to manage KubeRay resources. KubeRay APIServer maintainer contacts (GitHub handles): @Jeffwan @scarlet25151 +## Installation -## Usage +### Helm + +Make sure the version of Helm is v3+. Currently, [existing CI tests](https://github.com/ray-project/kuberay/blob/master/.github/workflows/helm-lint.yaml) are based on Helm v3.4.1 and v3.9.4. + +```sh +helm version +``` + +### Install KubeRay APIServer + +* Install a stable version via Helm repository (only supports KubeRay v0.4.0+) + ```sh + helm repo add kuberay https://ray-project.github.io/kuberay-helm/ + + # Install both KubeRay APIServer v0.4.0. + helm install kuberay-apiserver kuberay/kuberay-apiserver --version 0.4.0 + + # Check the KubeRay APIServer Pod in `default` namespace + kubectl get pods + # NAME READY STATUS RESTARTS AGE + # kuberay-apiserver-67b46b88bf-m7dzg 1/1 Running 0 6s + ``` + +* Install the nightly version + ```sh + # Step1: Clone KubeRay repository + + # Step2: Move to `helm-chart/kuberay-apiserver` -You can install the KubeRay APIServer by using the [helm chart](https://github.com/ray-project/kuberay/tree/master/helm-chart/kuberay-apiserver) or [kustomize](https://github.com/ray-project/kuberay/tree/master/apiserver/deploy/base) + # Step3: Install KubeRay operator + helm install kuberay-apiserver . + ``` + +### List the chart + +To list the `my-release` deployment: + +```sh +helm ls +# NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION +# kuberay-apiserver default 1 2023-02-07 09:28:15.510869781 -0500 EST deployedkuberay-apiserver-0.4.0 +``` + +### Uninstall the Chart + +```sh +# Uninstall the `kuberay-operator` release +helm uninstall kuberay-apiserver + +# The operator Pod should be removed. +kubectl get pods +# No resources found in default namespace. +``` + +## Usage After the deployment we may use the `{{baseUrl}}` to access the @@ -74,6 +127,7 @@ EOF 1. Deploy the KubeRay APIServer within the same cluster of KubeRay operator ```bash +helm repo add kuberay https://ray-project.github.io/kuberay-helm/ helm -n ray-system install kuberay-apiserver kuberay/kuberay-apiserver ``` From 1d3daf2f161695ea2340083e040cc3ab0ad70321 Mon Sep 17 00:00:00 2001 From: "Paul S. Schweigert" Date: Wed, 8 Feb 2023 08:06:46 -0500 Subject: [PATCH 3/4] typo Signed-off-by: Paul S. Schweigert --- apiserver/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apiserver/README.md b/apiserver/README.md index 640d35f6b3..26427e099d 100644 --- a/apiserver/README.md +++ b/apiserver/README.md @@ -34,7 +34,7 @@ helm version ```sh helm repo add kuberay https://ray-project.github.io/kuberay-helm/ - # Install both KubeRay APIServer v0.4.0. + # Install KubeRay APIServer v0.4.0. helm install kuberay-apiserver kuberay/kuberay-apiserver --version 0.4.0 # Check the KubeRay APIServer Pod in `default` namespace From c92f934f19c3709e1c667c58d87a73754862a1b4 Mon Sep 17 00:00:00 2001 From: "Paul S. Schweigert" Date: Fri, 10 Feb 2023 09:40:14 -0500 Subject: [PATCH 4/4] reviewer comments Signed-off-by: Paul S. Schweigert --- apiserver/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/apiserver/README.md b/apiserver/README.md index 26427e099d..54c3d7f369 100644 --- a/apiserver/README.md +++ b/apiserver/README.md @@ -49,7 +49,7 @@ helm version # Step2: Move to `helm-chart/kuberay-apiserver` - # Step3: Install KubeRay operator + # Step3: Install KubeRay APIServer helm install kuberay-apiserver . ``` @@ -66,10 +66,10 @@ helm ls ### Uninstall the Chart ```sh -# Uninstall the `kuberay-operator` release +# Uninstall the `kuberay-apiserver` release helm uninstall kuberay-apiserver -# The operator Pod should be removed. +# The KubeRay APIServer Pod should be removed. kubectl get pods # No resources found in default namespace. ```