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

Doc: add ray port FAQ to ray overview document. #5752

Merged
merged 9 commits into from
Sep 15, 2022
24 changes: 24 additions & 0 deletions docs/readthedocs/source/doc/Ray/Overview/ray.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,3 +116,27 @@ Add the environment variables when calling `init_orca_context` would resolve the
```python
sc = init_orca_context(cluster_mode, init_ray_on_spark=True, env={"LANG": "C.UTF-8", "LC_ALL": "C.UTF-8"})
```

---
### **5. FAQ**
- **ValueError: Ray component worker_ports is trying to use a port number ... that is used by other components.**

This error is because that some port in worker port list is occupied by other processes. To handle this issue, you can set range of the worker port list by using parameters `min-worker-port` and `max-worker-port` in `init_orca_context()` as follows:
Copy link
Contributor

Choose a reason for hiding this comment

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

init_orca_context() -> init_orca_context

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed.


```python
init_orca_context(extra_params={"min-worker-port": "30000", "max-worker-port": "30033"})
```

- **ValueError: Failed to bind to 0.0.0.0:8265 because it's already occupied. You can use `ray start --dashboard-port ...` or `ray.init(dashboard_port=...)` to select a different port.**

This error is because that ray dashboard port is occupied by other processes. To handle this issue, you can end the process that occupies the port or you can manually set the ray dashboard port by using parameter `dashboard-port` in `init_orca_context()` as follows:
Copy link
Contributor

Choose a reason for hiding this comment

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

parameter -> the parameter

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed.


```python
init_orca_context(extra_params={"dashboard-port": "50005"})
```

Note that, the similar error can happen to ray redis port as well, you can also set the ray redis port by using parameter `redis_port` in `init_orca_context()` as follows:

```python
init_orca_context(redis_port=50006)
```