Skip to content

Commit

Permalink
Update KubeRay versions. (ray-project#821)
Browse files Browse the repository at this point in the history
Signed-off-by: Dmitri Gekhtman <[email protected]>

Signed-off-by: Dmitri Gekhtman <[email protected]>
  • Loading branch information
DmitriGekhtman authored Dec 9, 2022
1 parent 8306e43 commit e150e9d
Show file tree
Hide file tree
Showing 11 changed files with 22 additions and 32 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,23 +24,23 @@ We also recommend checking out the official Ray guides for deploying on Kubernet

### Use YAML

Please choose the version you would like to install. The examples below use the latest stable version `v0.3.0`.
Please choose the version you would like to install. The examples below use the latest stable version `v0.4.0`.

| Version | Stable | Suggested Kubernetes Version |
|----------|:-------:|------------------------------:|
| master | N | v1.19 - v1.24 |
| v0.3.0 | Y | v1.19 - v1.24 |
| master | N | v1.19 - v1.25 |
| v0.4.0 | Y | v1.19 - v1.25 |

Make sure your Kubernetes and Kubectl versions are both within the suggested range.
Once you have connected to a Kubernetes cluster, run the following commands to deploy the KubeRay Operator.
```
export KUBERAY_VERSION=v0.3.0
export KUBERAY_VERSION=v0.4.0
kubectl create -k "github.com/ray-project/kuberay/ray-operator/config/default?ref=${KUBERAY_VERSION}&timeout=90s"
```

To deploy both the KubeRay Operator and the optional KubeRay API Server run the following commands.
```
export KUBERAY_VERSION=v0.3.0
export KUBERAY_VERSION=v0.4.0
kubectl create -k "github.com/ray-project/kuberay/manifests/cluster-scope-resources?ref=${KUBERAY_VERSION}&timeout=90s"
kubectl apply -k "github.com/ray-project/kuberay/manifests/base?ref=${KUBERAY_VERSION}&timeout=90s"
```
Expand Down
4 changes: 2 additions & 2 deletions docs/deploy/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ helm install kuberay-operator kuberay/kuberay-operator
#### Method 2: Kustomize
```sh
# Install CRDs
kubectl create -k "github.com/ray-project/kuberay/manifests/cluster-scope-resources?ref=v0.3.0"
kubectl create -k "github.com/ray-project/kuberay/manifests/cluster-scope-resources?ref=v0.4.0"

# Install KubeRay operator
kubectl apply -k "github.com/ray-project/kuberay/manifests/base?ref=v0.3.0"
kubectl apply -k "github.com/ray-project/kuberay/manifests/base?ref=v0.4.0"
```

> Observe that we must use `kubectl create` to install cluster-scoped resources.
Expand Down
2 changes: 1 addition & 1 deletion docs/guidance/autoscaler.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ See the [official Ray documentation](https://docs.ray.io/en/latest/cluster/kuber

Start by deploying the latest stable version of the KubeRay operator:
```
kubectl create -k "github.com/ray-project/kuberay/ray-operator/config/default?ref=v0.3.0&timeout=90s"
kubectl create -k "github.com/ray-project/kuberay/ray-operator/config/default?ref=v0.4.0&timeout=90s"
```

### Deploy a cluster with autoscaling enabled
Expand Down
7 changes: 3 additions & 4 deletions docs/guidance/rayjob.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@
### Prerequisites

* Ray 1.10 or higher
* KubeRay v0.3.0
* KubeRay v0.3.0+. (v0.4.0 is recommended)

### What is a RayJob?

RayJob is a new custom resource (CR) supported by KubeRay in v0.3.0.

A RayJob manages 2 things:
* Ray Cluster: Manages resources in a Kubernetes cluster.
* Job: Manages jobs in a Ray Cluster.
Expand All @@ -22,7 +20,8 @@ A RayJob manages 2 things:

### Deploy KubeRay

Make sure KubeRay v0.3.0 version is deployed in your cluster.
Make sure your KubeRay operator version is at least v0.3.0.
The latest released KubeRay version (v0.4.0) is recommended.
For installation instructions, please follow [the documentation](../deploy/installation.md).

### Run an example Job
Expand Down
9 changes: 4 additions & 5 deletions docs/guidance/rayservice.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@

> Note: This is the alpha version of Ray Services. There will be ongoing improvements for Ray Services in the future releases.
### Prerequisite
### Prerequisites

* Ray 2.0 is required.
* Ray 2.0 or newer.
* KubeRay 0.3.0 or newer.

### What is a RayService?

RayService is a new custom resource (CR) supported by KubeRay in v0.3.0.

A RayService manages 2 things:

* **Ray Cluster**: Manages resources in a Kubernetes cluster.
Expand All @@ -25,7 +24,7 @@ A RayService manages 2 things:
### Deploy the Operator

```
$ kubectl create -k "github.com/ray-project/kuberay/ray-operator/config/default?ref=v0.3.0&timeout=90s"
$ kubectl create -k "github.com/ray-project/kuberay/ray-operator/config/default?ref=v0.4.0&timeout=90s"
```

Check that the controller is running.
Expand Down
2 changes: 1 addition & 1 deletion docs/notebook/kuberay-on-kind.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@
}
],
"source": [
"!kubectl create -k \"github.com/ray-project/kuberay/ray-operator/config/default?ref=v0.3.0&timeout=90s\""
"!kubectl create -k \"github.com/ray-project/kuberay/ray-operator/config/default?ref=v0.4.0&timeout=90s\""
]
},
{
Expand Down
8 changes: 1 addition & 7 deletions helm-chart/kuberay-apiserver/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,4 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.3.0

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
# It is recommended to use it with quotes.
appVersion: "1.0.0"
version: 0.4.0
3 changes: 1 addition & 2 deletions helm-chart/kuberay-operator/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
apiVersion: v2
appVersion: "1.0"
description: A Helm chart for Kubernetes
name: kuberay-operator
version: 0.3.0
version: 0.4.0
icon: https://github.com/ray-project/ray/raw/master/doc/source/images/ray_header_logo.png
type: application
4 changes: 2 additions & 2 deletions helm-chart/kuberay-operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ spec:
project: default
source:
repoURL: https://github.com/ray-project/kuberay
targetRevision: v0.3.0
targetRevision: v0.4.0
path: helm-chart/kuberay-operator/crds
destination:
server: https://kubernetes.default.svc
Expand All @@ -92,7 +92,7 @@ metadata:
spec:
source:
repoURL: https://github.com/ray-project/kuberay
targetRevision: v0.3.0
targetRevision: v0.4.0
path: helm-chart/kuberay-operator
helm:
skipCrds: true
Expand Down
3 changes: 1 addition & 2 deletions helm-chart/ray-cluster/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
apiVersion: v1
appVersion: "1.0"
description: A Helm chart for Kubernetes
name: ray-cluster
version: 0.3.0
version: 0.4.0
icon: https://github.com/ray-project/ray/raw/master/doc/source/images/ray_header_logo.png
2 changes: 1 addition & 1 deletion ray-operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ You can update the number of replicas in a worker group, and specify which exact
### Deploy the operator

```shell
kubectl create -k "github.com/ray-project/kuberay/ray-operator/config/default?ref=v0.3.0&timeout=90s"
kubectl create -k "github.com/ray-project/kuberay/ray-operator/config/default?ref=v0.4.0&timeout=90s"
```

Check that the controller is running.
Expand Down

0 comments on commit e150e9d

Please sign in to comment.