summaryrefslogtreecommitdiffhomepage
path: root/doc
AgeCommit message (Collapse)Author
2015-10-22doc: Change Sphinx html_theme to sphinx_rtd_themeIWASE Yusuke
Currently, Ryu-Documentation page adopts 'haiku' for Sphinx html_theme, but 'haiku' does not have page-index and no sidebar. This patch changes Sphinx html_theme to 'sphinx_rtd_theme', which outputs page-index for each page and a mobile-friendly sphinx theme that was made for readthedocs.org. Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-10-11doc: Add openflow api reference for of1.0Yusuke Iwase
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-09-28remove old Ryu OpenStack plugin stuffFUJITA Tomonori
The plugin that uses these was removed from OpenStack long ago. Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-09-18doc/ofproto_v1_2_ref: Add description for Port StructuresMinoru TAKAHASHI
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-09-18doc/ofproto_v1_3_ref: Add description for Port StructuresMinoru TAKAHASHI
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-09-18doc/ofproto_v1_4_ref: Add description for Port StructuresMinoru TAKAHASHI
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-09-18doc/ofproto_v1_5_ref: Add description for Port Structures and Controller ↵Minoru TAKAHASHI
Status Structure Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-09-15doc/app/ofctl_rest: Add command examples for WRITE/CLEAR_ACTIONSMinoru TAKAHASHI
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-09-10doc: Add some JSON examples to openflow api reference for of1.5Minoru TAKAHASHI
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-09-10doc: Add openflow api reference for of1.5Minoru TAKAHASHI
Update OpenFlow API document. - add OpenFlow 1.5 API Reference - update OpenFlow API Reference index for OF1.5 Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-08-30ofctl_v1_[23]: Convert masked match value into strYusuke Iwase
Currently, ofctl_v1_[23].py always converts metadata field into str type for display, but does not convert pbb_isid and tunnel_id fields even if these fields are masked. So ofctl_v1_3.py fails to convert masked pbb_isid and tunnel_id fields. This patch fixes to convert masked match field into str type and not to convert non-masked field. These changes will improve maintainability when ofctl_v1_*.py will support new match fields. Reported-by: Weijie Liu <wliu43@illinois.edu> Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-08-30doc: ofctl_rest: Add table of contentsYusuke Iwase
This patch adds a table of contents into the ofctl_rest API reference in order to improve its readability. Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-08-21doc: Include snort_integrate page into toctreeYusuke Iwase
Currently, snort_integrate page is not included into toctree, and it is difficult for user to find this page. This patch adds snort_integrate page into toctree, and removes warnings when building this page. Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-07-30Add OVSDB manager protocol applicationJason Kölker
Allows listening on a socket for OVSDB clients, reacting to their events and modifying their database. Co-Authored-By: Chris Hansen <chris.hansen.career@gmail.com> Co-Authored-By: Ravi Kamachi <ravi.kamachi@rackspace.com> Signed-off-by: Jason Kölker <jason@koelker.net> Signed-off-by: Chris Hansen <chris.hansen.career@gmail.com> Signed-off-by: Ravi Kamachi <ravi.kamachi@rackspace.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-03-18doc/app/ofctl_rest: Fix example of ipv6_exthdr match fieldYusuke Iwase
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-01-20doc/app/ofctl_rest: Add description for OFPAggregateStats messageYusuke Iwase
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-01-20doc/app/ofctl_rest: Add description for OFPQueueStats messageYusuke Iwase
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-01-19doc/app/ofctl_rest: Add descriptions for duration_nsec fieldYusuke Iwase
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-12-07bgp: support new handler in case of changing BGP sessionToshiki Tsuboi
When BGP session goes up/down, BGPSpeaker can detect changing the session. Signed-off-by: Toshiki Tsuboi <t.tsubo2000@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-12-05doc/app/ofctl_rest: Add description for capabilities field in OPFMeterFeaturesYusuke Iwase
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-11-29doc/app/ofctl_rest: Add command examples for OFPVID_NONE/PRESENTMinoru TAKAHASHI
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-11-17doc/app/ofctl_rest: Correct command examplesYusuke Iwase
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-11-07ofctl_v1_0: Add remaining actionsYusuke Iwase
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-11-07doc: Add tables about match and actions structuresYusuke Iwase
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-10-10doc: add lib.packet.bfd classes to library_packet_ref.Wei-Li Tang
Signed-off-by: Wei-Li Tang <alextwl@xinguard.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-09-30doc: Add ryu.app.ofctl_rest documentYusuke Iwase
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-09-12bgp: local preference supportHiroshi Yokoi
add local preference support in bgp. It is possible to apply local preference to specific paths by using AttributeMap. Unfortunately this patch supports only IPv4 path and I'm going to start writing patches for other route families after this. Signed-off-by: Hiroshi Yokoi <yokoi.hiroshi@po.ntts.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-09-07Snort Integrate:Che-Wei Lin
Remove the wrong way to get IP and bind with it. Binding with '0.0.0.0' and listen on all host. Update and fix typos in the snort_integrate.rst document. Fix the problem about pigrelay reconnect to ryu will not be accepted. Pigrelay is a program running on Snort that receive Snort alert from UNIX socket and send to Ryu via network socket. Signed-off-by: Che-Wei Lin <linton.tw@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-09-01Snort integrate: Add the snort lib supporting snort integration. Add an ↵John-Lin
sample application simple_switch_snort.py which can dump alert message. When there is a Snort alert message, Ryu will receive an event called EventAlert. You can easily define the event handler in the method which using ‘set_ev_cls’ decorator with snortlib.EventAlert parameter. The simple_switch_snort.py can install a flow that mirroring incoming packets to the snort's NIC which correspond the OpenFlow switch on port 3 (by default). There are two methods that sending alert message to Ryu. 1. Ryu and Snort are both on the same machine. Ryu receives alert message via Unix Domain Socket. 2. Ryu and Snort are separate on different machines. Ryu receives alert message via Network Socket. More detail see doc/snort_integrate.rst Signed-off-by: Che-Wei Lin <linton.tw@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-08-14bgp: refine the API for connecting to bmp serverFUJITA Tomonori
We might want a bgp speaker to talk with multiple bmp servers in the future so I renamed these functions. Note that currently a speaker can connect to only one bmp server. I also update the example code on how to make the speaker to connect to a bmp server. Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-07-28bgp: refine and fix filter codeISHIDA Wataru
- change the name of the filter class from PrefixList to PrefixFilter to make it easy to understand the role of this class. - update docs - fix bugs Signed-off-by: ISHIDA Wataru <ishida.wataru@lab.ntt.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-07-17bgp: add out-filter functionHiroshi Yokoi
Added out-filter function to Ryu BGPSpeaker. It supports IPv4 and IPv6. Signed-off-by: Hiroshi Yokoi <yokoi.hiroshi@po.ntts.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-26doc: improve the appearance of the tableYoshihiro Kaneko
I don't want to write a directive of sphinx in scripts, but I was not able to find other methods. Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-26doc: leave out too large samplesYoshihiro Kaneko
To let compilation of the document succeed, this patch leave out large samples. Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-23document: ryu.app.gui_topologyYAMADA Hideki
Signed-off-by: YAMADA Hideki <yamada.hideki@po.ntts.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-22bgp: fix example codeFUJITA Tomonori
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-22library_bgp_speaker.rst: make an example more completeYAMAMOTO Takashi
also, while i'm here, remove trailing whitespaces in the example. Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-19package: add python-ryu-docYoshihiro Kaneko
This patch adds python-ryu-doc package which contains the HTML documentation generated from doc/. Also updates the man pages in doc/source/man/. Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-18document ryu.app.ofctlYAMAMOTO Takashi
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-13bgp: add bgpspaker module for non Ryu application usageFUJITA Tomonori
This enables you to use Ryu BGP feature as 'bgp speaker' python library, that is, without ryu-manager, RPC API, REST API, or other Ryu stuff, you can use Ryu BGP feature in your python application (just import bgpspeaker.py). The sample code and the API reference docs are included too. Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> Reviewed-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
2014-06-10packet lib: add Connectivity Fault Management Protocol(CFM, IEEE 802.1ag)takahashi.minoru
Signed-off-by: TAKAHASHI Minoru <takahashi.minoru7@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-03doc: add test-of-config-with-linc pageYoshihiro Kaneko
port from wiki page. Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-03doc: add test-vrrp pageYoshihiro Kaneko
port from wiki page. Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-05-27doc: add components pageYoshihiro Kaneko
port from wiki. dummy quantumclient is necessary to import ryu.app.quantum_adapter by sphinx.ext.autodoc. Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
2014-05-15add openflow api reference for of1.4Yoshihiro Kaneko
Update OpenFlow API document. - add OpenFlow 1.4 API Reference - update OpenFlow API Reference index for OF1.4 Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-04-21remove obsolete man pages (rpc_cli and neutron_ofagent_agent)FUJITA Tomonori
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-04-21delete bin/neutron-ofagent-agentFUJITA Tomonori
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> Reviewed-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
2014-04-21delete bin/rpc-cliFUJITA Tomonori
This command is available via ryu command. Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-04-20document ryu commandYAMAMOTO Takashi
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
2014-03-25doc: remove a stale referenceYAMAMOTO Takashi
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-11 19:11:06 +0000