A component-based software defined networking framework for OpenStack.

Go to file

Yusuke Iwase fe86b9527e packet.ospf: Avoid parameter 'cls' reassignment Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>		2015-06-30 17:00:24 +09:00
bin	delete bin/neutron-ofagent-agent	2014-04-21 19:06:25 +09:00
debian	pip-requires: gui_topology requires webob>=1.2	2014-07-07 22:13:37 +09:00
doc	doc/app/ofctl_rest: Fix example of ipv6_exthdr match field	2015-03-18 22:27:12 +09:00
etc/ryu	ryu.conf: obsoleted argument used in sample configuration	2014-03-16 20:26:09 +09:00
ryu	packet.ospf: Avoid parameter 'cls' reassignment	2015-06-30 17:00:24 +09:00
tools	python3: Use formencode instead of xml_compare	2015-06-25 12:23:31 +09:00
.gitignore	add .tox/ to .gitignore	2013-09-02 14:44:29 +09:00
.pylintrc	test: improve the framework	2012-06-27 20:57:07 +09:00
.travis.yml	travis-ci: use container-based infrastructure for faster testings	2015-02-16 13:23:39 +09:00
CONTRIBUTING.rst	doc: update obsolete Linux kernel SubmittingPatches url	2014-08-29 22:39:33 +09:00
LICENSE	LICENCE: change end-of-line code CRLF to LF	2013-02-13 06:10:15 +09:00
MANIFEST.in	MANIFEST.in: Exclude packet_data_generator2	2015-04-28 10:57:28 +09:00
README.rst	README.rst: Correct component which needs paramiko	2015-04-26 20:46:11 +09:00
run_tests.sh	add pep8 options to tox.ini	2014-05-14 15:39:33 +09:00
setup.cfg	fix setup.cfg entry	2014-08-15 11:01:26 +09:00
setup.py	Cap pbr version	2015-05-27 11:09:51 +09:00
tox.ini	tox.ini: Be able to run python3 unit tests	2015-06-20 21:18:58 +09:00

README.rst

What's Ryu

Ryu is a component-based software defined networking framework.

Ryu provides software components with well defined API that make it easy for developers to create new network management and control applications. Ryu supports various protocols for managing network devices, such as OpenFlow, Netconf, OF-config, etc. About OpenFlow, Ryu supports fully 1.0, 1.2, 1.3, 1.4 and Nicira Extensions.

All of the code is freely available under the Apache 2.0 license. Ryu is fully written in Python.

Quick Start

Installing Ryu is quite easy:

% pip install ryu

If you prefer to install Ryu from the source code:

% git clone git://github.com/osrg/ryu.git
% cd ryu; python ./setup.py install

If you want to use Ryu with OpenStack, please refer networking-ofagent project.

If you want to write your Ryu application, have a look at Writing ryu application document. After writing your application, just type:

% ryu-manager yourapp.py

Optional Requirements

Some functionalities of ryu requires extra packages:

OF-Config requires lxml
NETCONF requires paramiko
BGP speaker (ssh console) requires paramiko

If you want to use the functionalities, please install requirements:

% pip install lxml
% pip install paramiko

Support

Ryu Official site is http://osrg.github.io/ryu/.

If you have any questions, suggestions, and patches, the mailing list is available at ryu-devel ML. The ML archive at Gmane is also available.