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

   1 ===
   2 NIC
   3 ===
   4
   5 Major Features
   6 ==============
   7
   8 odl-nic-core-mdsal
   9 ------------------
  10
  11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=nic.git;a=blob_plain;f=features/odl-nic-core-mdsal/pom.xml;hb=stable/carbon
  12 * **Feature Description:**  This feature contains the dependencies to use MDSAL
  13   features on NIC
  14 * **Top Level:** Yes
  15 * **User Facing:** Yes
  16 * **Experimental:** Yes
  17 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/
  18
  19 odl-nic-intent-common
  20 ---------------------
  21
  22 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=nic.git;a=blob_plain;f=features/odl-nic-intent-common/pom.xml;hb=stable/carbon
  23 * **Feature Description:**  This feature contains the lifecycle management for
  24   Intents, also is used to join two major features 'intent-statemachine' and
  25   'intent-listeners'. This feature enable NIC to work with different renderers
  26   at the same time.
  27 * **Top Level:** Yes
  28 * **User Facing:** Yes
  29 * **Experimental:** Yes
  30 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/
  31
  32 odl-nic-statemachine
  33 --------------------
  34
  35 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=nic.git;a=blob_plain;f=features/odl-nic-intent-statemachine/pom.xml;hb=stable/carbon
  36 * **Feature Description:**  This feature is used to manage Intent state
  37   transactions and then share those transactions on MD-SAL.
  38 * **Top Level:** Yes
  39 * **User Facing:** Yes
  40 * **Experimental:** Yes
  41 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/
  42
  43 odl-nic-listeners
  44 -----------------
  45
  46 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=nic.git;a=blob_plain;f=features/odl-nic-listeners/pom.xml;hb=stable/carbon
  47 * **Feature Description:**  This feature dependes of 'odl-nic-core-mdsal' to
  48   listen about changes on MDSAL, it works as a listener for Intent and network
  49   events.
  50 * **Top Level:** Yes
  51 * **User Facing:** Yes
  52 * **Experimental:** Yes
  53 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/
  54
  55 odl-nic-renderer-of
  56 -------------------
  57
  58 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=nic.git;a=blob_plain;f=features/odl-nic-renderer-of/pom.xml;hb=stable/carbon
  59 * **Feature Description:**  This feature is responsible to apply network
  60   configurations based in Intents. Once an Intent is created, the
  61   'intent-common' module will extract all information and then, send to
  62   'renderer-of'.
  63 * **Top Level:** Yes
  64 * **User Facing:** Yes
  65 * **Experimental:** Yes
  66 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/
  67
  68
  69 Documentation
  70 =============
  71
  72 * **User Guide(s):**
  73
  74   * :ref:`nic-user-guide`
  75
  76 * **Developer Guide(s):**
  77
  78   * :ref:`nic-dev-guide`
  79
  80 Additional information can be found at the
  81 `NIC wiki page <https://wiki.opendaylight.org/view/Network_Intent_Composition:Main>`_.
  82
  83 Security Considerations
  84 =======================
  85
  86 * Do you have any external interfaces other than RESTCONF?
  87
  88   No
  89
  90 * Other security issues?
  91
  92   N/A
  93
  94 Quality Assurance
  95 =================
  96
  97 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=44164>`_ (48.1% code coverage)
  98 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/>`_
  99 * Other manual testing and QA information
 100 * Testing methodology. How extensive was it? What should be expected to work?
 101   What has not been tested as much?
 102
 103   There are a guide to evaluate manual tests using NIC on our `wiki page
 104   <https://wiki.opendaylight.org/view/Network_Intent_Composition:Main>`_
 105
 106 Migration
 107 ---------
 108
 109 * Is it possible to migrate from the previous release? If so, how?
 110
 111   Migration with user configuration and state is not supported.
 112
 113 Compatibility
 114 -------------
 115
 116 * Is this release compatible with the previous release?
 117
 118   Yes
 119
 120 * Any API changes?
 121
 122   No
 123
 124 * Any configuration changes?
 125
 126   No
 127
 128 Bugs Fixed
 129 ----------
 130
 131 * List of bugs fixed since the previous release
 132
 133 Known Issues
 134 ------------
 135
 136 * List key known issues with workarounds
 137
 138   For Carbon release, NIC contains multiple renderers, but just one renderer can be used at the same time
 139   to use another renderer after start NIC, you have to uninstall NIC and restart ODL.
 140
 141 * `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&list_id=79901&product=nic>`_
 142
 143 End-of-life
 144 ===========
 145
 146 * List of features/APIs which are EOLed, deprecated, and/or removed in this
 147   release
 148
 149 * odl-nic-renderer-nemo
 150 * odl-nic-renderer-vtn
 151 * odl-nic-core-hazelcast
 152
 153 Standards
 154 =========
 155
 156 * List of standards implemented and to what extent
 157
 158   N/A
 159
 160 Release Mechanics
 161 =================
 162
 163 * `Link to release plan <https://wiki.opendaylight.org/view/NIC:Carbon:Release_Plan>`_
 164 * Describe any major shifts in release schedule from the release plan
 165
 166   Increase code coverage and initial implementation of Intent life cycle management.