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

[Cluster launcher] Add more commands to "Useful commands" CLI output #40160

Merged

Conversation

architkulkarni
Copy link
Contributor

@architkulkarni architkulkarni commented Oct 5, 2023

Why are these changes needed?

Updates the "useful commands" printed on ray up to add

  • ray down
  • ray get-head-ip
  • ray dashboard
  • ray job submit

Removes the "manual ssh command", because "ray attach" should be used instead.

In summary, this PR implements the conclusion of the discussion here: #34685 (comment)

This PR also fixes a bug where cluster-name was not printed in the example commands in places where it should have been. (This is stored in the variable modifiers in the code)

Screenshot 2023-10-05 at 1 54 02 PM

Related issue number

Closes #34685

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: Archit Kulkarni <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
@scottsun94
Copy link
Contributor

scottsun94 commented Oct 5, 2023

2 high-level questions:

  1. There are two pieces of ray job submission info and they look different..
Screenshot 2023-10-05 at 4 01 10 PM Screenshot 2023-10-05 at 4 01 13 PM
  1. The output in the "next steps" section seems to use the local ip. The commands that use the local ip won't work right?

  2. If ray dashboard is not installed, will we hide the related output?

@architkulkarni
Copy link
Contributor Author

2 high-level questions:

  1. There are two pieces of ray job submission info and they look different..

Screenshot 2023-10-05 at 4 01 10 PM Screenshot 2023-10-05 at 4 01 13 PM
2. The output in the "next steps" section seems to use the local ip. The commands that use the local ip won't work right?
3. If ray dashboard is not installed, will we hide the related output?

  1. That's a separate issue, right now the output from the head node (which is the output of running ray start --head) is streamed to the user laptop (the one running ray up). The output from the head node lists commands which only make sense on the head node. We can add a message in the output to clarify this in a future PR.
  2. Yup, fixed it
  3. Both cluster launcher and dashboard require ray[default] so I don't think this situation will happen.

@scottsun94
Copy link
Contributor

scottsun94 commented Oct 25, 2023

That's a separate issue, right now the output from the head node (which is the output of running ray start --head) is streamed to the user laptop (the one running ray up). The output from the head node lists commands which only make sense on the head node. We can add a message in the output to clarify this in a future PR.

Yes. That makes sense. We need a better solution here. It's really confusing. Can we create an issue to track it? cc: @jjyao

Yup, fixed it

Sorry. What did you fix? It seems that this was the same issues as the one above.

Both cluster launcher and dashboard require ray[default] so I don't think this situation will happen.

Got it. Thanks!

@architkulkarni
Copy link
Contributor Author

That's a separate issue, right now the output from the head node (which is the output of running ray start --head) is streamed to the user laptop (the one running ray up). The output from the head node lists commands which only make sense on the head node. We can add a message in the output to clarify this in a future PR.

Yes. That makes sense. We need a better solution here. It's really confusing. Can we create an issue to track it? cc: @jjyao

I will create an issue and link it here.

Yup, fixed it

Sorry. What did you fix? It seems that this was the same issues as the one above.

I was referring to this commit: 18398de So for this command, the screenshot in the description is slightly out of date (it predates this commit). Basically, it is correct to write "localhost" because we instructed the user to do port-forwarding first.

@architkulkarni
Copy link
Contributor Author

@scottsun94 added the issue! #40833

@scottsun94
Copy link
Contributor

LGTM. Thanks!

Signed-off-by: Archit Kulkarni <[email protected]>
Copy link
Member

@hongchaodeng hongchaodeng left a comment

Choose a reason for hiding this comment

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

LGTM!

@architkulkarni architkulkarni merged commit 729366b into ray-project:master Nov 28, 2023
17 checks passed
ujjawal-khare pushed a commit to ujjawal-khare-27/ray that referenced this pull request Nov 29, 2023
…ay-project#40160)

Updates the "useful commands" printed on ray up to add

ray down
ray get-head-ip
ray dashboard
ray job submit
Removes the "manual ssh command", because "ray attach" should be used instead.

In summary, this PR implements the conclusion of the discussion here: ray-project#34685 (comment)

This PR also fixes a bug where cluster-name was not printed in the example commands in places where it should have been. (This is stored in the variable modifiers in the code)

Related issue number
Closes ray-project#34685

---------

Signed-off-by: Archit Kulkarni <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
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.

[Cluster Launcher] [State API] [Jobs] Add API to get head node IP
4 participants