os-ken/doc/source/components.rst
Yoshihiro Kaneko 2eb59a09ff doc: add components page
port from wiki.

dummy quantumclient is necessary to import ryu.app.quantum_adapter by
sphinx.ext.autodoc.

Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com>
2014-05-27 20:24:50 +09:00

3.2 KiB

Components of Ryu

Executables

bin/ryu-manager

The main executable.

Base components

ryu.base.app_manager

ryu.base.app_manager

OpenFlow controller

ryu.controller.controller

ryu.controller.controller

ryu.controller.dpset

ryu.controller.dpset

ryu.controller.ofp_event

ryu.controller.ofp_event

ryu.controller.ofp_handler

ryu.controller.ofp_handler

OpenFlow wire protocol encoder and decoder

ryu.ofproto.ofproto_v1_0

ryu.ofproto.ofproto_v1_0

ryu.ofproto.ofproto_v1_0_parser

ryu.ofproto.ofproto_v1_0_parser

ryu.ofproto.ofproto_v1_2

ryu.ofproto.ofproto_v1_2

ryu.ofproto.ofproto_v1_2_parser

ryu.ofproto.ofproto_v1_2_parser

ryu.ofproto.ofproto_v1_3

ryu.ofproto.ofproto_v1_3

ryu.ofproto.ofproto_v1_3_parser

ryu.ofproto.ofproto_v1_3_parser

ryu.ofproto.ofproto_v1_4

ryu.ofproto.ofproto_v1_4

ryu.ofproto.ofproto_v1_4_parser

ryu.ofproto.ofproto_v1_4_parser

Ryu applications

ryu.app.cbench

ryu.app.cbench

ryu.app.simple_switch

ryu.app.simple_switch

ryu.app.simple_isolation

ryu.app.simple_isolation

ryu.app.simple_vlan

ryu.app.simple_vlan

ryu.app.gre_tunnel

ryu.app.gre_tunnel

ryu.app.tunnel_port_updater

ryu.app.tunnel_port_updater

ryu.app.quantum_adapter

ryu.app.quantum_adapter

ryu.app.rest

ryu.app.rest

ryu.app.rest_conf_switch

ryu.app.rest_conf_switch

ryu.app.rest_quantum

ryu.app.rest_quantum

ryu.app.rest_tunnel

ryu.app.rest_tunnel

ryu.topology

ryu.topology

Libraries

ryu.lib.packet

ryu.lib.packet

ryu.lib.ovs

ryu.lib.ovs

ryu.lib.of_config

ryu.lib.of_config

ryu.lib.netconf

ryu.lib.netconf

ryu.lib.xflow

ryu.lib.xflow

Third party libraries

ryu.contrib.ovs

Open vSwitch python binding. Used by ryu.lib.ovs.

ryu.contrib.oslo.config

Oslo configuration library. Used for ryu-manager's command-line options and configuration files.

ryu.contrib.ncclient

Python library for NETCONF client. Used by ryu.lib.of_config.