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

[KubeRay] Add instructions to run distributed Ray Debugger in KubeRay #49116

Merged
merged 9 commits into from
Dec 9, 2024

Conversation

pcmoritz
Copy link
Contributor

@pcmoritz pcmoritz commented Dec 6, 2024

Why are these changes needed?

This addresses #45541 and #49014

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

name: ssd


to the `ray-head` container and make sure sshd is running in the `ray-head` container. You can then connect VS Code to the cluster by running
Copy link
Member

Choose a reason for hiding this comment

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

make sure sshd is running in the ray-head container

The wording may not be very precise. Setting the container port does not start the SSHD service. Instead, the KubeRay operator configures the Kubernetes Service based on the head Pod's port configuration, allowing you to use the Kubernetes Service to access the port instead of directly accessing the head Pod.

ref: https://faun.pub/should-i-configure-the-ports-in-kubernetes-deployment-c6b3817e495

image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks -- I added some more instructions now that should it make very clear for people that they actually need to run sshd in the container :)

Copy link
Contributor

@angelinalg angelinalg left a comment

Choose a reason for hiding this comment

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

Just some style suggestions.

doc/source/ray-observability/ray-distributed-debugger.rst Outdated Show resolved Hide resolved
doc/source/ray-observability/ray-distributed-debugger.rst Outdated Show resolved Hide resolved
doc/source/ray-observability/ray-distributed-debugger.rst Outdated Show resolved Hide resolved
doc/source/ray-observability/ray-distributed-debugger.rst Outdated Show resolved Hide resolved
doc/source/ray-observability/ray-distributed-debugger.rst Outdated Show resolved Hide resolved
doc/source/ray-observability/ray-distributed-debugger.rst Outdated Show resolved Hide resolved
@pcmoritz pcmoritz enabled auto-merge (squash) December 9, 2024 23:08
@pcmoritz pcmoritz merged commit f54efbb into master Dec 9, 2024
6 checks passed
@pcmoritz pcmoritz deleted the kuberay-debugger branch December 9, 2024 23:55
ujjawal-khare pushed a commit to ujjawal-khare-27/ray that referenced this pull request Dec 17, 2024
…ray-project#49116)

<!-- Thank you for your contribution! Please review
https://github.com/ray-project/ray/blob/master/CONTRIBUTING.rst before
opening a pull request. -->

<!-- Please add a reviewer to the assignee section when you create a PR.
If you don't have the access to it, we will shortly find a reviewer and
assign them to your PR. -->

## Why are these changes needed?

This addresses ray-project#45541 and
ray-project#49014

## Related issue number

<!-- For example: "Closes ray-project#1234" -->

## Checks

- [ ] I've signed off every commit(by using the -s flag, i.e., `git
commit -s`) in this PR.
- [ ] I've run `scripts/format.sh` to lint the changes in this PR.
- [ ] I've included any doc changes needed for
https://docs.ray.io/en/master/.
- [ ] I've added any new APIs to the API Reference. For example, if I
added a
method in Tune, I've added it in `doc/source/tune/api/` under the
           corresponding `.rst` file.
- [ ] I've made sure the tests are passing. Note that there might be a
few flaky tests, see the recent failures at https://flakey-tests.ray.io/
- Testing Strategy
   - [ ] Unit tests
   - [ ] Release tests
   - [ ] This PR is not tested :(

---------

Signed-off-by: Philipp Moritz <[email protected]>
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: ujjawal-khare <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
go add ONLY when ready to merge, run all tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants