ryu/README.rst

   1 What's Ryu
   2 ==========
   3 Ryu is a component-based software defined networking framework.
   4
   5 Ryu provides software components with well defined API's that make it
   6 easy for developers to create new network management and control
   7 applications. Ryu supports various protocols for managing network
   8 devices, such as OpenFlow, Netconf, OF-config, etc. About OpenFlow,
   9 Ryu supports fully 1.0, 1.2, 1.3, 1.4, 1.5 and Nicira Extensions.
  10
  11 All of the code is freely available under the Apache 2.0 license. Ryu
  12 is fully written in Python.
  13
  14
  15 Quick Start
  16 ===========
  17 Installing Ryu is quite easy::
  18
  19    % pip install ryu
  20
  21 If you prefer to install Ryu from the source code::
  22
  23    % git clone git://github.com/osrg/ryu.git
  24    % cd ryu; pip install .
  25
  26 If you want to write your Ryu application, have a look at
  27 `Writing ryu application <http://ryu.readthedocs.io/en/latest/writing_ryu_app.html>`_ document.
  28 After writing your application, just type::
  29
  30    % ryu-manager yourapp.py
  31
  32
  33 Optional Requirements
  34 =====================
  35
  36 Some functions of ryu require extra packages:
  37
  38 - OF-Config requires lxml and ncclient
  39 - NETCONF requires paramiko
  40 - BGP speaker (SSH console) requires paramiko
  41 - Zebra protocol service (database) requires SQLAlchemy
  42
  43 If you want to use these functions, please install the requirements::
  44
  45     % pip install -r tools/optional-requires
  46
  47 Please refer to tools/optional-requires for details.
  48
  49
  50 Prerequisites
  51 =============
  52 If you got some error messages at the installation stage, please confirm
  53 dependencies for building the required Python packages.
  54
  55 On Ubuntu(16.04 LTS or later)::
  56
  57   % apt install gcc python-dev libffi-dev libssl-dev libxml2-dev libxslt1-dev zlib1g-dev
  58
  59
  60 Support
  61 =======
  62 Ryu Official site is `<http://osrg.github.io/ryu/>`_.
  63
  64 If you have any
  65 questions, suggestions, and patches, the mailing list is available at
  66 `ryu-devel ML
  67 <https://lists.sourceforge.net/lists/listinfo/ryu-devel>`_.
  68 `The ML archive at Gmane <http://dir.gmane.org/gmane.network.ryu.devel>`_
  69 is also available.