Update eman release notes for Nitrogen
[docs.git] / docs / getting-started-guide / project-release-notes / eman.rst
1 ====
2 eman
3 ====
4
5 Major Features
6 ==============
7
8 odl-eman
9 --------
10
11 * **Feature URL:**  https://git.opendaylight.org/gerrit/gitweb?p=eman.git;a=blob;f=features/features-eman/src/main/features/features.xml;hb=stable/carbon
12 * **Feature Description:**  This provides a Northbound API to the eman Information Model
13 * **Top Level:** Yes
14 * **User Facing:** Yes
15 * **Experimental:** Yes
16 * **CSIT Test:** none
17
18 Documentation
19 =============
20
21 * **User Guide(s):**
22
23   * :ref:`eman-user-guide`
24
25 * **Developer Guide(s):**
26
27   * :ref:`eman-dev-guide`
28
29 Security Considerations
30 =======================
31
32 * Do you have any external interfaces other than RESTCONF?
33
34   While eman does not expose other external interfaces, it does rely upon the
35   external interfaces exposed by the SNMP plugin.
36
37 * Other security issues?
38
39   None
40
41 Quality Assurance
42 =================
43
44 * `Link to Sonar Report -  <https://sonar.opendaylight.org/overview?id=69960>`_
45 * Link to CSIT Jobs -  No CSIT jobs for this experimental release
46 * Other manual testing and QA information - Manual testing via RESTCONF and DLUX
47 * Testing methodology. How extensive was it? What should be expected to work? What hasn't been tested as much?
48
49   Testing has been manual interaction via DLUX using an SNMP simulator as described in :ref:`eman-user-guide`.
50
51 Migration
52 ---------
53
54 * Is it possible to migrate from the previous release? If so, how?
55
56   Yes, no changes to API
57
58 Compatibility
59 -------------
60
61 Yes, compatible with other features and the previous release
62
63 Bugs Fixed
64 ----------
65
66 * List of bugs fixed since the previous release
67
68   None
69
70 Known Issues
71 ------------
72
73 * List key known issues with workarounds
74
75   No known issues
76
77 * Link to Open Bugs
78
79   No open bugs
80
81 End-of-life
82 ===========
83
84 * List of features/APIs which are EOLed, deprecated, and/or removed in this release
85
86   None
87
88 Standards
89 =========
90
91 * List of standards implemented and to what extent
92
93   * `IETF Energy Management (eman) standards. <https://datatracker.ietf.org/wg/eman/charter/>`_
94     Only powerMeasurement table is currently implemented.
95
96 Release Mechanics
97 =================
98
99 * `Link to release plan <https://wiki.opendaylight.org/view/Eman:Nitrogen_Release_Plan>`_
100 * Describe any major shifts in release schedule from the release plan
101
102   None