Commit Graph

132 Commits

Author SHA1 Message Date
Shinpei Muraoka
a1a5ff08b6 doc/app/ofctl_rest: Add the attribute for message
This patch adds attributes of the following messages.
 - Add the port number for get ports stats.
 - Add the group id for get group stats.
 - Add the meter id for get meter stats.
 - Add the meter id for get meter config.
 - Add the port number and queue id for get queue stats.

Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-03-23 22:44:08 +09:00
Minoru TAKAHASHI
03e365d6b1 doc/app/ofctl_rest: Update description for action type of experimenter
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-03-11 23:44:08 +09:00
IWASE Yusuke
9571fde7dd doc: Add Nicira Extension Structures references
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-01-19 10:52:21 +09:00
Minoru TAKAHASHI
30e2eb67c4 doc/app/ofctl_rest: Add description for OFPTableStats message
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-10-28 14:44:41 +09:00
Minoru TAKAHASHI
58cb365755 doc/app/ofctl_rest: Add description for OFPQueueGetConfig message
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-10-28 14:44:41 +09:00
Minoru TAKAHASHI
ec55ca5756 doc/app/ofctl_rest: Add description for OFPTableFeaturesStats message
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-10-28 14:44:41 +09:00
IWASE Yusuke
604b16c565 doc: Change Sphinx html_theme to sphinx_rtd_theme
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-22 05:45:50 +09:00
Yusuke Iwase
b4c3ef03a4 doc: Add openflow api reference for of1.0
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-10-11 21:51:38 +09:00
FUJITA Tomonori
927cda4392 remove old Ryu OpenStack plugin stuff
The plugin that uses these was removed from OpenStack long ago.

Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-09-28 22:23:21 +09:00
Minoru TAKAHASHI
7872ba275c doc/ofproto_v1_2_ref: Add description for Port Structures
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-09-18 08:27:42 +09:00
Minoru TAKAHASHI
2079d06d6f doc/ofproto_v1_3_ref: Add description for Port Structures
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-09-18 08:27:42 +09:00
Minoru TAKAHASHI
950a506494 doc/ofproto_v1_4_ref: Add description for Port Structures
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-09-18 08:27:42 +09:00
Minoru TAKAHASHI
c36bafea26 doc/ofproto_v1_5_ref: Add description for Port Structures and Controller Status Structure
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-09-18 08:27:42 +09:00
Minoru TAKAHASHI
b874ae839d doc/app/ofctl_rest: Add command examples for WRITE/CLEAR_ACTIONS
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-09-15 17:01:54 +09:00
Minoru TAKAHASHI
97906ee740 doc: Add some JSON examples to openflow api reference for of1.5
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-09-10 11:06:43 +09:00
Minoru TAKAHASHI
5b0106eb45 doc: Add openflow api reference for of1.5
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-09-10 11:06:43 +09:00
Yusuke Iwase
2701fa129f ofctl_v1_[23]: Convert masked match value into str
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-30 14:21:51 +09:00
Yusuke Iwase
7028704b3f doc: ofctl_rest: Add table of contents
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-30 14:04:38 +09:00
Yusuke Iwase
1fc4ec6d8a doc: Include snort_integrate page into toctree
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-08-21 09:39:48 +09:00
Jason Kölker
aa198d6900 Add OVSDB manager protocol application
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-07-30 16:54:46 +09:00
Yusuke Iwase
7c98ab2345 doc/app/ofctl_rest: Fix example of ipv6_exthdr match field
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-03-18 22:27:12 +09:00
Yusuke Iwase
1a03f4c650 doc/app/ofctl_rest: Add description for OFPAggregateStats message
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-01-20 13:12:48 +09:00
Yusuke Iwase
310e20ee0b doc/app/ofctl_rest: Add description for OFPQueueStats message
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-01-20 13:12:48 +09:00
Yusuke Iwase
ef909210b7 doc/app/ofctl_rest: Add descriptions for duration_nsec field
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-01-19 00:46:26 +09:00
Toshiki Tsuboi
3c03ba0034 bgp: support new handler in case of changing BGP session
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-07 23:35:01 +09:00
Yusuke Iwase
567ff4ec17 doc/app/ofctl_rest: Add description for capabilities field in OPFMeterFeatures
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-12-05 10:00:58 +09:00
Minoru TAKAHASHI
d72ff0a550 doc/app/ofctl_rest: Add command examples for OFPVID_NONE/PRESENT
Signed-off-by: Minoru TAKAHASHI <takahashi.minoru7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-11-29 08:17:02 +09:00
Yusuke Iwase
7b97aa040a doc/app/ofctl_rest: Correct command examples
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-11-17 08:27:17 +09:00
Yusuke Iwase
9ed1681783 ofctl_v1_0: Add remaining actions
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-11-07 22:00:32 +09:00
Yusuke Iwase
74c6595305 doc: Add tables about match and actions structures
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-11-07 22:00:31 +09:00
Wei-Li Tang
49aa2ff9ae doc: add lib.packet.bfd classes to library_packet_ref.
Signed-off-by: Wei-Li Tang <alextwl@xinguard.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-10-10 10:25:43 +09:00
Yusuke Iwase
2a4ba63d55 doc: Add ryu.app.ofctl_rest document
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-09-30 11:33:28 +09:00
Hiroshi Yokoi
fad987254d bgp: local preference support
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-12 14:33:50 -07:00
Che-Wei Lin
aa21f3d052 Snort Integrate:
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-07 22:32:16 +09:00
John-Lin
bbb7724423 Snort integrate: Add the snort lib supporting snort integration. Add an 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-09-01 15:16:05 +09:00
FUJITA Tomonori
a60c18207e bgp: refine the API for connecting to bmp server
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-08-14 18:07:45 +09:00
ISHIDA Wataru
6cbbe92806 bgp: refine and fix filter code
- 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-28 19:16:41 +09:00
Hiroshi Yokoi
3c0c9ce737 bgp: add out-filter function
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-07-17 16:34:23 +09:00
Yoshihiro Kaneko
b620f7a160 doc: improve the appearance of the table
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-26 08:28:45 +09:00
Yoshihiro Kaneko
3e1fd452b6 doc: leave out too large samples
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-26 08:28:44 +09:00
YAMADA Hideki
5b1f5aea29 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>
2014-06-23 17:12:51 +09:00
FUJITA Tomonori
9b0754944f bgp: fix example code
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-22 12:59:30 +09:00
YAMAMOTO Takashi
24f4a01bc4 library_bgp_speaker.rst: make an example more complete
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-22 12:32:39 +09:00
Yoshihiro Kaneko
03731ad04c package: add python-ryu-doc
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-19 08:41:51 +09:00
YAMAMOTO Takashi
a2fc54bd79 document ryu.app.ofctl
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-18 12:13:14 +09:00
FUJITA Tomonori
5474bf214c bgp: add bgpspaker module for non Ryu application usage
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-13 08:05:25 +09:00
takahashi.minoru
cfdce1f340 packet lib: add Connectivity Fault Management Protocol(CFM, IEEE 802.1ag)
Signed-off-by: TAKAHASHI Minoru <takahashi.minoru7@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2014-06-10 21:11:52 +09:00
Yoshihiro Kaneko
482bbc97b9 doc: add test-of-config-with-linc page
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-03 22:51:56 +09:00
Yoshihiro Kaneko
6eb3417388 doc: add test-vrrp page
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-03 22:51:54 +09:00
Yoshihiro Kaneko
2eb59a09ff doc: add components page
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-27 20:24:50 +09:00