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.

Sign up for GitHub

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
Merged

Remove extranous arguments from examples #2051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b62f687
Update Helm chart examples
thomasdesr Mar 29, 2024
5cb0673
Update another location
thomasdesr Mar 29, 2024
73e104c
Update helm-chart/ray-cluster/README.md
thomasdesr Mar 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/development/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@ To preview the KubeRay documentation locally, follow these steps:
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
```

- Open your web browser and navigate to <http://0.0.0.0:8000/kuberay/> to view the documentation.
- Open your web browser and navigate to <http://127.0.0.1:8000/kuberay/> to view the documentation.

If you make any changes to the documentation files, the local preview will automatically update to reflect those changes.
6 changes: 3 additions & 3 deletions helm-chart/ray-cluster/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 •
edited
Loading

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 •
edited
Loading

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.

kubectl port-forward svc/raycluster-kuberay-head-svc 8265:8265

# Step 7: Check ${YOUR_IP}:8265 for the Dashboard (e.g. 127.0.0.1:8265)
# Step 7: Check 127.0.0.1:8265 for the Dashboard

# Step 8: Log in to Ray head Pod and execute a job.
kubectl exec -it ${RAYCLUSTER_HEAD_POD} -- bash
python -c "import ray; ray.init(); print(ray.cluster_resources())" # (in Ray head Pod)

# Step 9: Check ${YOUR_IP}:8265/#/job. The status of the job should be "SUCCEEDED".
# Step 9: Check 127.0.0.1:8265/#/job. The status of the job should be "SUCCEEDED".

# Step 10: Uninstall RayCluster
helm uninstall raycluster
Expand Down
Loading