openstack/os-ken
Code Issues Proposed changes
A component-based software defined networking framework for OpenStack.
2,276 Commits 10 Branches 42 Tags 9.9 MiB
Python 86.1%
Erlang 13.3%
C 0.4%
Shell 0.2%
9414322f30
Go to file
YAMAMOTO Takashi 9414322f30 Cap pbr version 
This is a workaround oslo.config related failures on readthedocs.

Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2015-05-27 11:09:51 +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/app/ofctl_rest: Fix example of ipv6_exthdr match field 2015-03-18 22:27:12 +09:00
etc/ryu ryu.conf: obsoleted argument used in sample configuration 2014-03-16 20:26:09 +09:00
ryu packet_data: Regen 2015-05-19 15:39:28 +09:00
tools Adapt to namespace-less oslo 2015-05-19 15:39:27 +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 travis-ci: use container-based infrastructure for faster testings 2015-02-16 13:23:39 +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 README.rst: Correct component which needs paramiko 2015-04-26 20:46:11 +09:00
run_tests.sh add pep8 options to tox.ini 2014-05-14 15:39:33 +09:00
setup.cfg fix setup.cfg entry 2014-08-15 11:01:26 +09:00
setup.py Cap pbr version 2015-05-27 11:09:51 +09:00
tox.ini tox.ini: Pass posargs to make "tox -e py27 path.to.test" work 2015-04-28 10:57:28 +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 networking-ofagent project.

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

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

% pip install lxml
% pip install paramiko

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.