docs/release-notes/projects/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
  42   * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-oxygen/
  43
  44   * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-upstream-all-oxygen/
  45
  46 odl-genius-rest
  47 ---------------
  48
  49 * **Feature Description:**  This feature includes RESTCONF with 'odl-genius'
  50   feature.
  51
  52 * **Top Level:** Yes
  53 * **User Facing:** Yes
  54 * **Experimental:** No
  55 * **CSIT Tests:**
  56
  57   * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-oxygen/
  58
  59   * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-upstream-all-oxygen/
  60
  61 odl-genius-api
  62 ---------------
  63
  64 * **Feature Description:**  This feature includes API for all the functionalities
  65   provided by Genius.
  66
  67 * **Top Level:** No
  68 * **User Facing:** No
  69 * **Experimental:** No
  70 * **CSIT Tests:**
  71
  72   * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-oxygen/
  73
  74   * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-upstream-all-oxygen/
  75
  76 odl-genius-fcaps-application
  77 ----------------------------
  78
  79 * **Feature Description:**  includes genius FCAPS application.
  80 * **Top Level:** Yes
  81 * **User Facing:** Yes
  82 * **Experimental:** Yes
  83 * **CSIT Tests:** None
  84
  85 odl-genius-fcaps-framework
  86 --------------------------
  87
  88 * **Feature Description:**  includes genius FCAPS Framework.
  89 * **Top Level:** Yes
  90 * **User Facing:** Yes
  91 * **Experimental:** Yes
  92 * **CSIT Tests:** None
  93
  94
  95 New capabilities and enhancements added in Oxygen
  96 =================================================
  97
  98 Planned new capability added
  99 ----------------------------
 100
 101 * :doc:`/submodules/genius/docs/specs/itm-scale-improvements`
 102
 103   .. note:: Some patches are under review, to be merged before Oxygen SR1
 104
 105
 106 Other enhancements added to project
 107 -----------------------------------
 108
 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
 114
 115
 116 Documentation
 117 =============
 118
 119 * **Installation Guide(s):**
 120
 121   * N/A
 122
 123 * **User Guide(s):**
 124
 125   * :doc:`User Guide </user-guide/genius-user-guide>`
 126
 127 * **Developer Guide(s):**
 128
 129   * :doc:`Developer Guide </submodules/genius/docs/index>`
 130
 131 Security Considerations
 132 =======================
 133
 134 * Do you have any external interfaces other than RESTCONF?
 135
 136   * No
 137
 138 * Other security issues?
 139
 140   * N/A
 141
 142 Quality Assurance
 143 =================
 144
 145 * `Sonar Report <https://sonar.opendaylight.org/overview?id=64114>`_
 146
 147 * Link to CSIT Jobs
 148
 149         * `CSIT Job basic <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-upstream-all-oxygen//>`_
 150
 151         * `CSIT Job clustering <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-upstream-all-oxygen//>`_
 152
 153         * `Netvirt CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-netvirt-oxygen/>`_
 154
 155         * `Netvirt Cluster CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-cluster-netvirt-oxygen/>`_
 156
 157   .. note:: Genius is used extensively in NetVirt, so NetVirt's CSIT also
 158             provides confidence in genius.
 159
 160 * Other manual testing and QA information
 161
 162   * N/A
 163
 164 * Testing methodology. How extensive was it? What should be expected to work?
 165   What hasn't been tested as much?
 166
 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>`_
 169
 170   .. note:: fcaps_framework and fcaps_application features hasn't been tested
 171             much.
 172
 173 Migration
 174 ---------
 175
 176 * Is it possible to migrate from the previous release? If so, how?
 177
 178   * No. OpenDaylight doesn't support migration natively for applications that
 179     use datastore.
 180
 181 Compatibility
 182 -------------
 183
 184 * Is this release compatible with the previous release?
 185
 186   * Functionality is fully backwards compatible.
 187
 188 * Any API changes?
 189
 190   * New APIs added for `itm-scale-improvements </submodules/genius/docs/specs/itm-scale-improvements>` feature
 191
 192 * Any configuration changes?
 193
 194   * No
 195
 196 Bugs Fixed
 197 ----------
 198
 199 * List of bugs fixed since the previous release
 200
 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>`_
 202
 203 Known Issues
 204 ------------
 205
 206 * List key known issues with workarounds
 207
 208   * None
 209
 210 * `Open Bugs <https://jira.opendaylight.org/browse/GENIUS>`_
 211
 212 End-of-life
 213 ===========
 214
 215 * List of features/APIs which are EOLed, deprecated, and/or removed in this
 216   release
 217
 218   * N/A
 219
 220 Standards
 221 =========
 222
 223 * List of standards implemented and to what extent
 224
 225   * N/A
 226
 227 Release Mechanics
 228 =================
 229
 230 * `Release plan <https://wiki.opendaylight.org/view/Genius:Oxygen_Release_Plan>`_
 231
 232 * Describe any major shifts in release schedule from the release plan
 233
 234   * N/A