Genius Neon Release Details

Change-Id: Id0a023e72f44cdc83cbec13f7758897d31ea5762
Signed-off-by: Faseela K <faseela.k@ericsson.com>

diff --git a/docs/release-notes/projects/genius.rst b/docs/release-notes/projects/genius.rst
new file mode 100644 (file)
index 0000000..d4524b1
--- /dev/null
+++ b/docs/release-notes/projects/genius.rst
@@ -0,0 +1,203 @@
+======
+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 Neon Genius provides following
+modules --
+
+* **Interface (logical port) Manager** allows bindings/registration of
+  multiple services to logical ports/interfaces
+* **Overlay Tunnel Manager** creates and maintains overlay tunnels between
+  configured tunnel endpoints
+* **Aliveness Monitor** provides tunnel/nexthop aliveness monitoring services
+* **ID Manager** generates cluster-wide persistent unique integer IDs
+* **MD-SAL Utils** provides common generic APIs for interaction with MD-SAL
+* **Resource Manager** provides a resource sharing framework for applications
+  sharing common resources e.g. table-ids, group-ids etc.
+* **FCAPS Application**  generates various alarms and counters for the different
+  genius modules
+* **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
+
+Major Features
+==============
+
+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 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 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-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 Test:** None
+
+odl-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 Test:** None
+
+Documentation
+=============
+
+* **Installation Guide(s):**
+
+  * N/A
+
+* **User Guide(s):**
+
+  * :doc:`Developer Guide <genius:index>`
+
+* **Developer Guide(s):**
+
+  * :doc:`Developer Guide <genius:index>`
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  * No
+
+* Other security issues?
+
+  * N/A
+
+Quality Assurance
+=================
+
+* 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 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-neon/>`_
+
+  * `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.
+
+* Other manual testing and QA information
+
+  * N/A
+
+Migration
+---------
+
+* Is it possible to migrate from the previous release? If so, how?
+
+  * Yes, a normal upgrade of the software should work.
+
+Compatibility
+-------------
+
+* Is this release compatible with the previous release?
+
+  * Yes
+
+* Any API changes?
+
+  * No
+
+* Any configuration changes?
+
+  * No
+
+Bugs Fixed
+----------
+
+* List of bugs fixed since the previous release
+
+  * `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
+
+  * N/A
+
+* `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
+
+  *
+
+Standards
+=========
+
+* List of standards implemented and to what extent
+
+  * N/A
+
+Release Mechanics
+=================
+
+* `Release plan <https://docs.opendaylight.org/en/latest/release-process/release-schedule.html>`_
+
+* Describe any major shifts in release schedule from the release plan
+
+  * No shifts