Skip to content

Commit

Permalink
Doc: add ray port FAQ to ray overview document. (#5752)
Browse files Browse the repository at this point in the history
* feat: add faq to ray overview doc.

* fix: fix doc style.

* fix: fix typo.

* feat: add ray redis and dashboard port conflict to faq.

* fix: fix redis port param name.

* fix: fix redis port param name.

* fix: fix typo

* fix: fix typo

* fix: fix wording.
  • Loading branch information
lalalapotter authored Sep 15, 2022
1 parent edcab05 commit de91a8c
Showing 1 changed file with 24 additions and 0 deletions.
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 the parameters `min-worker-port` and `max-worker-port` in `init_orca_context` as follows:

```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 the parameter `dashboard-port` in `init_orca_context` as follows:

```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 the parameter `redis_port` in `init_orca_context` as follows:

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

0 comments on commit de91a8c

Please sign in to comment.