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

   1 ============
   2 Openflowjava
   3 ============
   4
   5 Major Features
   6 ==============
   7
   8 odl-openflowjava-protocol
   9 -------------------------
  10
  11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowjava.git;a=blob;f=features/features-openflowjava/src/main/features/features.xml;hb=refs/heads/stable/carbon
  12 * **Feature Description:**  This feature exposes SwitchConnectionProvider for building openflow connections
  13 * **Top Level:** Yes
  14 * **User Facing:** Yes
  15 * **Experimental:** No
  16 * **CSIT Test:**
  17
  18   * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-only-carbon/
  19   * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-frs-only-carbon/
  20   * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-clustering-only-carbon/
  21   * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-bulkomatic-perf-daily-only-carbon/
  22   * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-periodic-bulkomatic-clustering-perf-daily-only-carbon/
  23   * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-gate-scale-stats-collection-daily-only-carbon/
  24   * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-scale-stats-collection-daily-frs-only-carbon/
  25   * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-sw-scalability-daily-only-carbon/
  26   * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-link-scalability-daily-only-carbon/
  27
  28 Documentation
  29 =============
  30
  31 * **User Guide(s):**
  32
  33   * `user guide <https://wiki.opendaylight.org/view/Openflow_Protocol_Library:Startup_Guide>`_
  34
  35 * **Developer Guide(s):**
  36
  37   * :ref:`developer guide <openflow-protocol-library-dev-guide>`
  38
  39 Security Considerations
  40 =======================
  41
  42 * openflowjava listens on given TCP/UDP ports and propagates messages to consumer (by default TCP:6633 and TCP:6653)
  43 * OpenFlow messages can inflict high load on consumer which needs to be handled there
  44
  45 Quality Assurance
  46 =================
  47
  48 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=11724>`_ (85.8% line coverage)
  49 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_ (supplied by openflowplugin)
  50
  51 Migration
  52 ---------
  53
  54 * no additional migration steps needed
  55
  56 Compatibility
  57 -------------
  58
  59 * release is compatible with the previous release
  60 * no API changes
  61 * no configuration changes
  62
  63 Bugs Fixed
  64 ----------
  65
  66 * `List of bugs fixed since the previous release: <https://bugs.opendaylight.org/buglist.cgi?bug_status=RESOLVED&chfield=target_milestone&chfieldto=Now&component=General&f1=cf_target_milestone&f2=cf_target_milestone&f3=cf_target_milestone&f4=cf_target_milestone&f5=cf_target_milestone&j_top=AND_G&list_id=78956&o1=substring&product=openflowjava&query_format=advanced&resolution=FIXED&resolution=INVALID&resolution=WONTFIX&resolution=DUPLICATE&resolution=WORKSFORME&v1=Carbon>`_
  67
  68 Known Issues
  69 ------------
  70
  71 * List key known issues with workarounds
  72 * `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&chfield=target_milestone&chfieldto=Now&component=General&f1=cf_target_milestone&f2=cf_target_milestone&f3=cf_target_milestone&f4=cf_target_milestone&f5=cf_target_milestone&f6=cf_target_milestone&j_top=AND_G&list_id=78961&o1=substring&product=openflowjava&query_format=advanced&resolution=---&v1=Carbon>`_
  73
  74 End-of-life
  75 ===========
  76
  77 * List of features/APIs which are EOLed, deprecated, and/or removed in this
  78   release
  79
  80   none
  81
  82 Standards
  83 =========
  84
  85 * based on `openflow switch specification 1.3.2 <https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-spec-v1.3.2.pdf>`_
  86
  87 Release Mechanics
  88 =================
  89
  90 * `Link to release plan <https://wiki.opendaylight.org/view/Openflow_Protocol_Library:Carbon_Release_Plan>`_