openstack/os-ken
Code Issues Proposed changes
A component-based software defined networking framework for OpenStack.
363 Commits 10 Branches 42 Tags 9.9 MiB
Python 86.1%
Erlang 13.3%
C 0.4%
Shell 0.2%
83e53c5065
Go to file
FUJITA Tomonori 83e53c5065 doc: rearrange top page 
Rearrange the top page in the following way:

- Getting Started
- Cloud Integration (OpenStack only for now)
- Developing Your App

Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-09-17 13:15:47 +09:00
bin register OFP handlers via register_instance 2012-09-05 09:23:35 +09:00
doc doc: rearrange top page 2012-09-17 13:15:47 +09:00
etc/ryu ryu.conf: eliminate obsolete config 2012-01-24 11:54:53 +09:00
ryu app/simple_isolation: update handler registration 2012-09-12 12:37:59 +09:00
tools test: use the latest version of pep8 2012-08-22 06:24:11 +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
LICENSE Switch to Apache 2.0 license 2012-04-06 08:38:45 +09:00
MANIFEST.in remote COPYRIGHT file from MANIFEST.in 2012-05-07 21:52:52 +09:00
README.rst doc: use README as getting_started 2012-09-17 13:15:45 +09:00
run_tests.sh test: improve the framework 2012-06-27 20:57:07 +09:00
setup.cfg update setup.py and setup.cfg for better packaging 2012-06-06 12:45:46 +09:00
setup.py fix pep8 1.3.3 warnings 2012-08-22 06:27:12 +09:00
SubmittingPatches.rst doc: integrate HACKING.rst into SubmittingPatches.rst 2012-09-04 06:47:58 +09:00

README.rst

What's Ryu

Ryu is an Operating System for Software Defined Networking.

Ryu aims to provide a logically centralized control and well defined API that make it easy for operators to create new network management and control applications. Currently, Ryu manages network devices by using OpenFlow. You can say that Ryu is an OpenFlow Controller, which support OpenFlow v1.0, v1.2, 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.com/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.