Files
os-ken/doc/source/components.rst
Hongbin Lu 52a227c309 Fixup the docs building
This commit enable users to run `tox -e docs` to build docs for os-ken.
It fixes several issues to ensure the build will succeed.
In addition, the docs from upstream Ryu library is grouped into
archived content. The future work is merging those docs into
the os-ken contents.

Change-Id: I5ee1998e0d2835495650cda530eb0b73c49b091a
2018-10-17 18:51:14 +00:00

2.9 KiB

Components of OS-Ken

Executables

bin/os_ken-manager

The main executable.

Base components

os_ken.base.app_manager

os_ken.base.app_manager

OpenFlow controller

os_ken.controller.controller

os_ken.controller.controller

os_ken.controller.dpset

os_ken.controller.dpset

os_ken.controller.ofp_event

os_ken.controller.ofp_event

os_ken.controller.ofp_handler

os_ken.controller.ofp_handler

OpenFlow wire protocol encoder and decoder

os_ken.ofproto.ofproto_v1_0

os_ken.ofproto.ofproto_v1_0

os_ken.ofproto.ofproto_v1_0_parser

os_ken.ofproto.ofproto_v1_0_parser

os_ken.ofproto.ofproto_v1_2

os_ken.ofproto.ofproto_v1_2

os_ken.ofproto.ofproto_v1_2_parser

os_ken.ofproto.ofproto_v1_2_parser

os_ken.ofproto.ofproto_v1_3

os_ken.ofproto.ofproto_v1_3

os_ken.ofproto.ofproto_v1_3_parser

os_ken.ofproto.ofproto_v1_3_parser

os_ken.ofproto.ofproto_v1_4

os_ken.ofproto.ofproto_v1_4

os_ken.ofproto.ofproto_v1_4_parser

os_ken.ofproto.ofproto_v1_4_parser

os_ken.ofproto.ofproto_v1_5

os_ken.ofproto.ofproto_v1_5

os_ken.ofproto.ofproto_v1_5_parser

os_ken.ofproto.ofproto_v1_5_parser

OS-Ken applications

os_ken.app.cbench

os_ken.app.cbench

os_ken.app.simple_switch

os_ken.app.simple_switch

os_ken.topology

os_ken.topology

Libraries

os_ken.lib.packet

os_ken.lib.packet

os_ken.lib.ovs

os_ken.lib.ovs

os_ken.lib.of_config

os_ken.lib.of_config

os_ken.lib.netconf

os_ken.lib.netconf

os_ken.lib.xflow

os_ken.lib.xflow

Third party libraries

os_ken.contrib.ovs

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

os_ken.contrib.oslo.config

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

os_ken.contrib.ncclient

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