mirrors/ryu
1
0
Fork 0
mirror of https://github.com/faucetsdn/ryu.git synced 2025-08-07 15:17:13 +02:00
Code Issues Projects Releases Wiki Activity
208 Commits 2 Branches 109 Tags 30 MiB
Python 86.8%
Erlang 12.4%
C 0.4%
Shell 0.3%
JavaScript 0.1%
4e62b4ebcc
Go to file
FUJITA Tomonori 4e62b4ebcc update the official site url 
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-06-16 09:11:18 +09:00
bin support commandline application initialization 2012-06-09 20:07:43 +09:00
doc doc/source/step_by_step.rst: add item to setup quantum db 2012-05-07 15:57:25 +09:00
etc/ryu ryu.conf: eliminate obsolete config 2012-01-24 11:54:53 +09:00
ryu ofproto/nx_match: various minor clean up 2012-06-16 09:02:44 +09:00
tools Added test framework, ported from Quantum 2012-05-07 21:29:47 +09:00
.gitignore Added test framework, ported from Quantum 2012-05-07 21:29:47 +09:00
.pylintrc Added test framework, ported from Quantum 2012-05-07 21:29:47 +09:00
HACKING.rst add HACKING.rst: style guide 2012-02-22 20:25:15 +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 update the official site url 2012-06-16 09:11:18 +09:00
run_tests.sh Added test framework, ported from Quantum 2012-05-07 21:29:47 +09:00
setup.cfg update setup.py and setup.cfg for better packaging 2012-06-06 12:45:46 +09:00
setup.py update the official site url 2012-06-16 09:11:18 +09:00

README.rst 

****************************
Ryu Network Operating System
****************************

For details, please see the documentation under doc/ directory and
make html (or make <format you prefer>). If you have any
questions, suggestions, and patches, the mailing list is available at
`ryu-devel ML
<https://lists.sourceforge.net/lists/listinfo/ryu-devel>`_.
`The ML archive at Gmane <http://dir.gmane.org/gmane.network.ryu.devel>`_
is also available.

Ryu Official site is `<http://osrg.github.com/ryu/>`_.


Overview
========
Ryu is an open-sourced Network Operating System (NOS) licensed under
Apache v2.0. It's fully written in Python.

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 supports OpenFlow protocol to
modify the behavior of network devices.

We aim at the de facto OSS NOS implementation and NOS API.

Currently, Ryu is shipped with one control application for `OpenStack
<http://openstack.org/.>`_ network management L2 segregation of
tenants without using VLAN. The application is included in OpenStack
mainline as of Essex release.

The project goal is to develop an OSS Network Operating System that
has high quality enough for use in large production environment in
code quality/functionality/usability.


TODO
====
* OpenFlow Protocol version 1.2 (right after the spec release)
* The better API for control applications
* Cluster support
* ...too many for here.


Quick Start
===========
Get source code::

   % git clone git://github.com/osrg/ryu.git

Then just type::

   % cd ryu; python ./setup.py install

and run ryu-manager command which is installed.
Then set up your openflow switch (hardware switch or OVS) to connect the ip
address and port to which ryu-manager is listening.
If you want to use it with Openstack (nova and quantum with ovs plugin),
please refer detailed documents under doc/ directory.


Requirement
===========
* setuptools
* gevent >= 0.13
* python-gflags
* Sphinx
* WebOb
* Routes

Project Members
===============
* OHMURA Kei <ohmura.kei at lab.ntt.co.jp>
* MORITA Kazutaka <morita.kazutaka at lab.ntt.co.jp>
* Isaku Yamahata <yamahata at valinux co jp>
* FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>