Move release notes out of getting started guide
[docs.git] / docs / release-notes / projects / odl-sdni.rst
1 ========
2 ODL SDNi
3 ========
4
5 Major Features
6 ==============
7
8 odl-sdninterfaceapp-all
9 -----------------------
10
11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sdninterfaceapp.git;a=blob;f=features/features-sdninterfaceapp/src/main/features/features.xml;hb=stable/carbon
12 * **Feature Description:** This feature installs the odl-sdni application which
13   connects with switch, topology, hosttracker managers of controller, fetches
14   the topology and QoS data and exchanges the same to the peer controllers.
15 * **Top Level:** Yes
16 * **User Facing:** Yes
17 * **Experimental:** Yes
18 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sdninterfaceapp/
19
20 Documentation
21 =============
22
23 * **User Guide(s):**
24
25   * :ref:`sdni-user-guide`
26
27 * **Developer Guide(s):**
28
29   * :ref:`sdni-dev-guide`
30
31
32 Security Considerations
33 =======================
34
35 ODL SDNi uses BGP to exchange information and leaves securing the BGP
36 connections and any implications of (not) doing so out of scope.
37
38 There are no other known security issues.
39
40 Quality Assurance
41 =================
42
43 * 8 APIs, tested via REST API
44
45   Topology:
46
47   * Self Topology:1 API
48   * Peer Topology:1 API
49
50   QoS:
51
52   * Self Qos :1 API
53   * Peer Qos :1 API
54
55   Peer Controller configuration:
56
57   * 4 APIs(Addition, deletion, fetching the configured controllers etc)
58
59 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=57255>`_ (11.9 %)
60
61 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/sdninterfaceapp/>`_
62
63
64 Migration
65 ---------
66
67 * Is it possible to migrate from the previous release? If so, how?
68   No, current release is backward incompatible.
69
70
71 Compatibility
72 -------------
73
74 * Is this release compatible with the previous release?
75   No
76
77 * Any API changes?
78   Yes, four new REST APIs are added for peer controller configuration are added in this release.
79
80 * Any configuration changes?
81   No
82
83
84 Bugs Fixed
85 ----------
86
87 * `Bug 6202 <https://bugs.opendaylight.org/show_bug.cgi?id=6202>`_
88   Refactored sdninterfaceapp and removed the copies of bgpcep artifacts.
89
90
91 Known Issues
92 ------------
93
94 * N/A
95
96
97 End-of-life
98 ===========
99
100 * N/A
101
102
103 Standards
104 =========
105
106 * The ODL SDNi project leverages BGP to exchange state.
107
108 Release Mechanics
109 =================
110
111 * `Release plan <https://wiki.opendaylight.org/view/ODL-SDNi_App:Carbon_Release_Plan>`_
112 * Bug 6202 which was targeted for M3 is resolved in M5