openstack/os-ken
Code Issues Proposed changes
A component-based software defined networking framework for OpenStack.
918 Commits 10 Branches 46 Tags 10 MiB
Python 86.1%
Erlang 13.3%
C 0.4%
Shell 0.2%
0a8e581628
Go to file
YAMAMOTO Takashi 0a8e581628 doc: fix some sphinx warnings and errors 
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-13 10:01:54 +09:00
bin use d2to1 and pbr for packaging 2013-08-01 17:47:56 +09:00
doc doc: fix some sphinx warnings and errors 2013-08-13 10:01:54 +09:00
etc/ryu revert s/_/-/ changes for ryu.conf 2013-03-04 21:14:29 +09:00
ryu ofproto_v1_3_parser: add docstring to OFPMatch 2013-08-13 08:12:41 +09:00
tools a script to normalize json 2013-08-13 08:12:36 +09:00
.gitignore Added test framework, ported from Quantum 2012-05-07 21:29:47 +09:00
.pylintrc test: improve the framework 2012-06-27 20:57:07 +09:00
.travis.yml fix travis config file 2013-06-09 23:07:21 -07:00
LICENSE LICENCE: change end-of-line code CRLF to LF 2013-02-13 06:10:15 +09:00
MANIFEST.in dist: pypi tar ball misses tools directory 2013-07-23 20:54:25 +09:00
README.rst sync README with the web site 2013-08-01 10:09:36 +09:00
run_tests.sh rename ryu-client under ryu/tests 2013-07-01 06:04:06 +09:00
setup.cfg use d2to1 and pbr for packaging 2013-08-01 17:47:56 +09:00
setup.py support setup.py install with git archive tarballs 2013-08-02 14:33:40 +09:00
SubmittingPatches.rst doc: fix the mailing list address 2013-04-13 04:40:34 +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 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 detailed documents. You can create tens of thousands of isolated virtual networks without using VLAN. The Ryu application is included in OpenStack mainline as of Essex release.

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

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.