Add SNMP4SDN Oxygen release note
[docs.git] / docs / release-notes / projects / snmp4sdn.rst
1 ========
2 SNMP4SDN
3 ========
4
5 Major Features
6 ==============
7
8 odl-snmp4sdn-snmp4sdn
9 ---------------------
10
11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=snmp4sdn.git;a=tree;f=features;h=d6ff42ff4a927b3f772f63dbc1abceab17cd9e90;hb=db0ab7a12ef59e24fd0d63f1dc21fc60e7fe4c7a
12 * **Feature Description:**  This feature will install all bundles required for SNMP4SDN Plugin
13 * **Top Level:** Yes
14 * **User Facing:** Yes
15 * **Experimental:** Yes
16 * **CSIT Test:** NA, system test waiver
17
18
19 Documentation
20 =============
21
22 * **User Guide:**
23
24   * :ref:`snmp4sdn-user-guide`
25
26 * **Developer Guide(s):**
27
28   * :ref:`snmp4sdn-dev-guide`
29
30 Security Considerations
31 =======================
32
33 * Switch list file, which is a plain-text file, contains security information such as SNMP community. File access privilege would be carefully set.
34
35 * SNMP protocol v2c is used by SNMP4SDN Plugin. SNMP4SDN Plugin configures switches and listens to SNMP
36   listen port for link-up/down trap, via SNMP protocol.
37
38 Quality Assurance
39 =================
40
41 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=44354>`_ (Test coverage percent NA)
42 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/snmp4sdn/>`_
43 * Other manual testing and QA information
44 * For each function of SNMP4SDN Plugin, use REST API to confirm it's
45   availability and correctness. Existing functions includes flow configuration
46   (such as VLAN and forwarding table) and topology discovery.
47
48 Migration
49 ---------
50
51 * Is it possible to migrate from the previous release? If so, how?
52
53   No
54
55 Compatibility
56 -------------
57
58 * Is this release compatible with the previous release?
59
60   Yes
61
62 * Any API changes?
63
64   No
65
66 * Any configuration changes?
67
68   No
69
70
71 Bugs Fixed
72 ----------
73
74 * None (no bugs reported since the previous release)
75
76 Known Issues
77 ------------
78
79 * List key known issues with workarounds
80
81   None
82
83 * `Link to Open Bugs <https://jira.opendaylight.org/projects/SNMP4SDN/>`_
84
85 End-of-life
86 ===========
87
88 * List of features/APIs which are EOLed, deprecated, and/or removed in this release
89
90   None
91
92 Standards
93 =========
94
95 * List of standards implemented and to what extent
96
97   None (no standards implemented, and use a third-party library to configure switches in standard SNMP protocol)
98
99 Release Mechanics
100 =================
101
102 * `Link to release plan <https://wiki.opendaylight.org/view/SNMP4SDN:Release_Plan_Nitrogen>`_
103 * No changes in this release