Merge "Remove "handbook" terminology"
[docs.git] / docs / release-notes / projects / infrautils.rst
index b1f691a61d92b761f1e535f38662ecefb828c571..c1386c606f2affad8ce4f66d959a547f8b33d800 100644 (file)
@@ -5,50 +5,97 @@ Infrautils
 Major Features
 ==============
 
-We have done a lot of clean-up and minor fixes for bugs reported via Bugzilla.
-
-Major changes delivered in this release are:
-
-* Job Coordinator: enables executing jobs in a parallel/sequential fashion, based on their keys (contribution from genius project)
-* Ready Framework: new framework to indicate system readiness, initial version
-* New JUnit Test Rules RunUntilFailureRule, LogCaptureRule, and LogRule
-
 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 URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-all/pom.xml;hb=stable/oxygen
 * **Feature Description:**  This feature exposes all infrautils framework features
 * **Top Level:** Yes
 * **User Facing:** No
 * **Experimental:** Yes
-* **CSIT Test:** none
+* **CSIT Test:** covered by Netvirt and Genius CSITs
+  * https://jenkins.opendaylight.org/releng/view/netvirt/job/netvirt-csit-1node-openstack-queens-upstream-stateful-oxygen/
+  * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-all-oxygen/
 
 .. 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
 
+odl-infrautils-jobcoordinator
+-----------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-jobcoordinator/pom.xml;hb=stable/oxygen
+* **Feature Description:**  This feature exposes the jobcoordinator framework which is heavily used in genius and netvirt.
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** covered by Netvirt and Genius CSITs
+
+odl-infrautils-metrics
+----------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-metrics/pom.xml;hb=stable/oxygen
+* **Feature Description:**  This feature exposes the new infrautils.metrics API with labels and first implementation based on Dropwizard incl. thread watcher
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** covered by Netvirt and Genius CSITs
+
+odl-infrautils-ready
+--------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-ready/pom.xml;hb=stable/oxygen
+* **Feature Description:**  This feature exposes the system readiness framework
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** covered by Netvirt and Genius CSITs
+
+odl-infrautils-caches
+---------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-caches/pom.xml;hb=stable/oxygen
+* **Feature Description:**  This feature exposes new infrautils.caches API, CLI commands for monitoring, and first implementation based on Guava
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** covered by Netvirt and Genius CSITs
+
+odl-infrautils-diagstatus
+-------------------------
+
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-diagstatus/pom.xml;hb=stable/oxygen
+* **Feature Description:**  This feature exposes the status and diagnostics framework
+* **Top Level:** Yes
+* **User Facing:** No
+* **Experimental:** Yes
+* **CSIT Test:** covered by Netvirt and Genius CSITs
+
+
+
 Documentation
 =============
 
 * **User Guide(s):**
 
-  * Infrautils provides low-level technical framework utilities and therefore has no user guide.
+  * :doc:`User Guide </submodules/infrautils/docs/specs/index>`
 
 * **Developer Guide(s):**
 
-  * :ref:`infrautils-dev-guide`
+  * :doc:`Developer Guide </submodules/infrautils/docs/index>`
 
 Security Considerations
 =======================
 
-* No external interfaces
+* JMX RMI Registry opens on port listed at https://wiki.opendaylight.org/view/Ports
 
 Quality Assurance
 =================
 
-* `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=66717>`_ (43.6% line coverage)
+* `Link to Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.infrautils%3Ainfrautils>`_
 * Project infrautils provides low-level technical framework utilities
-  and therefore no CSIT automated system testing is available
+  and therefore no CSIT automated system testing is available. However
+  the same gets covered by the CSIT of users of infrautils (eg : Genius, Netvirt)
 
 Migration
 ---------
@@ -58,14 +105,24 @@ Migration
 Compatibility
 -------------
 
-* This release is compatible with previous release
-* Async API was removed (dead code, not used by any odl projects)
-* No configuration changes made
+* Is this release compatible with the previous release?
+
+  * Functionality is fully backwards compatible.
+
+* Any API changes?
+
+  * New APIs added for diagstatus
+  * New APIs added for metrics
+  * New APIs added for caches
+
+* Any configuration changes?
+
+  * No
 
 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=Nitrogen>`_
+* `List of bugs fixed since the previous release: <https://jira.opendaylight.org/browse/INFRAUTILS-29?jql=project%20%3D%20INFRAUTILS%20AND%20created%20%3E%3D%202017-10-07%20AND%20created%20%3C%3D%202018-03-08>`_
 
 Known Issues
 ------------
@@ -85,4 +142,4 @@ Standards
 Release Mechanics
 =================
 
-* `Link to release plan <https://wiki.opendaylight.org/view/Infrastructure_Utilities:Nitrogen:Release_Plan>`_
+* `Link to release plan <https://wiki.opendaylight.org/view/InfraUtils:Oxygen:Release_Plan>`_