-========================================================
-Genius (Generic Network Interface, Utilities & Services)
-========================================================
+======
+GENIUS
+======
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
+other applications using Genius. OpendayLight Neon Genius provides following
modules --
* **Interface (logical port) Manager** allows bindings/registration of
Major Features
==============
-* **Features URL:** https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob_plain;f=features/genius-features/pom.xml
+odl-genius-api
+--------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob;f=features/odl-genius-api/pom.xml;hb=refs/heads/stable/neon
+* **Feature Description:** This feature includes API for all the functionalities
+ provided by Genius.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:**
+
+ * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-only-neon/
+
+ * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-gate-only-neon/
odl-genius
----------
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob;f=features/odl-genius/pom.xml;hb=refs/heads/stable/neon
* **Feature Description:** This feature provides all functionalities provided by
genius modules, including interface manager, tunnel manager, resource manager
and ID manager and MDSAL Utils. It includes Genius APIs and implementation.
-
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** No
-* **CSIT Tests:**
- * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-nitrogen/
- * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-upstream-all-nitrogen/
+* **CSIT Test:**
+
+ * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-only-neon/
+
+ * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-gate-only-neon/
+
+ Apart from this, the feature is well tested by the netvirt CSIT suites.
odl-genius-rest
---------------
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob;f=features/odl-genius-rest/pom.xml;hb=refs/heads/stable/neon
* **Feature Description:** This feature includes RESTCONF with 'odl-genius'
feature.
-
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** No
-* **CSIT Tests:**
- * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-nitrogen/
- * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-upstream-all-nitrogen/
+* **CSIT Test:**
-odl-genius-api
----------------
+ * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-only-neon/
-* **Feature Description:** This feature includes API for all the functionalities
- provided by Genius.
-
-* **Top Level:** No
-* **User Facing:** No
-* **Experimental:** No
-* **CSIT Tests:**
- * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-nitrogen/
- * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-upstream-all-nitrogen/
+ * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-gate-only-neon/
odl-genius-fcaps-application
----------------------------
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob;f=features/odl-genius-fcaps-application/pom.xml;hb=refs/heads/stable/neon
* **Feature Description:** includes genius FCAPS application.
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** Yes
-* **CSIT Tests:** None
+* **CSIT Test:** None
odl-genius-fcaps-framework
--------------------------
-* **Feature Description:** includes genius FCAPS Framework.
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob;f=features/odl-genius-fcaps-application/pom.xml;hb=refs/heads/stable/neon
+* **Feature Description:** includes genius FCAPS framework.
* **Top Level:** Yes
* **User Facing:** Yes
* **Experimental:** Yes
-* **CSIT Tests:** None
-
-
-New capabilities and enhancements added in Nitrogen
-===================================================
-
-Planned new capability added
-----------------------------
-
-* :doc:`/submodules/genius/docs/specs/service-recovery`
-
-
-Enhancements added to project
------------------------------
-
-#. Migration to Karaf4
-#. Bug fixes
-
+* **CSIT Test:** None
Documentation
=============
* **User Guide(s):**
- * :doc:`User Guide </user-guide/genius-user-guide>`
+ * :doc:`Developer Guide <genius:index>`
* **Developer Guide(s):**
- * :doc:`Developer Guide </submodules/genius/docs/index>`
+ * :doc:`Developer Guide <genius:index>`
Security Considerations
=======================
Quality Assurance
=================
-* `Sonar Report <https://sonar.opendaylight.org/overview?id=64114>`_
+* Link to `Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.genius%3Agenius-aggregator>`_ (84.2%)
+
+* Link to CSIT Jobs
+
+ * `CSIT Job basic <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-only-neon/>`_
-* `CSIT Jobs <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-nitrogen//>`_
+ * `CSIT Job clustering <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-gate-only-neon/>`_
-* `Netvirt CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-netvirt-nitrogen/>`_
+ * `Netvirt CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-netvirt-neon/>`_
-* `Netvirt Cluster CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-cluster-netvirt-nitrogen/>`_
+ * `Netvirt Cluster CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-netvirt-neon/>`_
.. note:: Genius is used extensively in NetVirt, so NetVirt's CSIT also
provides confidence in genius.
* N/A
-* Testing methodology. How extensive was it? What should be expected to work?
- What hasn't been tested as much?
-
- * fcaps_framework and fcaps_application features hasn't been tested much.
-
Migration
---------
* Is it possible to migrate from the previous release? If so, how?
- * No. OpenDaylight doesn't support migration natively for applications that
- use datastore.
+ * Yes, a normal upgrade of the software should work.
Compatibility
-------------
* Is this release compatible with the previous release?
- * Functionality is fully backwards compatible.
+ * Yes
* Any API changes?
- * New API added for `service-recovery </submodules/genius/docs/specs/service-recovery>` feature
+ * No
* Any configuration changes?
* List of bugs fixed since the previous release
- * `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>`_
+ * `Fixed BUGS <https://jira.opendaylight.org/browse/GENIUS-261?jql=project%20%3D%20GENIUS%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20(Resolved%2C%20Verified)%20AND%20fixVersion%20%3D%20Neon>`_
Known Issues
------------
* List key known issues with workarounds
- * None
+ * N/A
-* `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__>`_
+* `Open Bugs <https://jira.opendaylight.org/browse/GENIUS-268?jql=project%20%3D%20GENIUS%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20(Open%2C%20Confirmed)>`_
End-of-life
===========
-* List of features/APIs which are EOLed, deprecated, and/or removed in this
- release
+* List of features/APIs which are EOLed, deprecated, and/or removed in this release
- * N/A
+ *
Standards
=========
Release Mechanics
=================
-* `Release plan <https://wiki.opendaylight.org/view/Genius:Nitrogen_Release_Plan>`_
+* `Release plan <https://docs.opendaylight.org/en/latest/release-process/release-schedule.html>`_
* Describe any major shifts in release schedule from the release plan
- * N/A
+ * No shifts