Skip to content

Commit dbfa2d1

Browse files
rueianMortalHappinessangelinalg
authored
[doc][kuberay] update the doc for kuberay autoscaler changes for 2.41.0 (#51319)
Update the docs of kuberay autoscaler to reflect #49613. Disscussion: https://ray.slack.com/archives/C02GFQ82JPM/p1741600403525889 --------- Signed-off-by: Rueian <rueiancsie@gmail.com> Co-authored-by: Chi-Sheng Liu <chishengliu@chishengliu.com> Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
1 parent c52eaa9 commit dbfa2d1

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

doc/source/cluster/kubernetes/user-guides/configuring-autoscaling.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -317,9 +317,14 @@ for container environment variables.
317317

318318
### 4. Set the `rayStartParams` and the resource limits for the Ray container
319319

320+
```{admonition} Resource limits are optional starting from Ray 2.41.0
321+
Starting from Ray 2.41.0, the Ray Autoscaler can read resource specifications from `rayStartParams`, resource limits, or resource requests of the Ray container. You must specify at least one of these fields.
322+
Earlier versions only support `rayStartParams` or resource limits, and don't recognize resource requests.
323+
```
324+
320325
The Ray Autoscaler reads the `rayStartParams` field or the Ray container's resource limits in the RayCluster custom resource specification to determine the Ray Pod's resource requirements.
321326
The information regarding the number of CPUs is essential for the Ray Autoscaler to scale the cluster.
322-
Therefore, without this information, the Ray Autoscaler would report an error and fail to start.
327+
Therefore, without this information, the Ray Autoscaler reports an error and fails to start.
323328
Take [ray-cluster.autoscaler.yaml](https://github.com/ray-project/kuberay/blob/v1.3.0/ray-operator/config/samples/ray-cluster.autoscaler.yaml) as an example below:
324329

325330
* If users set `num-cpus` in `rayStartParams`, Ray Autoscaler would work regardless of the resource limits on the container.
@@ -352,8 +357,10 @@ workerGroupSpecs:
352357
- name: ray-worker
353358
resources:
354359
limits:
355-
# The Ray Autoscaler will fail to start if the CPU resource limit for the worker
360+
# The Ray Autoscaler versions older than 2.41.0 will fail to start if the CPU resource limit for the worker
356361
# container is commented out because `rayStartParams` is empty.
362+
# The Ray Autoscaler starting from 2.41.0 will not fail but use the resource requests if the resource
363+
# limits are commented out and `rayStartParams` is empty.
357364
cpu: "1"
358365
memory: "1G"
359366
requests:

0 commit comments

Comments
 (0)