Merge "ODL-SDNi carbon release notes"
authorColin Dixon <colin@colindixon.com>
Thu, 8 Jun 2017 13:28:54 +0000 (13:28 +0000)
committerGerrit Code Review <gerrit@opendaylight.org>
Thu, 8 Jun 2017 13:28:54 +0000 (13:28 +0000)
26 files changed:
docs/developer-guide/distribution-version.rst
docs/developer-guide/infrautils-developer-guide.rst
docs/developer-guide/l2switch-developer-guide.rst
docs/developer-guide/lacp-developer-guide.rst
docs/developer-guide/network-intent-composition-(nic)-developer-guide.rst
docs/developer-guide/of-config-developer-guide.rst
docs/developer-guide/uni-manager-plug-in-developer-guide.rst
docs/getting-started-guide/common-features/clustering.rst
docs/getting-started-guide/project-release-notes/distribution.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/genius.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/infrautils.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/l2switch.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/lacp.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/nic.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/of-config-release-notes.rst [new file with mode: 0644]
docs/getting-started-guide/project-release-notes/unimgr.rst [new file with mode: 0644]
docs/getting-started-guide/security_considerations.rst
docs/submodules/integration/test
docs/submodules/netvirt
docs/submodules/odlparent
docs/submodules/releng/builder
docs/user-guide/l2switch-user-guide.rst
docs/user-guide/link-aggregation-control-protocol-user-guide.rst
docs/user-guide/network-intent-composition-(nic)-user-guide.rst
docs/user-guide/of-config-user-guide.rst
docs/user-guide/uni-manager-plug-in-project.rst

index 091843bab94192016002bfe8a5a41b52b68901a7..4512f5d0fba1ce43f3bf27ece947ff332b37a38c 100644 (file)
@@ -1,3 +1,5 @@
+.. _dist-version:
+
 Distribution Version reporting
 ==============================
 
index 731aeeda4e5cdf57237cf83042c5f6a878d6c532..0f8a01192f0bbb14a45fdece8ff61750829df248 100644 (file)
@@ -1,3 +1,5 @@
+.. _infrautils-dev-guide:
+
 Infrautils
 ==========
 
index 95a38076276dd06a75a26e207d785caacf82ab3a..96d7789d80c3597a10a276e9a17c0796b62634d6 100644 (file)
@@ -1,3 +1,5 @@
+.. _l2switch-dev-guide:
+
 L2Switch Developer Guide
 ========================
 
index 52a182d9245a7205fa01a2ed23adf848cbce965a..a56c75ea0d3dc9abbe09cfb6ccba5adfe3589bfc 100644 (file)
@@ -1,3 +1,5 @@
+.. _lacp-dev-guide:
+
 LACP Developer Guide
 ====================
 
index aaafd4792c516ce2a600468da5e29904de3055da..bd1315a03ff4204007474e51a26f9c3448861e15 100644 (file)
@@ -1,3 +1,5 @@
+.. _nic-dev-guide:
+
 Network Intent Composition (NIC) Developer Guide
 ================================================
 
index d8709abef3242329393558fa1117cb08fddefc92..ff9c20ccf136d18819daa6fc6c93877f121660ee 100644 (file)
@@ -1,3 +1,5 @@
+.. _ofconfig-dev-guide:
+
 OF-CONFIG Developer Guide
 =========================
 
index 663b9b436174b556f78c22737cf68bc0dde66391..3c296973d4cac088bd7b717b8d381e4009c008d4 100644 (file)
@@ -1,3 +1,5 @@
+.. _unimgr-dev-guide:
+
 User Network Interface Manager Plug-in (Unimgr) Developer Guide
 ===============================================================
 
index e8df611d9dd78f804d00049f4e16f7547bd53190..39f734c39a25d8bba46e72aaa0cef6e87e49dc45 100644 (file)
@@ -85,6 +85,8 @@ To implement clustering, the deployment considerations are as follows:
   that it can rejoin the cluster. Once a restarted node joins a cluster, it
   will synchronize with the lead node automatically.
 
+.. _getting-started-clustering-scripts:
+
 Clustering Scripts
 ------------------
 
diff --git a/docs/getting-started-guide/project-release-notes/distribution.rst b/docs/getting-started-guide/project-release-notes/distribution.rst
new file mode 100644 (file)
index 0000000..ad4ff96
--- /dev/null
@@ -0,0 +1,147 @@
+========================
+Integration/Distribution
+========================
+
+Major Features
+==============
+
+odl-integration-all
+-------------------
+
+* **Gitweb URL:** https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=features3-test/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Description:** An aggregate feature grouping all user-facing ODL features
+  which can be installed together without Karaf becoming unusable or without port conflicts.
+* **Top Level:** Yes
+* **User Facing:** No (CSIT purposes only)
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/distribution/job/distribution-deploy-carbon
+
+odl-integration-compatible-with-all
+-----------------------------------
+
+* **Gitweb URL:** https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=features3-test/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Description:** An aggregate feature grouping all user-facing ODL features
+  which are not pro-active and which (as a group) should be compatible with most other ODL features.
+* **Top Level:** Yes
+* **User Facing:** No (CSIT purposes only)
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/distribution/job/distribution-csit-1node-userfeatures-all-carbon
+
+odl-distribution-version
+------------------------
+
+* **Gitweb URL:** https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=features3-distribution/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Description:** Allows NETCONF/RESTCONF users to determine the version of ODL they are communicating with.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/distribution/job/distribution-csit-1node-userfeatures-only-carbon
+
+Karaf 3 distribution archive
+----------------------------
+* **Gitweb URL:** https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=distribution-karaf/pom.xml;hb=refs/heads/stable/carbon
+* **Description:** Zip or tar.gz; when extracted, a self-consistent ODL installation is created.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/distribution/job/distribution-offline-carbon
+
+Karaf 4 distribution archive
+----------------------------
+* **Gitweb URL:** https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=karaf/pom.xml;hb=refs/heads/stable/carbon
+* **Description:** Zip or tar.gz; when extracted, a self-consistent ODL installation is created.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** Removed to save resources.
+
+Documentation
+=============
+
+* **User Guide:**
+
+  * :ref:`Clustering scripts <getting-started-clustering-scripts>`
+
+* **Developer Guide:**
+
+  * :ref:`dist-version`
+
+Security Considerations
+=======================
+
+* Karaf 3 exposes ssh console on port 8101.
+  The security basically basically the same as in upstream Karaf of corresponding versions,
+  except library version overrides implemented in odlparent:karaf-parent.
+
+  See :ref:`securing-karaf`
+
+Quality Assurance
+=================
+
+* `Sonar Report <https://sonar.opendaylight.org/overview?id=61911>`_ (0%)
+
+  * Only 42 lines of java `code <https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=tree;f=version/src/main/java/org/opendaylight/yang/gen/v1/urn/opendaylight/params/xml/ns/yang/integration/distribution/version/rev160316;hb=refs/heads/stable/carbon>`_.
+
+* `Test report page <https://wiki.opendaylight.org/view/Integration/Distribution/Carbon_Test_Report>`_
+* No additional manual testing.
+
+Migration
+---------
+
+* Version feature works exactly the same as in Boron.
+  After migration the versions are set to the new default, configurable in runtime or via configfile.
+  The Boron configfile would work, but users are advised to consider reporting a bumped version.
+* No upgrade path for other features.
+
+Compatiblity
+------------
+
+* No API changes in Karaf 3.
+* Karaf features are not compatible with Boron.
+
+  * even odl-distribution-version depends on different version of Config Subsystem.
+
+Bugs Fixed
+----------
+
+* `Bug 4296 <https://bugs.opendaylight.org/show_bug.cgi?id=4296>`_:
+  At the time of Boron release, the default versions were not being set properly. Now they are.
+* `Bug 7255 <https://bugs.opendaylight.org/show_bug.cgi?id=7255>`_:
+  During Carbon deveopment -all- jobs for NETCONF started to fail.
+  Turns out NETCONF provides two NETCONF topology managers (single node or cluster)
+  which are incompatible with each other.
+  Fixed by moving both out of odl-integration-compatible-with-all.
+* `Bug 7493 <https://bugs.opendaylight.org/show_bug.cgi?id=7493>`_:
+  Controller briefly used Artery, but distribution scripts were not compatible with that.
+  After all, Artery is not used in Carbon release,
+  but the scripts now contain information how to make them compatible if needed.
+* `Bug 4219 <https://bugs.opendaylight.org/show_bug.cgi?id=4219>`_:
+  Karaf 4 features and archives are available, but in experimental state only.
+  NETCONF server and NETCONF connectors do not work. RESTCONF works only up to attempted re-install.
+
+
+Known Issues
+------------
+
+* No known issues for Karaf 3.
+* Karaf 4 is highly experimental.
+
+End-of-life
+===========
+
+No features/APIs which are EOLed, deprecated, and/or removed in this release.
+
+Standards
+=========
+
+No standard implemented directly (see upstream projects).
+
+Release Mechanics
+=================
+
+* `Release plan <https://wiki.opendaylight.org/view/Integration/Distribution/Carbon_Release_Plan>`_
+* Major shifts in release schedule
+
+  * Karaf 4 was running late due to difficulty of making CSIT work.
+    Eventually Karaf 4 was moved to experimental status.
+  * Team Lead was often busy, neglecting status updates.
diff --git a/docs/getting-started-guide/project-release-notes/genius.rst b/docs/getting-started-guide/project-release-notes/genius.rst
new file mode 100644 (file)
index 0000000..a6edbb3
--- /dev/null
@@ -0,0 +1,192 @@
+========================================================
+Genius (Generic Network Interface, Utilities & Services)
+========================================================
+
+Genius project provides Generic Network Interfaces, Utilities & Services. Any ODL application can use these to achieve interference-free co-existence with other applications using Genius. OpendayLight Carbon Genius provides following modules --
+
+* **Interface (logical port) Manager** allows bindings/registration of multiple services to logical ports/interfaces
+* **Overlay Tunnel Manager** creates and maintains overlay tunnels between configured tunnel endpoints
+* **Aliveness Monitor** provides tunnel/nexthop aliveness monitoring services
+* **ID Manager** generates cluster-wide persistent unique integer IDs
+* **MD-SAL Utils** provides common generic APIs for interaction with MD-SAL
+* **Resource Manager** provides a resource sharing framework for applications sharing common resources e.g. table-ids, group-ids etc.
+* **FCAPS Application**  generates various alarms and counters for the different genius modules
+* **FCAPS Framework**  module collectively fetches all data generated by fcaps application. Any underlying infrastructure can subscribe for its events to have a generic overview of the various alarms and counters
+
+Major Features
+==============
+
+* **Features URL:** https://git.opendaylight.org/gerrit/gitweb?p=genius.git;a=blob;f=features/genius-features/src/main/features/features.xml
+
+odl-genius-rest
+---------------
+
+* **Feature Description:**  Provides all functionalities provided by genius modules, including interface manager, tunnel manager, resource manager and ID manager and MDSAL Utils.
+
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Tests:**
+
+  * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-genius-all-carbon/
+  * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-3node-genius-all-carbon/
+
+
+odl-genius-fcaps-application
+----------------------------
+
+* **Feature Description:**  includes genius FCAPS application.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Tests:** None
+
+odl-genius-fcaps-framework
+--------------------------
+
+* **Feature Description:**  includes genius FCAPS Framework.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Tests:** None
+
+
+New capabilities and enhancements added in Carbon
+=================================================
+
+Planned new capabilities added
+------------------------------
+
+* :doc:`/submodules/genius/docs/specs/of-tunnels`
+* :doc:`/submodules/genius/docs/specs/itm-tunnel-auto-config`
+* :doc:`/submodules/genius/docs/specs/service-binding-on-tunnels`
+
+
+Unplanned new capabilities added (needed by Netvirt Project)
+------------------------------------------------------------
+
+* :doc:`/submodules/genius/docs/specs/multiple-vxlan-tunnels`
+
+Enhancements added to existing features/services
+------------------------------------------------
+
+* Interface manager : Increase max services bind on an interface to 16
+* ITM to support same TEP in multiple Transport Zones
+* Various performance and scale improvements
+
+Enhancements added to project
+-----------------------------
+
+#. Migration to Blueprint
+#. Checkstyle enforcement
+#. IT framework enhancements
+#. Junits and CSIT enhancements
+
+Documentation
+=============
+
+* **Installation Guide(s):**
+
+  * N/A
+
+* **User Guide(s):**
+
+  * :doc:`User Guide </user-guide/genius-user-guide>`
+
+* **Developer Guide(s):**
+
+  * :doc:`Developer Guide </submodules/genius/docs/index>`
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  * No
+
+* Other security issues?
+
+  * N/A
+
+Quality Assurance
+=================
+
+* `Sonar Report <https://sonar.opendaylight.org/overview?id=64114>`_ (40.7%)
+
+* `CSIT Jobs <https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-genius-all-carbon//>`_
+
+* `Netvirt CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-netvirt-carbon/>`_
+
+* `Netvirt Cluster CSIT for Genius patches <https://jenkins.opendaylight.org/releng/job/genius-patch-test-cluster-netvirt-carbon/>`_
+
+  .. note:: Genius is used extensively in NetVirt, so NetVirt's CSIT also
+            provides confidence in genius.
+
+* Other manual testing and QA information
+
+  * N/A
+
+* Testing methodology. How extensive was it? What should be expected to work? What hasn't been tested as much?
+
+  * fcaps_framework and fcaps_application features hasn't been tested much.
+
+Migration
+---------
+
+* Is is possible migrate from the previous release? If so, how?
+
+  * No. OpenDaylight doesn't support migration natively for applications that use datastore.
+
+Compatibility
+-------------
+
+* Is this release compatible with the previous release?
+
+  * Functionality is fully backwards compatible.
+
+* Any API changes?
+
+  * No
+
+* Any configuration changes?
+
+  * No
+
+Bugs Fixed
+----------
+
+* List of bugs fixed since the previous release
+
+  * `Fixed BUGS <https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2016-08-9&chfieldto=2017-05-25&list_id=78466&product=genius&query_format=advanced&resolution=FIXED>`_
+
+Known Issues
+------------
+
+* List key known issues with workarounds
+
+  * None
+
+* `Open Bugs <https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2016-08-9&chfieldto=2017-05-25&list_id=78466&product=genius&query_format=advanced&bug_status=__open__>`_
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this release
+
+  * `MDSalUtil Async*ListenerBase classes deprecated <https://git.opendaylight.org/gerrit/#/c/51913/>`_
+
+Standards
+=========
+
+* List of standards implemented and to what extent
+
+  * N/A
+
+Release Mechanics
+=================
+
+* `Release plan <https://wiki.opendaylight.org/view/Genius:Carbon_Release_Plan>`_
+
+* Describe any major shifts in release schedule from the release plan
+
+  * N/A
diff --git a/docs/getting-started-guide/project-release-notes/infrautils.rst b/docs/getting-started-guide/project-release-notes/infrautils.rst
new file mode 100644 (file)
index 0000000..d656d7c
--- /dev/null
@@ -0,0 +1,81 @@
+==========
+Infrautils
+==========
+
+Major Features
+==============
+
+odl-infrautils-all
+------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/infrautils-features/src/main/features/features.xml;hb=stable/carbon
+* **Feature Description:**  This feature exposes all infrautils framework features
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** none
+
+.. note that this is experimental until the system test waiver is granted
+.. on this thread:
+.. https://lists.opendaylight.org/pipermail/infrautils-dev/2017-May/000322.html
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * Infrautils provides low-level technical framework utilities and therefore has no user guide
+
+* **Developer Guide(s):**
+
+  * :ref:`infrautils-dev-guide`
+
+Security Considerations
+=======================
+
+* No external interfaces
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=66717>`_ (82.8% line coverage)
+* Project infrautils provides low-level technical framework utilities
+  and therefore no CSIT automated system testing is available
+
+Migration
+---------
+
+* No additional migration steps needed
+
+Compatibility
+-------------
+
+* This release is compatible with previous release
+* Async API was removed (dead code, not used by any odl projects)
+* No configuration changes made
+
+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=infrautils&query_format=advanced&resolution=FIXED&resolution=INVALID&resolution=WONTFIX&resolution=DUPLICATE&resolution=WORKSFORME&v1=Carbon>`_
+
+
+Known Issues
+------------
+
+* There are no currently known issues
+
+End-of-life
+===========
+
+* This section is N/A
+
+Standards
+=========
+
+* This section is N/A
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/Infrastructure_Utilities:Carbon_Release_Plan>`_
diff --git a/docs/getting-started-guide/project-release-notes/l2switch.rst b/docs/getting-started-guide/project-release-notes/l2switch.rst
new file mode 100644 (file)
index 0000000..0ac9629
--- /dev/null
@@ -0,0 +1,97 @@
+========
+L2Switch
+========
+
+odl-l2switch-switch
+-------------------
+
+* **Feature URL:** https://github.com/opendaylight/l2switch/blob/stable/carbon/features/features-l2switch/src/main/features/features.xml
+* **Feature Description:** Provides a basic L2 Switch abstraction over multiple switches using OpenFlow
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** No
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-csit-1node-switch-all-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-integration-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-merge-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-sonar/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-validate-autorelease-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-clm-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-csit-1node-periodic-host-scalability-daily-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-csit-1node-scalability-all-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-csit-1node-scalability-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-csit-1node-switch-all-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-csit-1node-switch-only-carbon/
+  * https://jenkins.opendaylight.org/releng/view/l2switch/job/l2switch-distribution-check-carbon/
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :ref:`l2switch-user-guide`
+
+* **Developer Guide(s):**
+
+  * :ref:`l2switch-dev-guide`
+
+Security Considerations
+=======================
+
+* Are there any known security issues?
+
+  None.
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=50636>`_ (22.0% code coverage)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/l2switch/>`_
+* The tests are using the OpenDaylight CSIT infrastructure.
+
+  * How extensive was it? Extensive, covers functionality, scalability tests.
+  * What should be expected to work? The core modules like Address tracker, Packet handler,
+    Host tracker, loop removal, simple mininet ping.
+  * What has not be tested as much? Basic scalablity tests exists today, extensive scalability
+    could be performed.
+
+Migration
+---------
+
+Migration with data from Boron to Carbon is not supported.
+
+Compatibility
+-------------
+
+This release is compatible with the previous release.
+
+Since l2switch is migrating services to Blueprint, services depending on l2switch
+may also need to migrate to Blueprint instead of using CONFIG subsystem.
+
+Bugs Fixed
+----------
+
+No bug is fixed in this release.
+
+Known Issues
+------------
+
+* `Bug 6654 <https://bugs.opendaylight.org/show_bug.cgi?id=6654>`_
+
+l2switch does not work well when mininet is stopped/started with no delay.
+
+End-of-life
+===========
+No Changes
+
+Standards
+=========
+
+None.
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/L2_Switch:Carbon_Release_Plan>`_
+*  No major changes.
diff --git a/docs/getting-started-guide/project-release-notes/lacp.rst b/docs/getting-started-guide/project-release-notes/lacp.rst
new file mode 100644 (file)
index 0000000..2f287c0
--- /dev/null
@@ -0,0 +1,75 @@
+====
+LACP
+====
+
+Major Features
+==============
+
+odl-lacp-plugin
+---------------
+
+* **Feature URL:** https://github.com/opendaylight/lacp/blob/stable/carbon/features/src/main/features/features.xml
+* **Feature Description:** Southbound plugin for adding Link Aggregation Control Protocol support (via OpenFlow)
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:**
+
+  * https://jenkins.opendaylight.org/releng/view/lacp/job/lacp-csit-1node-lacp-all-carbon/
+  * https://jenkins.opendaylight.org/releng/view/lacp/job/lacp-integration-carbon/
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :ref:`lacp-user-guide`
+
+* **Developer Guide(s):**
+
+  * :ref:`lacp-dev-guide`
+
+Security Considerations
+=======================
+
+No known issues
+
+Quality Assurance
+=================
+
+* `Sonar report <https://sonar.opendaylight.org/overview?id=43929>`_ (76.8% code coverage)
+
+Migration
+---------
+
+It is not currently supported
+
+Compatibility
+-------------
+
+Yes, It is compatible with previous release. There are no API or config changes.
+
+Bugs Fixed
+----------
+
+No bugs fixed
+
+Known Issues
+------------
+
+No known issues
+
+End-of-life
+===========
+
+No deprecated or EoLed features.
+
+Standards
+=========
+
+`IEEE 802.11ad-2012 <http://www.techstreet.com/ieee/standards/ieee-802-11ad-2012?product_id=1820568>`_
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/Simultaneous_Release:Carbon_Release_Plan>`_
diff --git a/docs/getting-started-guide/project-release-notes/nic.rst b/docs/getting-started-guide/project-release-notes/nic.rst
new file mode 100644 (file)
index 0000000..7bc42e3
--- /dev/null
@@ -0,0 +1,166 @@
+===
+NIC
+===
+
+Major Features
+==============
+
+odl-nic-core-mdsal
+------------------
+
+* **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
+* **Feature Description:**  This feature contains the dependencies to use MDSAL
+  features on NIC
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/
+
+odl-nic-intent-common
+---------------------
+
+* **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
+* **Feature Description:**  This feature contains the lifecycle management for
+  Intents, also is used to join two major features 'intent-statemachine' and
+  'intent-listeners'. This feature enable NIC to work with different renderers
+  at the same time.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/
+
+odl-nic-statemachine
+--------------------
+
+* **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
+* **Feature Description:**  This feature is used to manage Intent state
+  transactions and then share those transactions on MD-SAL.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/
+
+odl-nic-listeners
+-----------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=nic.git;a=blob_plain;f=features/odl-nic-listeners/pom.xml;hb=stable/carbon
+* **Feature Description:**  This feature dependes of 'odl-nic-core-mdsal' to
+  listen about changes on MDSAL, it works as a listener for Intent and network
+  events.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/
+
+odl-nic-renderer-of
+-------------------
+
+* **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
+* **Feature Description:**  This feature is responsible to apply network
+  configurations based in Intents. Once an Intent is created, the
+  'intent-common' module will extract all information and then, send to
+  'renderer-of'.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/
+
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :ref:`nic-user-guide`
+
+* **Developer Guide(s):**
+
+  * :ref:`nic-dev-guide`
+
+Additional information can be found at the
+`NIC wiki page <https://wiki.opendaylight.org/view/Network_Intent_Composition:Main>`_.
+  
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  No
+
+* Other security issues?
+
+  N/A
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=44164>`_ (48.1% code coverage)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-carbon/>`_
+* Other manual testing and QA information
+* Testing methodology. How extensive was it? What should be expected to work?
+  What has not been tested as much?
+
+  There are a guide to evaluate manual tests using NIC on our `wiki page
+  <https://wiki.opendaylight.org/view/Network_Intent_Composition:Main>`_
+
+Migration
+---------
+
+* Is is possible migrate from the previous release? If so, how?
+
+  Migration with user configuration and state is not supported.
+
+Compatibility
+-------------
+
+* Is this release compatible with the previous release?
+
+  Yes
+
+* Any API changes?
+
+  No
+
+* Any configuration changes?
+
+  No
+
+Bugs Fixed
+----------
+
+* List of bugs fixed since the previous release
+
+Known Issues
+------------
+
+* List key known issues with workarounds
+
+  For Carbon release, NIC contains multiple renderers, but just one renderer can be used at the same time
+  to use another renderer after start NIC, you have to uninstall NIC and restart ODL.
+
+* `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&list_id=79901&product=nic>`_
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this
+  release
+
+* odl-nic-renderer-nemo
+* odl-nic-renderer-vtn
+* odl-nic-core-hazelcast
+
+Standards
+=========
+
+* List of standards implemented and to what extent
+
+  N/A
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/NIC:Carbon:Release_Plan>`_
+* Describe any major shifts in release schedule from the release plan
+
+  Increase code coverage and initial implementation of Intent life cycle management.
diff --git a/docs/getting-started-guide/project-release-notes/of-config-release-notes.rst b/docs/getting-started-guide/project-release-notes/of-config-release-notes.rst
new file mode 100644 (file)
index 0000000..ae373fe
--- /dev/null
@@ -0,0 +1,99 @@
+=========
+OF-CONFIG
+=========
+
+Major Features
+==============
+
+odl-of-config-all
+-----------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=of-config.git;a=blob;f=features/features-of-config/src/main/features/features.xml;hb=stable/carbon
+* **Feature Description:**  This is a top level wrapper feature which includes all the sub features OF-CONFIG offers.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+* **CSIT Test:** N/A
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :ref:`ofconfig-user-guide`
+
+* **Developer Guide(s):**
+
+  * :ref:`ofconfig-dev-guide`
+
+Security Considerations
+=======================
+
+* Do you have any external interfaces other than RESTCONF?
+
+  * No. This project indirectly uses the NETCONF project to connect to devices.
+
+* Other security issues?
+
+  * N/A
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=org.opendaylight.of-config%3Aofconf>`_ (71.4% code coverage)
+* Other manual testing and QA information
+* Testing methodology. How extensive was it? What should be expected to work?
+  What has not been tested as much?
+* External System Test is almost done manually, since the sandbox environment
+  could not satisfy OF-CONFIG's requirement. The test has covered all external
+  APIs of OF-CONFIG and all supplementary options based on OF-CONFIG 1.2.
+
+Migration
+---------
+
+* Is is possible migrate from the previous release? If so, how?
+
+  There is no additional support for migration in OF-CONFIG than there is in
+  general. User configuration and state will need to be manually migrated when
+  upgrading between major versions of OpenDaylight.
+
+Compatibility
+-------------
+
+* Is this release compatible with the previous release? Yes.
+* Any API changes? No.
+* Any configuration changes? No.
+
+Bugs Fixed
+----------
+
+* List of bugs fixed since the previous release
+
+  `Replace mockito-all by mockito-core <https://git.opendaylight.org/gerrit/#/c/50878/>`_
+
+Known Issues
+------------
+
+* No known issues.
+
+End-of-life
+===========
+
+* List of features/APIs which are EOLed, deprecated, and/or removed in this
+  release
+
+  N/A
+
+Standards
+=========
+
+* List of standrads implemented and to what extent
+* `OF-CONFIG 1.2 <https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow-config/of-config-1.2.pdf>`_
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/OF-CONFIG:Carbon:Release_Plan>`_
+* Describe any major shifts in release schedule from the release plan
+
+  N/A
diff --git a/docs/getting-started-guide/project-release-notes/unimgr.rst b/docs/getting-started-guide/project-release-notes/unimgr.rst
new file mode 100644 (file)
index 0000000..06cac86
--- /dev/null
@@ -0,0 +1,90 @@
+======
+Unimgr
+======
+
+Major Features
+==============
+
+odl-unimgr-netvirt
+------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=unimgr.git;a=blob;f=features/features-unimgr/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature Description:**  MEF Legato implementation using netvirt.
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+
+odl-unimgr-cisco-xr-driver
+--------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=unimgr.git;a=blob;f=features/features-unimgr/src/main/features/features.xml;hb=refs/heads/stable/carbon
+* **Feature Description:**  MEF presto implementation with cisco xr
+* **Top Level:** Yes
+* **User Facing:** Yes
+* **Experimental:** Yes
+
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :ref:`unimgr-user-guide`
+
+* **Developer Guide(s):**
+
+  * :ref:`unimgr-dev-guide`
+
+Security Considerations
+=======================
+
+No known security issues
+
+Quality Assurance
+=================
+
+* `Link to Sonar Report <https://sonar.opendaylight.org/overview/coverage?id=org.opendaylight.unimgr%3Aunimgr-aggregator>`_ (49.4% code coverage)
+* `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/unimgr/job/unimgr-csit-1node-basic-only-carbon/>`_
+* Tested Manually all main features.
+
+  I installed the feature, connect to the dlux ui, configured some services, and run traffic between the ports configured in the services.
+
+Migration
+---------
+
+* Is is possible migrate from the previous release?
+  No, Current release is backward incompatible.
+
+Compatibility
+-------------
+
+* Is this release compatible with the previous release?
+* Any API changes?
+* Any configuration changes?
+
+No, all API's are new or have not been modified.
+
+Bugs Fixed
+----------
+
+* Only Bugs related to current release have been fixed
+
+Known Issues
+------------
+
+* No known issues
+
+End-of-life
+===========
+
+none
+
+Standards
+=========
+
+* `MEF PRESTO API <https://wiki.mef.net/display/CESG/LSO+Presto>`_
+* `MEF LEGATO API <https://wiki.mef.net/display/CESG/LSO+Legato>`_
+
+Release Mechanics
+=================
+
+* `Link to release plan <https://wiki.opendaylight.org/view/Unimgr:Release_Plan_Carbon>`_
index 70ac5ac7f4f2250ff3583ce6bb111168bd59483c..4457d6c46e53213a485c37c107a59392d5c0d38c 100644 (file)
@@ -133,6 +133,8 @@ security model to add the following features:
 
 For more information, refer to http://www.osgi.org/Main/HomePage.
 
+.. _securing-karaf:
+
 Securing the Karaf container
 ============================
 
index 53529a3b27333cdcbce597983f74c07510f4ada5..97b82df2a8571d0d125232058c798fe340bb07c9 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 53529a3b27333cdcbce597983f74c07510f4ada5
+Subproject commit 97b82df2a8571d0d125232058c798fe340bb07c9
index b6d12e37e9f6adbc051f03967978d85f33f6883a..141ff24e0f0ab4f6b0cf10efcd6007d32efbff07 160000 (submodule)
@@ -1 +1 @@
-Subproject commit b6d12e37e9f6adbc051f03967978d85f33f6883a
+Subproject commit 141ff24e0f0ab4f6b0cf10efcd6007d32efbff07
index beaa99a440ddb0bc3171d36d112f42367422a37b..350202f3e12a11a903d84be457e487fe83ad81c2 160000 (submodule)
@@ -1 +1 @@
-Subproject commit beaa99a440ddb0bc3171d36d112f42367422a37b
+Subproject commit 350202f3e12a11a903d84be457e487fe83ad81c2
index 7692a6bcdc9d0bb37899b1b2d1a9bba0f727ebd7..57c9557ee88cb0224d81b45c193a03defdf81a06 160000 (submodule)
@@ -1 +1 @@
-Subproject commit 7692a6bcdc9d0bb37899b1b2d1a9bba0f727ebd7
+Subproject commit 57c9557ee88cb0224d81b45c193a03defdf81a06
index 1cac8e8f6e74f8017874acedd0db010aee6f33db..381e9f9b3b3e5e6a072af58d011f5f23411f6b95 100644 (file)
@@ -1,3 +1,5 @@
+.. _l2switch-user-guide:
+
 L2 Switch User Guide
 ====================
 
index 2cdcd15ea79f28d72bfcb456cb88d05778d82114..52dcee58f63d55c90ee8c64db13db0ed769af0ee 100644 (file)
@@ -1,3 +1,5 @@
+.. _lacp-user-guide:
+
 Link Aggregation Control Protocol User Guide
 ============================================
 
index 234b010510f76d503ecc23b54abac482dbf9a5e5..06de306ceefcd5b6cca7900af5dcf272120a6bd7 100644 (file)
@@ -1,3 +1,5 @@
+.. _nic-user-guide:
+
 Network Intent Composition (NIC) User Guide
 ===========================================
 
index cd92a185c5cf29e07b4a5518b38f0c44fccb12f9..3ddaf28cbee33df9e3a1fb8373028d936adebea1 100644 (file)
@@ -1,3 +1,5 @@
+.. _ofconfig-user-guide:
+
 OF-CONFIG User Guide
 ====================
 
index 40a96f53c76f356f8d2eca0dfcdd8a906f921598..7255cfbb94ef317a04395825e45c43068a06522b 100644 (file)
@@ -1,3 +1,5 @@
+.. _unimgr-user-guide:
+
 User Network Interface Manager Plug-in (Unimgr) User Guide
 ==========================================================