Update REAME.rst

- simplify a bit since we have the web site now. We don't use
  README.rst for index.html anymore.
- rewrite 'What's Ryu' section so that it can be used for RPM package
  description.

Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
This commit is contained in:
FUJITA Tomonori 2012-06-18 21:25:23 +09:00
parent c60e1d6545
commit 8b93eda2cd
1 changed files with 43 additions and 69 deletions

View File

@ -2,77 +2,51 @@
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
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.
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 <http://openstack.org/>`_,
please refer `detailed documents <http://www.osrg.net/ryu/overview.html/>`_.
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 run your Ryu application, Let's start with
`a simple example
<https://github.com/osrg/ryu/blob/master/ryu/app/simple_switch.py>`_.
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
<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>