1 ========================================================
2 Genius (Generic Network Interface, Utilities & Services)
3 ========================================================
5 Genius project provides Generic Network Interfaces, Utilities & Services. Any ODL application can use these to achieve interference-free co-existence with other applications using Genius. OpendayLight Carbon Genius provides following modules --
7 * **Interface (logical port) Manager** allows bindings/registration of multiple services to logical ports/interfaces
8 * **Overlay Tunnel Manager** creates and maintains overlay tunnels between configured tunnel endpoints
9 * **Aliveness Monitor** provides tunnel/nexthop aliveness monitoring services
10 * **ID Manager** generates cluster-wide persistent unique integer IDs
11 * **MD-SAL Utils** provides common generic APIs for interaction with MD-SAL
12 * **Resource Manager** provides a resource sharing framework for applications sharing common resources e.g. table-ids, group-ids etc.
13 * **FCAPS Application** generates various alarms and counters for the different genius modules
14 * **FCAPS Framework** module collectively fetches all data generated by fcaps application. Any underlying infrastructure can subscribe for its events to have a generic overview of the various alarms and counters
19 * **Features URL:** https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob;f=features/genius-features/src/main/features/features.xml
24 * **Feature Description:** Provides all functionalities provided by genius modules, including interface manager, tunnel manager, resource manager and ID manager and MDSAL Utils.
27 * **User Facing:** Yes
28 * **Experimental:** No
31 * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-genius-all-carbon/
32 * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-genius-all-carbon/
35 odl-genius-fcaps-application
36 ----------------------------
38 * **Feature Description:** includes genius FCAPS application.
40 * **User Facing:** Yes
41 * **Experimental:** Yes
42 * **CSIT Tests:** None
44 odl-genius-fcaps-framework
45 --------------------------
47 * **Feature Description:** includes genius FCAPS Framework.
49 * **User Facing:** Yes
50 * **Experimental:** Yes
51 * **CSIT Tests:** None
54 New capabilities and enhancements added in Carbon
55 =================================================
57 Planned new capabilities added
58 ------------------------------
60 * :doc:`/submodules/genius/docs/specs/of-tunnels`
61 * :doc:`/submodules/genius/docs/specs/itm-tunnel-auto-config`
62 * :doc:`/submodules/genius/docs/specs/service-binding-on-tunnels`
65 Unplanned new capabilities added (needed by Netvirt Project)
66 ------------------------------------------------------------
68 * :doc:`/submodules/genius/docs/specs/multiple-vxlan-tunnels`
70 Enhancements added to existing features/services
71 ------------------------------------------------
73 * Interface manager : Increase max services bind on an interface to 16
74 * ITM to support same TEP in multiple Transport Zones
75 * Various performance and scale improvements
77 Enhancements added to project
78 -----------------------------
80 #. Migration to Blueprint
81 #. Checkstyle enforcement
82 #. IT framework enhancements
83 #. Junits and CSIT enhancements
88 * **Installation Guide(s):**
94 * :doc:`User Guide </user-guide/genius-user-guide>`
96 * **Developer Guide(s):**
98 * :doc:`Developer Guide </submodules/genius/docs/index>`
100 Security Considerations
101 =======================
103 * Do you have any external interfaces other than RESTCONF?
107 * Other security issues?
114 * `Sonar Report <https://sonar.opendaylight.org/overview?id=64114>`_ (40.7%)
116 * `CSIT Jobs <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-genius-all-carbon//>`_
118 * `Netvirt CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-netvirt-carbon/>`_
120 * `Netvirt Cluster CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-cluster-netvirt-carbon/>`_
122 .. note:: Genius is used extensively in NetVirt, so NetVirt's CSIT also
123 provides confidence in genius.
125 * Other manual testing and QA information
129 * Testing methodology. How extensive was it? What should be expected to work? What hasn't been tested as much?
131 * fcaps_framework and fcaps_application features hasn't been tested much.
136 * Is it possible to migrate from the previous release? If so, how?
138 * No. OpenDaylight doesn't support migration natively for applications that use datastore.
143 * Is this release compatible with the previous release?
145 * Functionality is fully backwards compatible.
151 * Any configuration changes?
158 * List of bugs fixed since the previous release
160 * `Fixed BUGS <https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2016-08-9&chfieldto=2017-05-25&list_id=78466&product=genius&query_format=advanced&resolution=FIXED>`_
165 * List key known issues with workarounds
169 * `Open Bugs <https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2016-08-9&chfieldto=2017-05-25&list_id=78466&product=genius&query_format=advanced&bug_status=__open__>`_
174 * List of features/APIs which are EOLed, deprecated, and/or removed in this release
176 * `MDSalUtil Async*ListenerBase classes deprecated <https://git.opendaylight.org/gerrit/#/c/51913/>`_
181 * List of standards implemented and to what extent
188 * `Release plan <https://wiki.opendaylight.org/view/Genius:Carbon_Release_Plan>`_
190 * Describe any major shifts in release schedule from the release plan