openstack/os-ken
Code Issues Proposed changes
A component-based software defined networking framework for OpenStack.
1,838 Commits 10 Branches 46 Tags 10 MiB
Python 86.1%
Erlang 13.3%
C 0.4%
Shell 0.2%
2eb59a09ff
Go to file
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
bin delete bin/neutron-ofagent-agent 2014-04-21 19:06:25 +09:00
doc doc: add components page 2014-05-27 20:24:50 +09:00
etc/ryu ryu.conf: obsoleted argument used in sample configuration 2014-03-16 20:26:09 +09:00
ryu doc: add components page 2014-05-27 20:24:50 +09:00
tools pip-requires: WebSocket-RPC requires tinyrpc 2014-05-20 12:39:09 +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 use run_tests.sh -N for Travis CI 2013-09-08 17:47:52 +09:00
CONTRIBUTING.rst Rename to CONTRIBUTING.rst 2014-04-16 15:56:59 +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_generator 2013-08-24 09:41:44 +09:00
README.rst doc: announce OF1.4 support in README 2014-01-29 14:50:40 +09:00
run_tests.sh add pep8 options to tox.ini 2014-05-14 15:39:33 +09:00
setup.cfg delete bin/rpc-cli 2014-04-21 19:05:46 +09:00
setup.py avoid pbr's non multi-version aware script 2013-10-07 18:08:36 +09:00
tox.ini add pep8 options to tox.ini 2014-05-14 15:39:33 +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 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.