A component-based software defined networking framework for OpenStack.
Go to file
IWASE Yusuke f0fb62cbf9 contrib/tinyrpc: Remove embedded tinyrpc, use upstream
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2016-11-04 09:51:36 +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: Add API reference for REST EVPN switch 2016-10-01 21:28:52 +09:00
etc/ryu ryu.conf: obsoleted argument used in sample configuration 2014-03-16 20:26:09 +09:00
ryu contrib/tinyrpc: Remove embedded tinyrpc, use upstream 2016-11-04 09:51:36 +09:00
tools contrib/ncclient: Remove embedded ncclient, use upstream 2016-11-04 09:51:27 +09:00
.gitignore add .tox/ to .gitignore 2013-09-02 14:44:29 +09:00
.pylintrc .pylintrc: Remove deprecated output format feature 2016-02-27 20:40:35 +09:00
.travis.yml ut/ovs: Add UT using Docker for ryu.lib.ovs 2016-11-04 09:32:10 +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 Update the readthedoc URL 2016-07-01 12:14:51 +09:00
run_tests.sh add pep8 options to tox.ini 2014-05-14 15:39:33 +09:00
setup.cfg drop python2.6 support 2016-02-18 06:54:47 +09:00
setup.py Uncap pbr version 2015-09-15 17:01:53 +09:00
tox.ini Enable to run a scnario test for ryu bgp on travis 2016-10-29 06:27:56 +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, 1.5 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 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
  • OVSDB support requires ovs (Note: python 3.4 requires ovs>=2.6.0.dev0)

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

% pip install lxml
% pip install paramiko
% pip install ovs

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.