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

   1 ==============
   2 NetIDE Project
   3 ==============
   4
   5 Major Features
   6 ==============
   7
   8 odl-netide-api
   9 --------------
  10
  11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netide.git;a=blob;f=features/features-netide/src/main/features/features.xml
  12 * **Feature Description:**  This feature provides the YANG models for
  13   NetIDE interoperability layer for SDN Applications written for other
  14   SDN Controllers to run on OpenDaylight managed infrastructure.
  15 * **Top Level:** Yes
  16 * **User Facing:** Yes
  17 * **Experimental:** Yes
  18 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-all-carbon/
  19   https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-only-carbon/
  20
  21 odl-netide-impl
  22 ---------------
  23
  24 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netide.git;a=blob;f=features/features-netide/src/main/features/features.xml
  25 * **Feature Description:**  This feature is the main feature of NetIDE. This
  26   plugin provides the implementation to transfer Openflow commands from other
  27   SDN controllers to the switches.
  28 * **Top Level:** Yes
  29 * **User Facing:** No
  30 * **Experimental:** Yes
  31 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-all-carbon/
  32   https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-only-carbon/
  33
  34 odl-netide-rest
  35 ---------------
  36
  37 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netide.git;a=blob;f=features/features-netide/src/main/features/features.xml
  38 * **Feature Description:**  This feature is the wrapper feature that installs
  39   the odl-netide-api & odl-netide-impl feature with other required features for
  40   restconf access to provide a functional Openflow commands to the switches.
  41 * **Top Level:** Yes
  42 * **User Facing:** Yes
  43 * **Experimental:** Yes
  44 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-all-carbon/
  45   https://jenkins.opendaylight.org/releng/view/netide/job/netide-csit-1node-basic-only-carbon/
  46
  47 Documentation
  48 =============
  49
  50 * **User Guide(s):**
  51
  52   * :ref:`netide-user-guide`
  53
  54 * **Developer Guide(s):**
  55
  56   * :ref:`netide-dev-guide`
  57
  58 Security Considerations
  59 =======================
  60
  61 * Do you have any external interfaces other than RESTCONF? No
  62 * Other security issues? none
  63
  64 Quality Assurance
  65 =================
  66
  67 * `Link to Sonar Report <https://sonar.opendaylight.org/overview/coverage?id=org.opendaylight.netide%3Anetide-aggregator>`_ (74.4)
  68 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/netide/>`_
  69 * NetIDE was tested through Unit Tests, IT test and system tests. A manual
  70   testing plan was also completed. See `Carbon Test Plan <https://wiki.opendaylight.org/view/NetIDE:Carbon:System_Test>`_
  71
  72 Migration
  73 ---------
  74
  75 * Is it possible to migrate from the previous release? If so, how?
  76
  77   Yes. No state data kept in datastore. User facing features and interfaces have not changed between releases, only
  78   enhancements/bugfixes were added.
  79
  80 Compatibility
  81 -------------
  82
  83 * Is this release compatible with the previous release? Yes
  84 * Any API changes? No changes in the yang models from previous release. Only enhancements completed.
  85 * Any configuration changes? No
  86
  87 Bugs Fixed
  88 ----------
  89
  90 * List of bugs fixed since the previous release: None
  91
  92 Known Issues
  93 ------------
  94
  95 * List key known issues with workarounds: None
  96
  97
  98 End-of-life
  99 ===========
 100
 101 * List of features/APIs which are EOLed, deprecated, and/or removed in this release: None
 102
 103 Standards
 104 =========
 105
 106 Openflow versions:
 107
 108 * `OpenFlow1.3.2 <https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-spec-v1.3.2.pdf>`_
 109 * `OpenFlow1.0.0 <https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-spec-v1.0.0.pdf>`_
 110
 111
 112 Release Mechanics
 113 =================
 114
 115 * `Link to release plan <https://wiki.opendaylight.org/view/NetIDE:Carbon_Release_Plan>`_
 116 * Describe any major shifts in release schedule from the release plan: None