Add rayVersion in the RayCluster chart (ray-project#975)

Add rayVersion in the RayCluster chart
lowang-bh · Mar 27, 2023 · c047b47 · c047b47
1 parent e8975f2
commit c047b47
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 13 deletions.
diff --git a/helm-chart/kuberay-operator/crds/ray.io_rayclusters.yaml b/helm-chart/kuberay-operator/crds/ray.io_rayclusters.yaml
@@ -5734,8 +5734,8 @@ spec:
                   type: string
                 type: object
               rayVersion:
-                description: RayVersion is the version of ray being used. this affects
-                  the command used to start ray
+                description: RayVersion is the version of ray being used. This determines
+                  the autoscaler's image version.
                 type: string
               workerGroupSpecs:
                 description: WorkerGroupSpecs are the specs for the worker pods

diff --git a/helm-chart/kuberay-operator/crds/ray.io_rayjobs.yaml b/helm-chart/kuberay-operator/crds/ray.io_rayjobs.yaml
@@ -5977,8 +5977,8 @@ spec:
                       type: string
                     type: object
                   rayVersion:
-                    description: RayVersion is the version of ray being used. this
-                      affects the command used to start ray
+                    description: RayVersion is the version of ray being used. This
+                      determines the autoscaler's image version.
                     type: string
                   workerGroupSpecs:
                     description: WorkerGroupSpecs are the specs for the worker pods

diff --git a/helm-chart/kuberay-operator/crds/ray.io_rayservices.yaml b/helm-chart/kuberay-operator/crds/ray.io_rayservices.yaml
@@ -5963,8 +5963,8 @@ spec:
                       type: string
                     type: object
                   rayVersion:
-                    description: RayVersion is the version of ray being used. this
-                      affects the command used to start ray
+                    description: RayVersion is the version of ray being used. This
+                      determines the autoscaler's image version.
                     type: string
                   workerGroupSpecs:
                     description: WorkerGroupSpecs are the specs for the worker pods

diff --git a/helm-chart/ray-cluster/values.yaml b/helm-chart/ray-cluster/values.yaml
@@ -17,6 +17,9 @@ imagePullSecrets: []
   # - name: an-existing-secret
 
 head:
+  # rayVersion determines the autoscaler's image version.
+  # It should match the Ray version in the image of the containers.
+  # rayVersion: 2.3.0
   # If enableInTreeAutoscaling is true, the autoscaler sidecar will be added to the Ray head pod.
   # Ray autoscaler integration is supported only for Ray versions >= 1.11.0
   # Ray autoscaler integration is Beta with KubeRay >= 0.3.0 and Ray >= 2.0.0.

diff --git a/ray-operator/apis/ray/v1alpha1/raycluster_types.go b/ray-operator/apis/ray/v1alpha1/raycluster_types.go
@@ -16,7 +16,7 @@ type RayClusterSpec struct {
 	HeadGroupSpec HeadGroupSpec `json:"headGroupSpec"`
 	// WorkerGroupSpecs are the specs for the worker pods
 	WorkerGroupSpecs []WorkerGroupSpec `json:"workerGroupSpecs,omitempty"`
-	// RayVersion is the version of ray being used. this affects the command used to start ray
+	// RayVersion is the version of ray being used. This determines the autoscaler's image version.
 	RayVersion string `json:"rayVersion,omitempty"`
 	// EnableInTreeAutoscaling indicates whether operator should create in tree autoscaling configs
 	EnableInTreeAutoscaling *bool `json:"enableInTreeAutoscaling,omitempty"`

diff --git a/ray-operator/config/crd/bases/ray.io_rayclusters.yaml b/ray-operator/config/crd/bases/ray.io_rayclusters.yaml
@@ -5734,8 +5734,8 @@ spec:
                   type: string
                 type: object
               rayVersion:
-                description: RayVersion is the version of ray being used. this affects
-                  the command used to start ray
+                description: RayVersion is the version of ray being used. This determines
+                  the autoscaler's image version.
                 type: string
               workerGroupSpecs:
                 description: WorkerGroupSpecs are the specs for the worker pods

diff --git a/ray-operator/config/crd/bases/ray.io_rayjobs.yaml b/ray-operator/config/crd/bases/ray.io_rayjobs.yaml
@@ -5977,8 +5977,8 @@ spec:
                       type: string
                     type: object
                   rayVersion:
-                    description: RayVersion is the version of ray being used. this
-                      affects the command used to start ray
+                    description: RayVersion is the version of ray being used. This
+                      determines the autoscaler's image version.
                     type: string
                   workerGroupSpecs:
                     description: WorkerGroupSpecs are the specs for the worker pods

diff --git a/ray-operator/config/crd/bases/ray.io_rayservices.yaml b/ray-operator/config/crd/bases/ray.io_rayservices.yaml
@@ -5963,8 +5963,8 @@ spec:
                       type: string
                     type: object
                   rayVersion:
-                    description: RayVersion is the version of ray being used. this
-                      affects the command used to start ray
+                    description: RayVersion is the version of ray being used. This
+                      determines the autoscaler's image version.
                     type: string
                   workerGroupSpecs:
                     description: WorkerGroupSpecs are the specs for the worker pods