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

Remove extranous arguments from examples #2051

Merged
merged 3 commits into from
Mar 29, 2024

Conversation

thomasdesr
Copy link
Contributor

Why are these changes needed?

These examples are a little misleading, clean them up to clarify behavior.

Related issue number

n/a

Checks

  • I've made sure the tests are passing.
  • Testing Strategy
    • Unit tests
    • Manual tests
    • This PR is not tested :(

To remove an extraneous and possibly confusing argument

Signed-off-by: Thomas Desrosiers <[email protected]>
@thomasdesr thomasdesr changed the title Remove extranous arguments from a docs example Remove extranous arguments from examples Mar 29, 2024
@@ -34,15 +34,15 @@ kubectl get pods
# raycluster-kuberay-worker-workergroup-2jckt 1/1 Running 0 66s

# Step 6: Forward the port of Dashboard
kubectl port-forward --address 0.0.0.0 svc/raycluster-kuberay-head-svc 8265:8265
Copy link
Member

Choose a reason for hiding this comment

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

0.0.0.0 is necessary in some cases. For example, if I want to access the port 8265 in my devbox via the $DEVBOX_IP:8265, I need to set 0.0.0.0.

Copy link
Contributor Author

@thomasdesr thomasdesr Mar 29, 2024

Choose a reason for hiding this comment

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

Yeah totally understand there might be cases where something like this might be appropriate, but its probably not the right default since most users run kubectl on the device they're going to be connecting from.

Also while our dev box setup isn't putting that on the public internet, but other user setups may accidentally do so.

Copy link
Member

@kevin85421 kevin85421 Mar 29, 2024

Choose a reason for hiding this comment

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

since most users run kubectl on the device they're going to be connecting from.

I don't think so. Most users use Macs with ARM chips, but Ray/KubeRay are not friendly to ARM chips. Hence, I think most of them running KubeRay on devbox.

Copy link
Member

Choose a reason for hiding this comment

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

Also while our dev box setup isn't putting that on the public internet, but other user setups may accidentally do so.

We can add comments mentioning the security concerns. However, I think we should still keep 0.0.0.0. It's not necessary to include 0.0.0.0 in the default command, but we at least need to mention it in the comments.

Copy link
Contributor

Choose a reason for hiding this comment

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

I was about to say the same too... in practice most dev/test would want 0.0.0.0 just to expose the Ray Dashboard quickly so you can get up and running which was the aim of this example.

@kevin85421 kevin85421 self-assigned this Mar 29, 2024
@kevin85421
Copy link
Member

Chatted with @thomasdesr offline. We should not use 0.0.0.0. If users are running a Kind cluster on devbox, we can use:

ssh -L 8265:localhost:8265 devbox
# In devbox
kubectl port-forward svc/$HEAD_SVC 8265 8265
# Access 127.0.0.1:8265 in your laptop's browser.

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.

Could we also mention the ssh -L 8265:localhost:8265 devbox solution in the comments? Thanks!

helm-chart/ray-cluster/README.md Outdated Show resolved Hide resolved
Co-authored-by: Kai-Hsun Chen <[email protected]>
Signed-off-by: Thomas Desrosiers <[email protected]>
@thomasdesr thomasdesr merged commit c3b17f3 into master Mar 29, 2024
23 checks passed
@thomasdesr thomasdesr deleted the thomasdesr/remove-extranious-arguments branch March 29, 2024 08:55
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.

3 participants