summaryrefslogtreecommitdiffhomepage
path: root/doc/source/gui.rst
diff options
context:
space:
mode:
authorYAMADA Hideki <yamada.hideki@po.ntts.co.jp>2014-06-23 15:41:28 +0900
committerFUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>2014-06-23 17:12:51 +0900
commit5b1f5aea29df7738bcc0c80b6c986e6dfe4dc5c5 (patch)
tree7eea57243b33b6af5ad737eeed60ad619f135de2 /doc/source/gui.rst
parenta3cb8f8c2569a1549393c457c83db73770795505 (diff)
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>
Diffstat (limited to 'doc/source/gui.rst')
-rw-r--r--doc/source/gui.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/source/gui.rst b/doc/source/gui.rst
new file mode 100644
index 00000000..e51d7840
--- /dev/null
+++ b/doc/source/gui.rst
@@ -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
+