docs/getting-started-guide/project-release-notes/genius.rst

   1 ========================================================
   2 Genius (Generic Network Interface, Utilities & Services)
   3 ========================================================
   4
   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
   8 modules --
   9
  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
  20   genius modules
  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
  24
  25 Major Features
  26 ==============
  27
  28 * **Features URL:** https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob_plain;f=features/genius-features/pom.xml
  29
  30 odl-genius
  31 ----------
  32
  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.
  36
  37 * **Top Level:** Yes
  38 * **User Facing:** Yes
  39 * **Experimental:** No
  40 * **CSIT Tests:**
  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/
  43
  44 odl-genius-rest
  45 ---------------
  46
  47 * **Feature Description:**  This feature includes RESTCONF with 'odl-genius'
  48   feature.
  49
  50 * **Top Level:** Yes
  51 * **User Facing:** Yes
  52 * **Experimental:** No
  53 * **CSIT Tests:**
  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/
  56
  57 odl-genius-api
  58 ---------------
  59
  60 * **Feature Description:**  This feature includes API for all the functionalities
  61   provided by Genius.
  62
  63 * **Top Level:** No
  64 * **User Facing:** No
  65 * **Experimental:** No
  66 * **CSIT Tests:**
  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/
  69
  70 odl-genius-fcaps-application
  71 ----------------------------
  72
  73 * **Feature Description:**  includes genius FCAPS application.
  74 * **Top Level:** Yes
  75 * **User Facing:** Yes
  76 * **Experimental:** Yes
  77 * **CSIT Tests:** None
  78
  79 odl-genius-fcaps-framework
  80 --------------------------
  81
  82 * **Feature Description:**  includes genius FCAPS Framework.
  83 * **Top Level:** Yes
  84 * **User Facing:** Yes
  85 * **Experimental:** Yes
  86 * **CSIT Tests:** None
  87
  88
  89 New capabilities and enhancements added in Nitrogen
  90 ===================================================
  91
  92 Planned new capability added
  93 ----------------------------
  94
  95 * :doc:`/submodules/genius/docs/specs/service-recovery`
  96
  97
  98 Enhancements added to project
  99 -----------------------------
 100
 101 #. Migration to Karaf4
 102 #. Bug fixes
 103
 104
 105 Documentation
 106 =============
 107
 108 * **Installation Guide(s):**
 109
 110   * N/A
 111
 112 * **User Guide(s):**
 113
 114   * :doc:`User Guide </user-guide/genius-user-guide>`
 115
 116 * **Developer Guide(s):**
 117
 118   * :doc:`Developer Guide </submodules/genius/docs/index>`
 119
 120 Security Considerations
 121 =======================
 122
 123 * Do you have any external interfaces other than RESTCONF?
 124
 125   * No
 126
 127 * Other security issues?
 128
 129   * N/A
 130
 131 Quality Assurance
 132 =================
 133
 134 * `Sonar Report <https://sonar.opendaylight.org/overview?id=64114>`_
 135
 136 * `CSIT Jobs <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-nitrogen//>`_
 137
 138 * `Netvirt CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-netvirt-nitrogen/>`_
 139
 140 * `Netvirt Cluster CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-cluster-netvirt-nitrogen/>`_
 141
 142   .. note:: Genius is used extensively in NetVirt, so NetVirt's CSIT also
 143             provides confidence in genius.
 144
 145 * Other manual testing and QA information
 146
 147   * N/A
 148
 149 * Testing methodology. How extensive was it? What should be expected to work?
 150   What hasn't been tested as much?
 151
 152   * fcaps_framework and fcaps_application features hasn't been tested much.
 153
 154 Migration
 155 ---------
 156
 157 * Is it possible to migrate from the previous release? If so, how?
 158
 159   * No. OpenDaylight doesn't support migration natively for applications that
 160     use datastore.
 161
 162 Compatibility
 163 -------------
 164
 165 * Is this release compatible with the previous release?
 166
 167   * Functionality is fully backwards compatible.
 168
 169 * Any API changes?
 170
 171   * New API added for `service-recovery </submodules/genius/docs/specs/service-recovery>` feature
 172
 173 * Any configuration changes?
 174
 175   * No
 176
 177 Bugs Fixed
 178 ----------
 179
 180 * List of bugs fixed since the previous release
 181
 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>`_
 183
 184 Known Issues
 185 ------------
 186
 187 * List key known issues with workarounds
 188
 189   * None
 190
 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__>`_
 192
 193 End-of-life
 194 ===========
 195
 196 * List of features/APIs which are EOLed, deprecated, and/or removed in this
 197   release
 198
 199   * N/A
 200
 201 Standards
 202 =========
 203
 204 * List of standards implemented and to what extent
 205
 206   * N/A
 207
 208 Release Mechanics
 209 =================
 210
 211 * `Release plan <https://wiki.opendaylight.org/view/Genius:Nitrogen_Release_Plan>`_
 212
 213 * Describe any major shifts in release schedule from the release plan
 214
 215   * N/A