1 ========================================================
2 Genius (Generic Network Interface, Utilities & Services)
3 ========================================================
5 Genius project provides Generic Network Interfaces, Utilities & Services. Any
6 ODL application can use these to achieve interference-free co-existence with
7 other applications using Genius. OpendayLight Carbon Genius provides following
10 * **Interface (logical port) Manager** allows bindings/registration of
11 multiple services to logical ports/interfaces
12 * **Overlay Tunnel Manager** creates and maintains overlay tunnels between
13 configured tunnel endpoints
14 * **Aliveness Monitor** provides tunnel/nexthop aliveness monitoring services
15 * **ID Manager** generates cluster-wide persistent unique integer IDs
16 * **MD-SAL Utils** provides common generic APIs for interaction with MD-SAL
17 * **Resource Manager** provides a resource sharing framework for applications
18 sharing common resources e.g. table-ids, group-ids etc.
19 * **FCAPS Application** generates various alarms and counters for the different
21 * **FCAPS Framework** module collectively fetches all data generated by fcaps
22 application. Any underlying infrastructure can subscribe for its events to
23 have a generic overview of the various alarms and counters
28 * **Features URL:** https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob_plain;f=features/genius-features/pom.xml
33 * **Feature Description:** This feature provides all functionalities provided by
34 genius modules, including interface manager, tunnel manager, resource manager
35 and ID manager and MDSAL Utils. It includes Genius APIs and implementation.
38 * **User Facing:** Yes
39 * **Experimental:** No
41 * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-nitrogen/
42 * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-upstream-all-nitrogen/
47 * **Feature Description:** This feature includes RESTCONF with 'odl-genius'
51 * **User Facing:** Yes
52 * **Experimental:** No
54 * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-nitrogen/
55 * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-upstream-all-nitrogen/
60 * **Feature Description:** This feature includes API for all the functionalities
65 * **Experimental:** No
67 * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-nitrogen/
68 * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-upstream-all-nitrogen/
70 odl-genius-fcaps-application
71 ----------------------------
73 * **Feature Description:** includes genius FCAPS application.
75 * **User Facing:** Yes
76 * **Experimental:** Yes
77 * **CSIT Tests:** None
79 odl-genius-fcaps-framework
80 --------------------------
82 * **Feature Description:** includes genius FCAPS Framework.
84 * **User Facing:** Yes
85 * **Experimental:** Yes
86 * **CSIT Tests:** None
89 New capabilities and enhancements added in Nitrogen
90 ===================================================
92 Planned new capability added
93 ----------------------------
95 * :doc:`/submodules/genius/docs/specs/service-recovery`
98 Enhancements added to project
99 -----------------------------
101 #. Migration to Karaf4
108 * **Installation Guide(s):**
114 * :doc:`User Guide </user-guide/genius-user-guide>`
116 * **Developer Guide(s):**
118 * :doc:`Developer Guide </submodules/genius/docs/index>`
120 Security Considerations
121 =======================
123 * Do you have any external interfaces other than RESTCONF?
127 * Other security issues?
134 * `Sonar Report <https://sonar.opendaylight.org/overview?id=64114>`_
136 * `CSIT Jobs <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-nitrogen//>`_
138 * `Netvirt CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-netvirt-nitrogen/>`_
140 * `Netvirt Cluster CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-cluster-netvirt-nitrogen/>`_
142 .. note:: Genius is used extensively in NetVirt, so NetVirt's CSIT also
143 provides confidence in genius.
145 * Other manual testing and QA information
149 * Testing methodology. How extensive was it? What should be expected to work?
150 What hasn't been tested as much?
152 * fcaps_framework and fcaps_application features hasn't been tested much.
157 * Is it possible to migrate from the previous release? If so, how?
159 * No. OpenDaylight doesn't support migration natively for applications that
165 * Is this release compatible with the previous release?
167 * Functionality is fully backwards compatible.
171 * New API added for `service-recovery </submodules/genius/docs/specs/service-recovery>` feature
173 * Any configuration changes?
180 * List of bugs fixed since the previous release
182 * `Fixed BUGS <https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2017-05-25&chfieldto=2017-08-09&list_id=78466&product=genius&query_format=advanced&resolution=FIXED>`_
187 * List key known issues with workarounds
191 * `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__>`_
196 * List of features/APIs which are EOLed, deprecated, and/or removed in this
204 * List of standards implemented and to what extent
211 * `Release plan <https://wiki.opendaylight.org/view/Genius:Nitrogen_Release_Plan>`_
213 * Describe any major shifts in release schedule from the release plan