Genius-130: Test plan for OF-Tunnels
[genius.git] / docs / genius-design-doc.rst
1 ======================
2 Genius Design Overview
3 ======================
4
5 Genius project provides generic infrastructure services and utilities for
6 integration and co-existance of mulltiple networking services/applications.
7 Following image presents a top level view of Genius framework -
8
9 .. image:: https://wiki.opendaylight.org/images/3/3e/Genius_overview.png
10     :align: center
11     :height: 400px
12     :width: 800px
13
14 Genius Module Dependencies
15 ==========================
16
17 Genius modules are developed as karaf features which can be independently
18 installed. However, there is some dependency among these modules. The
19 diagram below provides a dependency relationship of these modules.
20
21 .. graphviz:: images/gen.dot
22
23 All these modules expose Yang based API which can be used to
24 configure/interact with these modules and fetch  services provided by
25 these modules. Thus all these modules can be used/configured by other
26 ODL modules and can also be accessed via REST interface.
27
28 Genius based packet pipeline
29 ============================
30
31 Following picture presents an example of packet pipeline based on Genius framework.
32 It also presents the functions of diffrent genius components -
33
34 .. image:: https://wiki.opendaylight.org/images/5/56/App_co_exist_new.png
35    :scale: 80 %
36    :align: center
37
38
39 Following sections provide details about each of these components.
40
41 .. toctree::
42    :maxdepth: 1
43
44    interface-manager-design
45    ITM-design
46    datastore-job-coordinator
47
48 #. Aliveness Monitor
49 #. ID-Manager
50 #. MDSAL Utils
51 #. Resource Manager
52 #. FCAPS manager
53