604b16c565
Currently, Ryu-Documentation page adopts 'haiku' for Sphinx html_theme, but 'haiku' does not have page-index and no sidebar. This patch changes Sphinx html_theme to 'sphinx_rtd_theme', which outputs page-index for each page and a mobile-friendly sphinx theme that was made for readthedocs.org. Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
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, 1.5 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 ryuIf you prefer to install Ryu from the source code:
% git clone git://github.com/osrg/ryu.git
% cd ryu; python ./setup.py installIf 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.pyOptional 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 paramikoSupport
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.