document: ryu.app.gui_topology

Signed-off-by: YAMADA Hideki <yamada.hideki@po.ntts.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
This commit is contained in:
YAMADA Hideki 2014-06-23 15:41:28 +09:00 committed by FUJITA Tomonori
parent a3cb8f8c25
commit 5b1f5aea29
3 changed files with 34 additions and 0 deletions

View File

@ -6,4 +6,5 @@ Configuration
:maxdepth: 2
tls.rst
gui.rst

BIN
doc/source/gui.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

33
doc/source/gui.rst Normal file
View File

@ -0,0 +1,33 @@
***************
Topology Viewer
***************
ryu.app.gui_topology.gui_topology provides topology visualization.
This depends on following ryu applications.
===================== =================================================
ryu.app.rest_topology Get node and link data.
ryu.app.ws_topology Being notified change of link up/down.
ryu.app.ofctl_rest Get flows of datapaths.
===================== =================================================
Usage
=====
Run mininet (or join your real environment)::
$ sudo mn --controller remote --topo tree,depth=3
Run GUI application::
$ PYTHONPATH=. ./bin/ryu run --observe-links ryu/app/gui_topology/gui_topology.py
Access http://<ip address of ryu host>:8080 with your web browser.
Screenshot
==========
.. image:: gui.png
:width: 640 px