Add openflowjava release notes 56/57356/5
authorMichal Rehak <mirehak@cisco.com>
Thu, 18 May 2017 13:58:54 +0000 (15:58 +0200)
committerMichal Rehak <michal.rehak@pantheon.tech>
Thu, 18 May 2017 17:34:10 +0000 (19:34 +0200)
    - added links to ofplugin's CSIT
    - formatting
    - removed discouraged feature description

Change-Id: I3ad3859b5fbc14e4ffa00ce4e06c7a530e317ad7
Signed-off-by: Michal Rehak <michal.rehak@pantheon.tech>
docs/getting-started-guide/project-release-notes/openflowjava.rst [new file with mode: 0644]

diff --git a/docs/getting-started-guide/project-release-notes/openflowjava.rst b/docs/getting-started-guide/project-release-notes/openflowjava.rst
new file mode 100644 (file)
index 0000000..7cd6864
--- /dev/null
@@ -0,0 +1,90 @@
+============
+Openflowjava
+============
+
+Major Features
+==============
+
+odl-openflowjava-protocol
+-------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowjava.git;a=blob;f=features/features-openflowjava/src/main/features/features.xml;h=f1b58ba66493ccbfd496cb9d4f072cc8398340c3;hb=refs/heads/stable/carbon
+* **Feature Description:**  This feature exposes SwitchConnectionProvider for building openflow connections
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-flow-services-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-clustering-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-bulkomatic-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-3node-periodic-bulkomatic-clustering-perf-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-gate-scale-stats-collection-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-scale-stats-collection-daily-frs-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-sw-scalability-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/openflowplugin/job/openflowplugin-csit-1node-periodic-link-scalability-daily-only-carbon/
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * `user guide <https://wiki.opendaylight.org/view/Openflow_Protocol_Library:Startup_Guide>`_
+
+* **Developer Guide(s):**
+
+  * `developer guide <https://git.opendaylight.org/gerrit/gitweb?p=docs.git;a=blob;f=docs/developer-guide/openflow-protocol-library-developer-guide.rst;h=37a8fcd85f0a2111ae59a7e2e74d60cd3ce5e110;hb=refs/heads/master>`_
+
+Security Considerations
+=======================
+
+* openflowjava listens on given TCP/UDP ports and propagates messages to consumer (by default TCP:6633 and TCP:6653)
+* OpenFlow messages can inflict high load on consumer which needs to be handled there
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=11724>`_ (85.8% line coverage)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/openflowplugin/>`_ (supplied by openflowplugin)
+
+Migration
+---------
+
+* no additional migration steps needed
+
+Compatiblity
+------------
+
+* release is compatible with the previous release
+* no API changes
+* no configuration changes
+
+Bugs Fixed
+----------
+
+* `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>`_
+
+Known Issues
+------------
+
+* List key known issues with workarounds
+* `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>`_
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this
+  release
+
+  none
+
+Standards
+=========
+
+* 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>`_
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/Openflow_Protocol_Library:Carbon_Release_Plan>`_