Skip to content

Commit

Permalink
Fix Helm chart default configuration (ray-project#530)
Browse files Browse the repository at this point in the history
Fix default Helm configuration.
  • Loading branch information
kevin85421 authored Sep 2, 2022
1 parent e643386 commit efa9b40
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 9 deletions.
4 changes: 2 additions & 2 deletions helm-chart/kuberay-operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ version.BuildInfo{Version:"v3.6.2", GitCommit:"ee407bdf364942bcb8e8c665f82e15aa2

To avoid duplicate CRD definitions in this repo, we reuse CRD config in `ray-operator`:
```console
$ kubectl create -k "github.com/ray-project/kuberay/ray-operator/config/crd?ref=v0.3.0"
$ kubectl create -k "github.com/ray-project/kuberay/ray-operator/config/crd?ref=v0.3.0&timeout=90s"
```
> Note that we must use `kubectl create` to install the CRDs.
> The corresponding `kubectl apply` command will not work. See [KubeRay issue #271](https://github.com/ray-project/kuberay/issues/271).
Expand All @@ -33,7 +33,7 @@ $ helm install kuberay-operator --namespace ray-system --create-namespace $(curl
To list the `my-release` deployment:

```console
$ helm list -n kuberay-operator
$ helm list -n ray-system
```

## Uninstalling the Chart
Expand Down
18 changes: 14 additions & 4 deletions helm-chart/ray-cluster/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,25 @@ version.BuildInfo{Version:"v3.6.2", GitCommit:"ee407bdf364942bcb8e8c665f82e15aa2

## TL;DR;

```console
$ helm install ray-cluster --namespace ray-system --create-namespace https://github.com/ray-project/kuberay/releases/download/v0.3.0/helm-chart-ray-cluster-0.1.0.tgz
```bash
# Because the ray-cluster chart in release 0.3.0 has some bugs, we need to clone the KubeRay repo and install the latest ray-cluster chart until release 0.4.0.
cd helm-chart/ray-cluster
helm install ray-cluster --namespace ray-system --create-namespace .

# Not working until release 0.4.0.
helm install ray-cluster --namespace ray-system --create-namespace https://github.com/ray-project/kuberay/releases/download/v0.4.0/helm-chart-ray-cluster-0.4.0.tgz
```

## Installing the Chart

To install the chart with the release name `my-release`:
```console
$ helm install my-release --namespace ray-system --create-namespace https://github.com/ray-project/kuberay/releases/download/v0.3.0/helm-chart-ray-cluster-0.1.0.tgz
```bash
# Because the ray-cluster chart in release 0.3.0 has some bugs, we need to clone the KubeRay repo and install the latest ray-cluster chart until release 0.4.0.
cd helm-chart/ray-cluster
helm install my-release --namespace ray-system --create-namespace .

# Not working until release 0.4.0.
helm install my-release --namespace ray-system --create-namespace https://github.com/ray-project/kuberay/releases/download/v0.4.0/helm-chart-ray-cluster-0.4.0.tgz
```

> note: The chart will submit a RayCluster.
Expand Down
6 changes: 3 additions & 3 deletions helm-chart/ray-cluster/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

image:
repository: rayproject/ray
tag: latest
tag: 2.0.0
pullPolicy: IfNotPresent

nameOverride: "ray"
nameOverride: "kuberay"
fullnameOverride: ""

imagePullSecrets: []
Expand Down Expand Up @@ -38,7 +38,7 @@ head:
limits:
cpu: 1
requests:
cpu: 200m
cpu: 1
annotations: {}
nodeSelector: {}
tolerations: []
Expand Down

0 comments on commit efa9b40

Please sign in to comment.