Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a document to outline the default settings for rayStartParams in Kuberay #1057

Merged

Conversation

Yicheng-Lu-llll
Copy link
Contributor

@Yicheng-Lu-llll Yicheng-Lu-llll commented Apr 28, 2023

Why are these changes needed?

This PR:

  • Add a document to outline the default settings for rayStartParams in Kuberay(see here for the ray start cli).
  • The option dashboard-host will now be automatically injected with the value '0.0.0.0'.
  • removes option num-cpus in all sample yaml file. The num-cpus value should be automatically determined based on the container.resource.cpu.limit. Refer to add resource command #170 for more information.

TODO:

  • Remove option dashboard-host after releasing 0.6.0 and change the document accordingly.

Related issue number

Closes #976

Checks

I have run all the sample yaml files and fetched the ray start command to make sure all the options Kuberay may set by default for rayStartParams are included.

for file in $rootPath/ray-operator/config/samples/ray-cluster*.yaml
do
  echo "###########################"  >> $outputFile

  echo $file >> $outputFile

  kubectl apply -f $file
  sleep 5
  kubectl get  $(kubectl get pods -o=name | grep head) -o yaml | grep "ulimit -n 65536; ray start" >> $outputFile
  kubectl get  $(kubectl get pods -o=name | grep worker) -o yaml | grep "ulimit -n 65536; ray start" >> $outputFile
  kubectl delete -f $file
  sleep 90

  echo "###########################\n"  >> $outputFile
done
  echo "###########################\n"  >> $outputFile
done

@Yicheng-Lu-llll Yicheng-Lu-llll force-pushed the make-rayStartParams-optional branch 2 times, most recently from 9f213b5 to c16d78d Compare May 3, 2023 02:52
@kevin85421 kevin85421 self-assigned this May 8, 2023
@Yicheng-Lu-llll Yicheng-Lu-llll changed the title Make ray start params optional Add a document to outline the default settings for rayStartParams in Kuberay May 11, 2023
@Yicheng-Lu-llll Yicheng-Lu-llll marked this pull request as ready for review May 11, 2023 22:26
Signed-off-by: Yicheng-Lu-llll <luyc58576@gmail.com>
Signed-off-by: Yicheng-Lu-llll <luyc58576@gmail.com>
Signed-off-by: Yicheng-Lu-llll <luyc58576@gmail.com>
docs/guidance/rayStartParams.md Outdated Show resolved Hide resolved
docs/guidance/rayStartParams.md Outdated Show resolved Hide resolved
docs/guidance/rayStartParams.md Outdated Show resolved Hide resolved
docs/guidance/rayStartParams.md Outdated Show resolved Hide resolved
docs/guidance/rayStartParams.md Outdated Show resolved Hide resolved
docs/guidance/rayStartParams.md Outdated Show resolved Hide resolved
docs/guidance/rayStartParams.md Outdated Show resolved Hide resolved
ray-operator/controllers/ray/common/pod.go Outdated Show resolved Hide resolved
Signed-off-by: Yicheng-Lu-llll <luyc58576@gmail.com>
Signed-off-by: Yicheng-Lu-llll <luyc58576@gmail.com>
Signed-off-by: Yicheng-Lu-llll <luyc58576@gmail.com>
Signed-off-by: Yicheng-Lu-llll <luyc58576@gmail.com>
The default value for both Ray and KubeRay 0.5.0 is `localhost`, however, for versions of KubeRay after 0.5.0, the default value will be `0.0.0.0`.


- `--no-monitor`: This option disables the monitor and autoscaler in the **user's container**. It will be automatically set when [autoscaling](https://github.com/ray-project/kuberay/blob/master/docs/guidance/autoscaler.md) is enabled. The autoscaling feature introduces the autoscaler as a sidecar container within the head pod, thereby obviating the need for a monitor and autoscaler in the **user's container**. See [PR #13505](https://github.com/ray-project/ray/pull/13505) for more details. Modification is not recommended.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DmitriGekhtman would you mind reviewing the option --no-monitor?

ray-operator/controllers/ray/common/pod_test.go Outdated Show resolved Hide resolved
docs/guidance/rayStartParams.md Outdated Show resolved Hide resolved
docs/guidance/rayStartParams.md Outdated Show resolved Hide resolved
@kevin85421 kevin85421 mentioned this pull request May 18, 2023
2 tasks
Signed-off-by: Yicheng-Lu-llll <luyc58576@gmail.com>
Copy link
Member

@kevin85421 kevin85421 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@kevin85421 kevin85421 merged commit 08792ca into ray-project:master May 22, 2023
19 checks passed
lowang-bh pushed a commit to lowang-bh/kuberay that referenced this pull request Sep 24, 2023
…n Kuberay (ray-project#1057)

Add a document to outline the default settings for `rayStartParams` in Kuberay
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature] Ascertain the minimum essential rayStartParams and make rayStartParams optional
2 participants