From e150e9d259c86e04dac006c7a4618a766d56fe5e Mon Sep 17 00:00:00 2001 From: Dmitri Gekhtman <62982571+DmitriGekhtman@users.noreply.github.com> Date: Fri, 9 Dec 2022 14:57:51 -0800 Subject: [PATCH] Update KubeRay versions. (#821) Signed-off-by: Dmitri Gekhtman Signed-off-by: Dmitri Gekhtman --- README.md | 10 +++++----- docs/deploy/installation.md | 4 ++-- docs/guidance/autoscaler.md | 2 +- docs/guidance/rayjob.md | 7 +++---- docs/guidance/rayservice.md | 9 ++++----- docs/notebook/kuberay-on-kind.ipynb | 2 +- helm-chart/kuberay-apiserver/Chart.yaml | 8 +------- helm-chart/kuberay-operator/Chart.yaml | 3 +-- helm-chart/kuberay-operator/README.md | 4 ++-- helm-chart/ray-cluster/Chart.yaml | 3 +-- ray-operator/README.md | 2 +- 11 files changed, 22 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 4b17c778375..85d628c945e 100644 --- a/README.md +++ b/README.md @@ -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" ``` diff --git a/docs/deploy/installation.md b/docs/deploy/installation.md index 15f8b22d541..aaacc5c9a61 100644 --- a/docs/deploy/installation.md +++ b/docs/deploy/installation.md @@ -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. diff --git a/docs/guidance/autoscaler.md b/docs/guidance/autoscaler.md index 022e730d042..579c4e3e37e 100644 --- a/docs/guidance/autoscaler.md +++ b/docs/guidance/autoscaler.md @@ -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 diff --git a/docs/guidance/rayjob.md b/docs/guidance/rayjob.md index eb9277575ac..2c49e457389 100644 --- a/docs/guidance/rayjob.md +++ b/docs/guidance/rayjob.md @@ -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. @@ -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 diff --git a/docs/guidance/rayservice.md b/docs/guidance/rayservice.md index 56ded962ed3..4a6464f882b 100644 --- a/docs/guidance/rayservice.md +++ b/docs/guidance/rayservice.md @@ -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. @@ -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. diff --git a/docs/notebook/kuberay-on-kind.ipynb b/docs/notebook/kuberay-on-kind.ipynb index a59c43e508f..fa1f4d0da1e 100644 --- a/docs/notebook/kuberay-on-kind.ipynb +++ b/docs/notebook/kuberay-on-kind.ipynb @@ -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\"" ] }, { diff --git a/helm-chart/kuberay-apiserver/Chart.yaml b/helm-chart/kuberay-apiserver/Chart.yaml index 590c1a161ae..33fbbfb6305 100644 --- a/helm-chart/kuberay-apiserver/Chart.yaml +++ b/helm-chart/kuberay-apiserver/Chart.yaml @@ -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 diff --git a/helm-chart/kuberay-operator/Chart.yaml b/helm-chart/kuberay-operator/Chart.yaml index ea3e10cc9c2..f80859f79ff 100644 --- a/helm-chart/kuberay-operator/Chart.yaml +++ b/helm-chart/kuberay-operator/Chart.yaml @@ -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 diff --git a/helm-chart/kuberay-operator/README.md b/helm-chart/kuberay-operator/README.md index 82aaacbe850..6b05624138d 100644 --- a/helm-chart/kuberay-operator/README.md +++ b/helm-chart/kuberay-operator/README.md @@ -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 @@ -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 diff --git a/helm-chart/ray-cluster/Chart.yaml b/helm-chart/ray-cluster/Chart.yaml index 48850503c50..6edc2840c08 100644 --- a/helm-chart/ray-cluster/Chart.yaml +++ b/helm-chart/ray-cluster/Chart.yaml @@ -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 diff --git a/ray-operator/README.md b/ray-operator/README.md index ee31352b1bc..ef3d72f0e5e 100644 --- a/ray-operator/README.md +++ b/ray-operator/README.md @@ -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.