openstack/os-ken
Code Issues Proposed changes
A component-based software defined networking framework for OpenStack.
1,048 Commits 10 Branches 46 Tags 10 MiB
Python 86.1%
Erlang 13.3%
C 0.4%
Shell 0.2%
eacabd75c5
Go to file
FUJITA Tomonori eacabd75c5 doc: fix warnings 
ryu/lib/packet/icmpv6.py:docstring of ryu.lib.packet.icmpv6.nd_option_pi:23: WARNING: Inline emphasis start-string without end-string.
ryu/doc/source/ofproto_v1_2_ref.rst:: WARNING: document isn't included in any toctree
ryu/doc/source/ofproto_v1_3_ref.rst:: WARNING: document isn't included in any toctree

Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-09-02 20:12:51 +09:00
doc doc: fix warnings 2013-09-02 20:12:51 +09:00
etc/ryu revert s/_/-/ changes for ryu.conf 2013-03-04 21:14:29 +09:00
ryu doc: fix warnings 2013-09-02 20:12:51 +09:00
tools a simple script to plot rest_topology's output 2013-08-26 15:04:47 +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 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 MANIFEST.in: exclude packet_data_generator 2013-08-24 09:41:44 +09:00
README.rst sync README with the web site 2013-08-01 10:09:36 +09:00
run_tests.sh remove bin/ryu-manager from the list of files for pylint/pep8 2013-09-02 14:41:27 +09:00
setup.cfg stick with pbr 0.5.19 2013-09-02 14:41:27 +09:00
setup.py workaround a python bug 2013-09-02 14:41:28 +09:00
SubmittingPatches.rst doc: fix the mailing list address 2013-04-13 04:40:34 +09:00
tox.ini Add a configuration file for tox (http://testrun.org/tox/) 2013-09-02 12:35:05 +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.