Move release notes out of getting started guide
[docs.git] / docs / release-notes / projects / infrautils.rst
1 ==========
2 Infrautils
3 ==========
4
5 Major Features
6 ==============
7
8 We have done a lot of clean-up and minor fixes for bugs reported via Bugzilla.
9
10 Major changes delivered in this release are:
11
12 * Job Coordinator: enables executing jobs in a parallel/sequential fashion, based on their keys (contribution from genius project)
13 * Ready Framework: new framework to indicate system readiness, initial version
14 * New JUnit Test Rules RunUntilFailureRule, LogCaptureRule, and LogRule
15
16 odl-infrautils-all
17 ------------------
18
19 * **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
20 * **Feature Description:**  This feature exposes all infrautils framework features
21 * **Top Level:** Yes
22 * **User Facing:** No
23 * **Experimental:** Yes
24 * **CSIT Test:** none
25
26 .. note that this is experimental until the system test waiver is granted
27 .. on this thread:
28 .. https://lists.opendaylight.org/pipermail/infrautils-dev/2017-May/000322.html
29
30 Documentation
31 =============
32
33 * **User Guide(s):**
34
35   * Infrautils provides low-level technical framework utilities and therefore has no user guide.
36
37 * **Developer Guide(s):**
38
39   * :ref:`infrautils-dev-guide`
40
41 Security Considerations
42 =======================
43
44 * No external interfaces
45
46 Quality Assurance
47 =================
48
49 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=66717>`_ (43.6% line coverage)
50 * Project infrautils provides low-level technical framework utilities
51   and therefore no CSIT automated system testing is available
52
53 Migration
54 ---------
55
56 * No additional migration steps needed
57
58 Compatibility
59 -------------
60
61 * This release is compatible with previous release
62 * Async API was removed (dead code, not used by any odl projects)
63 * No configuration changes made
64
65 Bugs Fixed
66 ----------
67
68 * `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>`_
69
70 Known Issues
71 ------------
72
73 * There are no currently known issues
74
75 End-of-life
76 ===========
77
78 * This section is N/A
79
80 Standards
81 =========
82
83 * This section is N/A
84
85 Release Mechanics
86 =================
87
88 * `Link to release plan <https://wiki.opendaylight.org/view/Infrastructure_Utilities:Nitrogen:Release_Plan>`_