hiro/ray
1
0
Fork 0
mirror of https://github.com/vale981/ray synced 2025-03-06 02:21:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

[debugger] Add doc entry for the --ray-debugger-external flag (#17294)

Browse source
This commit is contained in:
Edward Oakes 2021-07-23 12:00:30 -05:00 • committed by GitHub
parent df7fe8dd6d
commit cc38ffb0a0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/source/ray-debugging.rst
View file

@ -87,6 +87,17 @@ the other break point and hit ``c`` again to continue the execution.
The Ray program ``debugging.py`` now finished and should have printed ``[0, 1]``. Congratulations, you
have finished your first Ray debugging session!
Running on a Cluster
--------------------
The Ray debugger supports setting breakpoints inside of tasks and actors that are running across your
Ray cluster. In order to attach to these from the head node of the cluster using ``ray debug``, you'll
need to make sure to pass in the ``--ray-debugger-external`` flag to ``ray start`` when starting the
cluster (likely in your ``cluster.yaml`` file or k8s Ray cluster spec).
Note that this flag will cause the workers to listen for PDB commands on an external-facing IP address,
so this should *only* be used if your cluster is behind a firewall.
Debugger Commands
-----------------
@ -306,4 +317,4 @@ In a similar manner as above, you can also debug Ray actors. Happy debugging!
Debugging APIs
--------------
See :ref:`package-ref-debugging-apis`.
See :ref:`package-ref-debugging-apis`.