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
42 * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-oxygen/
44 * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-upstream-all-oxygen/
49 * **Feature Description:** This feature includes RESTCONF with 'odl-genius'
53 * **User Facing:** Yes
54 * **Experimental:** No
57 * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-oxygen/
59 * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-upstream-all-oxygen/
64 * **Feature Description:** This feature includes API for all the functionalities
69 * **Experimental:** No
72 * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-oxygen/
74 * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-upstream-all-oxygen/
76 odl-genius-fcaps-application
77 ----------------------------
79 * **Feature Description:** includes genius FCAPS application.
81 * **User Facing:** Yes
82 * **Experimental:** Yes
83 * **CSIT Tests:** None
85 odl-genius-fcaps-framework
86 --------------------------
88 * **Feature Description:** includes genius FCAPS Framework.
90 * **User Facing:** Yes
91 * **Experimental:** Yes
92 * **CSIT Tests:** None
95 New capabilities and enhancements added in Oxygen
96 =================================================
98 Planned new capability added
99 ----------------------------
101 * :doc:`/submodules/genius/docs/specs/itm-scale-improvements`
103 .. note:: Some patches are under review, to be merged before Oxygen SR1
106 Other enhancements added to project
107 -----------------------------------
109 #. Using new ManagedNewTransactionRunner utility where there is a DataBroker
110 #. Using new FutureRpcResults utility in every RPC
111 #. Migrate all users of @Deprecated genius DJC to infrautils JC
112 #. Switch to using new infrautils Cache API instead of using ConcurrentMap
113 #. Migrate all users of @Deprecated Data Store Listeners to new ones
119 * **Installation Guide(s):**
125 * :doc:`User Guide </user-guide/genius-user-guide>`
127 * **Developer Guide(s):**
129 * :doc:`Developer Guide </submodules/genius/docs/index>`
131 Security Considerations
132 =======================
134 * Do you have any external interfaces other than RESTCONF?
138 * Other security issues?
145 * `Sonar Report <https://sonar.opendaylight.org/overview?id=64114>`_
149 * `CSIT Job basic <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-oxygen//>`_
151 * `CSIT Job clustering <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-upstream-all-oxygen//>`_
153 * `Netvirt CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-netvirt-oxygen/>`_
155 * `Netvirt Cluster CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-cluster-netvirt-oxygen/>`_
157 .. note:: Genius is used extensively in NetVirt, so NetVirt's CSIT also
158 provides confidence in genius.
160 * Other manual testing and QA information
164 * Testing methodology. How extensive was it? What should be expected to work?
165 What hasn't been tested as much?
167 * `Running Genius CSIT in Dev Environmrnt <http://docs.opendaylight.org/en/latest/submodules/genius/docs/genius-csit-howto.html/>`_
168 * `Genius test plans <http://docs.opendaylight.org/en/latest/submodules/genius/docs/testplans/index.html>`_
170 .. note:: fcaps_framework and fcaps_application features hasn't been tested
176 * Is it possible to migrate from the previous release? If so, how?
178 * No. OpenDaylight doesn't support migration natively for applications that
184 * Is this release compatible with the previous release?
186 * Functionality is fully backwards compatible.
190 * New APIs added for `itm-scale-improvements </submodules/genius/docs/specs/itm-scale-improvements>` feature
192 * Any configuration changes?
199 * List of bugs fixed since the previous release
201 * `Fixed BUGS <https://jira.opendaylight.org/browse/GENIUS-112?jql=project%20in%20(genius)%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20(Resolved%2C%20Verified)%20AND%20created%20%3E%3D%202017-08-14%20AND%20created%20%3C%3D%202018-03-07>`_
206 * List key known issues with workarounds
210 * `Open Bugs <https://jira.opendaylight.org/browse/GENIUS>`_
215 * List of features/APIs which are EOLed, deprecated, and/or removed in this
223 * List of standards implemented and to what extent
230 * `Release plan <https://wiki.opendaylight.org/view/Genius:Oxygen_Release_Plan>`_
232 * Describe any major shifts in release schedule from the release plan