Updated git submodules
[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=blob;f=features/odl-snmp4sdn-snmp4sdn/pom.xml;h=eece899425487cf81e81e3d87bff78a2f3d2797c;hb=HEAD
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
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 * The interface or configurable resource exposed to users includes RESTCONF API
34   and the switch list file. Switch list file, which is a plain-text file,
35   contains security information such as SNMP community.
36
37 * SNMP4SDN Plugin configures switches via SNMP protocol, and listens to SNMP
38   listen port for link-up/down trap. SNMP v2c is used.
39
40 Quality Assurance
41 =================
42
43 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=44354>`_ (Test coverage percent NA)
44 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/snmp4sdn/>`_
45 * Other manual testing and QA information
46 * For each function of SNMP4SDN Plugin, use REST API to confirm it's
47   availability and correctness. Existing functions includes flow configuration
48   (such as VLAN and forwarding table) and topology discovery.
49
50 Migration
51 ---------
52
53 * Is it possible to migrate from the previous release? If so, how?
54
55   No
56
57 Compatibility
58 -------------
59
60 * Is this release compatible with the previous release?
61
62   Yes
63
64 * Any API changes?
65
66   No
67
68 * Any configuration changes?
69
70   No
71
72
73 Bugs Fixed
74 ----------
75
76 * None (no bugs reported since the previous release)
77
78 Known Issues
79 ------------
80
81 * List key known issues with workarounds
82
83   None
84
85 * `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&list_id=78998&order=Importance&product=snmp4sdn&query_format=specific>`_
86
87 End-of-life
88 ===========
89
90 * List of features/APIs which are EOLed, deprecated, and/or removed in this release
91
92   None
93
94 Standards
95 =========
96
97 * List of standards implemented and to what extent
98
99   None (no standards implemented, and use a third-party library to configure switches in standard SNMP protocol)
100
101 Release Mechanics
102 =================
103
104 * `Link to release plan <https://wiki.opendaylight.org/view/SNMP4SDN:Release_Plan_Nitrogen>`_
105 * No changes in this release