Skip to content

Conversation

@Zakelly
Copy link
Contributor

@Zakelly Zakelly commented Oct 16, 2025

Description

When deploying ray on Yarn using Skein, it's useful to expose the ray's dashboard via Skein's web ui. This PR shows how to expose that and update the related document.

Types of change

  • Bug fix 🐛
  • New feature ✨
  • Enhancement 🚀
  • Code refactoring 🔧
  • Documentation update 📖
  • Chore 🧹
  • Style 🎨

Checklist

Does this PR introduce breaking changes?

  • Yes ⚠️
  • No

Testing:

  • Added/updated tests for my changes
  • Tested the changes manually
  • This PR is not tested ❌ (please explain why)

docs change only

Code Quality:

  • Signed off every commit (git commit -s)
  • Ran pre-commit hooks (setup guide)

Documentation:

  • Updated documentation (if applicable) (contribution guide)
  • Added new APIs to doc/source/ (if applicable)

Additional context

Here is an example of exposed entry on Skein's web ui:

@Zakelly Zakelly requested review from a team as code owners October 16, 2025 09:58
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces changes to the Ray documentation and configuration files to expose the Ray dashboard via Skein's web UI when deploying Ray on Yarn. The changes include adding a Python script (dashboard.py) to register the dashboard, modifying the ray-skein.yaml file to include the script and set the dashboard host, and updating the documentation to reflect these changes. I have identified a potential issue with the dashboard.py script and have provided a suggestion to improve its robustness.

@ray-gardener ray-gardener bot added docs An issue or change related to documentation core Issues that should be addressed in Ray Core community-contribution Contributed by the community labels Oct 16, 2025
Copy link
Contributor

@ZacAttack ZacAttack left a comment

Choose a reason for hiding this comment

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

Let's add gemini's suggestion, but I think this looks good. Thanks!

@Zakelly Zakelly force-pushed the yarn_dashboard branch 2 times, most recently from 066851e to c3334ed Compare October 17, 2025 12:23
@@ -0,0 +1,22 @@
import skein
Copy link
Collaborator

Choose a reason for hiding this comment

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

this seems to be the same file from doc_code/yard/dashboard.py -- is that intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. I noticed there are same files under doc/cluster/doc_code/yarn/ and doc/yarn, such as example.py and ray-skein.yaml, so I add same changes under two folder.

Comment on lines +5 to +8
if len(sys.argv) < 2:
print("Usage: python dashboard.py <dashboard-address>")
sys.exit(1)
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: use argparse instead of hand rolling this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As there is only one required argument, I'd keep it simple as is.

@Zakelly Zakelly force-pushed the yarn_dashboard branch 2 times, most recently from 80d8cea to 9118762 Compare October 17, 2025 17:02
@Zakelly
Copy link
Contributor Author

Zakelly commented Oct 18, 2025

Finally the lint got passed...

@Zakelly Zakelly requested review from ZacAttack and edoakes October 18, 2025 03:42
@edoakes edoakes added the go add ONLY when ready to merge, run all tests label Oct 20, 2025
@edoakes
Copy link
Collaborator

edoakes commented Oct 20, 2025

Triggered full CI run: https://buildkite.com/ray-project/premerge/builds/52140

PR will auto-merge if it passes. Thanks for the contribution!

@edoakes edoakes enabled auto-merge (squash) October 20, 2025 13:09
@Zakelly
Copy link
Contributor Author

Zakelly commented Oct 21, 2025

Ah... CI failed. There seems some error related with the env:

ERROR: unexpected status from HEAD request to https://registry-1.docker.io/v2/docker/dockerfile/manifests/1.3-labs: 500 Internal Server Error

Is it possible to re-trigger this? @edoakes

@github-actions github-actions bot disabled auto-merge October 21, 2025 14:55
@edoakes
Copy link
Collaborator

edoakes commented Oct 21, 2025

Ah... CI failed. There seems some error related with the env:

ERROR: unexpected status from HEAD request to https://registry-1.docker.io/v2/docker/dockerfile/manifests/1.3-labs: 500 Internal Server Error

Is it possible to re-trigger this? @edoakes

Re-triggered. For the future can just click "Update branch", which will merge master and re-trigger CI.

@Zakelly
Copy link
Contributor Author

Zakelly commented Oct 22, 2025

CI passed but the auto-merge is disabled. Please merge this at your convenience, thanks a lot! @edoakes @ZacAttack

@edoakes edoakes merged commit 33d8cb8 into ray-project:master Oct 22, 2025
6 checks passed
xinyuangui2 pushed a commit to xinyuangui2/ray that referenced this pull request Oct 27, 2025
…roject#57793)

When deploying ray on Yarn using Skein, it's useful to expose the ray's
dashboard via Skein's web ui. This PR shows how to expose that and
update the related document.

Signed-off-by: Zakelly <[email protected]>
Co-authored-by: Edward Oakes <[email protected]>
Signed-off-by: xgui <[email protected]>
landscapepainter pushed a commit to landscapepainter/ray that referenced this pull request Nov 17, 2025
…roject#57793)

When deploying ray on Yarn using Skein, it's useful to expose the ray's
dashboard via Skein's web ui. This PR shows how to expose that and
update the related document.

Signed-off-by: Zakelly <[email protected]>
Co-authored-by: Edward Oakes <[email protected]>
Aydin-ab pushed a commit to Aydin-ab/ray-aydin that referenced this pull request Nov 19, 2025
…roject#57793)

When deploying ray on Yarn using Skein, it's useful to expose the ray's
dashboard via Skein's web ui. This PR shows how to expose that and
update the related document.

Signed-off-by: Zakelly <[email protected]>
Co-authored-by: Edward Oakes <[email protected]>
Signed-off-by: Aydin Abiar <[email protected]>
Future-Outlier pushed a commit to Future-Outlier/ray that referenced this pull request Dec 7, 2025
…roject#57793)

When deploying ray on Yarn using Skein, it's useful to expose the ray's
dashboard via Skein's web ui. This PR shows how to expose that and
update the related document.

Signed-off-by: Zakelly <[email protected]>
Co-authored-by: Edward Oakes <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
Blaze-DSP pushed a commit to Blaze-DSP/ray that referenced this pull request Dec 18, 2025
…roject#57793)

When deploying ray on Yarn using Skein, it's useful to expose the ray's
dashboard via Skein's web ui. This PR shows how to expose that and
update the related document.

Signed-off-by: Zakelly <[email protected]>
Co-authored-by: Edward Oakes <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-contribution Contributed by the community core Issues that should be addressed in Ray Core docs An issue or change related to documentation 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