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