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.

Sign up for GitHub

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

Update apiserver chart location in readme #896

Merged
merged 4 commits into from
Feb 25, 2023
Merged

Update apiserver chart location in readme #896

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
129730f
update apiserver chart location in readme
psschwei Feb 6, 2023
4f9e055
reviewer feedback
psschwei Feb 7, 2023
1d3daf2
typo
psschwei Feb 8, 2023
c92f934
reviewer comments
psschwei Feb 10, 2023
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
60 changes: 57 additions & 3 deletions apiserver/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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 APIServer
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-apiserver` release
helm uninstall kuberay-apiserver

# The KubeRay APIServer 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

Expand Down Expand Up @@ -74,7 +127,8 @@ 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 repo add kuberay https://ray-project.github.io/kuberay-helm/
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`.
Expand Down