Skip to content

Commit

Permalink
Improve the Helm charts docs
Browse files Browse the repository at this point in the history
fix typo
  • Loading branch information
haoxins committed Jan 23, 2022
1 parent 34d71e8 commit 5a44546
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions helm-chart/kubray-operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,23 @@ version.BuildInfo{Version:"v3.6.2", GitCommit:"ee407bdf364942bcb8e8c665f82e15aa2

Please use command below:
```console
$ helm install kubray-operator . --values values.yaml --namespace default --create-namespace
$ helm install kuberay-operator . --values values.yaml --namespace kuberay-operator --create-namespace
```
## List the Chart

To list the `my-release` deployment:

```console
$ helm list -n default
$ helm list -n kuberay-operator
```

## Uninstalling the Chart

To uninstall/delete the `my-release` deployment:

```console
$ helm delete kubray-operator
$ helm delete kuberay-operator -n kuberay-operator
```

The command removes nearly all the Kubernetes components associated with the
chart and deletes the release.
chart and deletes the release.
10 changes: 5 additions & 5 deletions helm-chart/ray-cluster/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ version.BuildInfo{Version:"v3.6.2", GitCommit:"ee407bdf364942bcb8e8c665f82e15aa2
## TL;DR;

```console
helm install --name ray-cluster . --values values.yaml --namespace default
helm install ray-cluster . --values values.yaml --namespace ray-system --create-namespace
```

## Installing the Chart
Expand All @@ -23,26 +23,26 @@ To install the chart with the release name `my-release`:


```console
helm install --name sample ray-cluster --values ray-cluster/values.yaml --namespace default
helm install my-release . --values values.yaml --namespace ray-system --create-namespace
```

> note: The chart will submit a RayCluster.
> note: The chart will submit a RayCluster.

## Uninstalling the Chart

To uninstall/delete the `my-release` deployment:

```console
helm delete ray-cluster
helm delete my-release -n ray-system
```

The command removes nearly all the Kubernetes components associated with the
chart and deletes the release.

## Check Cluster status

### Get Service
### Get Service

```console
$ kubectl get svc -l ray.io/cluster=ray-cluster
Expand Down

0 comments on commit 5a44546

Please sign in to comment.