os-ken/doc/source/components.rst
Slawek Kaplonski cd4926b235 Remove os_ken/app and os_ken/services/protocols/bgp/api/jsonrpc modules
The os_ken/services/protocols/bgp/api/jsonrpc.py module was using
os_ken/app and os_ken app is the only one which was using tinyrpc lib.
Modules under os_ken/app except os_ken/app/ofctl are not used in neutron
and neutron-dynamic-routing so lets drop them from the code.

With that we can also drop tinyrpc from the requirements file at all.

Task: #41912
Story: #2008648
Change-Id: Ic35d1f7ee4112bc5cf16fee3d828534ded26ce7f
2021-03-02 08:29:32 +09:00

137 lines
2.7 KiB
ReStructuredText

********************
Components of OS-Ken
********************
Executables
===========
osken-manager
------------------
The main executable.
Base components
===============
os_ken.base.app_manager
-----------------------
.. automodule:: os_ken.base.app_manager
OpenFlow controller
===================
os_ken.controller.controller
----------------------------
.. automodule:: os_ken.controller.controller
os_ken.controller.dpset
-----------------------
.. automodule:: os_ken.controller.dpset
os_ken.controller.ofp_event
---------------------------
.. automodule:: os_ken.controller.ofp_event
os_ken.controller.ofp_handler
-----------------------------
.. automodule:: os_ken.controller.ofp_handler
OpenFlow wire protocol encoder and decoder
==========================================
os_ken.ofproto.ofproto_v1_0
---------------------------
.. automodule:: os_ken.ofproto.ofproto_v1_0
os_ken.ofproto.ofproto_v1_0_parser
----------------------------------
.. automodule:: os_ken.ofproto.ofproto_v1_0_parser
os_ken.ofproto.ofproto_v1_2
---------------------------
.. automodule:: os_ken.ofproto.ofproto_v1_2
os_ken.ofproto.ofproto_v1_2_parser
----------------------------------
.. automodule:: os_ken.ofproto.ofproto_v1_2_parser
os_ken.ofproto.ofproto_v1_3
---------------------------
.. automodule:: os_ken.ofproto.ofproto_v1_3
os_ken.ofproto.ofproto_v1_3_parser
----------------------------------
.. automodule:: os_ken.ofproto.ofproto_v1_3_parser
os_ken.ofproto.ofproto_v1_4
---------------------------
.. automodule:: os_ken.ofproto.ofproto_v1_4
os_ken.ofproto.ofproto_v1_4_parser
----------------------------------
.. automodule:: os_ken.ofproto.ofproto_v1_4_parser
os_ken.ofproto.ofproto_v1_5
---------------------------
.. automodule:: os_ken.ofproto.ofproto_v1_5
os_ken.ofproto.ofproto_v1_5_parser
----------------------------------
.. automodule:: os_ken.ofproto.ofproto_v1_5_parser
OS-Ken applications
===================
os_ken.topology
---------------
.. automodule:: os_ken.topology
Libraries
=========
os_ken.lib.packet
-----------------
.. automodule:: os_ken.lib.packet
os_ken.lib.ovs
--------------
.. automodule:: os_ken.lib.ovs
os_ken.lib.of_config
--------------------
.. automodule:: os_ken.lib.of_config
os_ken.lib.netconf
------------------
.. automodule:: os_ken.lib.netconf
os_ken.lib.xflow
----------------
.. automodule:: 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 osken-manager's command-line options
and configuration files.
os_ken.contrib.ncclient
-----------------------
Python library for NETCONF client. Used by os_ken.lib.of_config.