Updated git submodules
[docs.git] / docs / getting-started-guide / project-release-notes / nic.rst
1 ===
2 NIC
3 ===
4
5 Major Features
6 ==============
7
8 odl-nic-core-mdsal
9 ------------------
10
11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=nic.git;a=blob_plain;f=features/odl-nic-core-mdsal/pom.xml;hb=stable/nitrogen
12 * **Feature Description:**  This feature contains the dependencies to use MDSAL
13   features on NIC
14 * **Top Level:** Yes
15 * **User Facing:** Yes
16 * **Experimental:** Yes
17 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-nitrogen/
18
19 odl-nic-intent-common
20 ---------------------
21
22 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=nic.git;a=blob_plain;f=features/odl-nic-intent-common/pom.xml;hb=stable/nitrogen
23 * **Feature Description:**  This feature contains the lifecycle management for
24   Intents, also is used to join two major features 'intent-statemachine' and
25   'intent-listeners'. This feature enable NIC to work with different renderers
26   at the same time.
27 * **Top Level:** Yes
28 * **User Facing:** Yes
29 * **Experimental:** Yes
30 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-nitrogen/
31
32 Documentation
33 =============
34
35 * **User Guide(s):**
36
37   * :ref:`nic-user-guide`
38
39 * **Developer Guide(s):**
40
41   * :ref:`nic-dev-guide`
42
43 Additional information can be found at the
44 `NIC wiki page <https://wiki.opendaylight.org/view/Network_Intent_Composition:Main>`_.
45   
46 Security Considerations
47 =======================
48
49 * Do you have any external interfaces other than RESTCONF?
50
51   No
52
53 * Other security issues?
54
55   N/A
56
57 Quality Assurance
58 =================
59
60 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=44164>`_ (33.2% code coverage)
61 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/nic/job/nic-csit-1node-basic-all-nitrogen/>`_
62 * Other manual testing and QA information
63 * Testing methodology. How extensive was it? What should be expected to work?
64   What has not been tested as much?
65
66   There are a guide to evaluate manual tests using NIC on our `wiki page
67   <https://wiki.opendaylight.org/view/Network_Intent_Composition:Main>`_
68
69 Migration
70 ---------
71
72 * Is it possible to migrate from the previous release? If so, how?
73
74   Migration with user configuration and state is not supported.
75
76 Compatibility
77 -------------
78
79 * Is this release compatible with the previous release?
80
81   Yes
82
83 * Any API changes?
84
85   No
86
87 * Any configuration changes?
88
89   No
90
91 Bugs Fixed
92 ----------
93
94 * List of bugs fixed since the previous release
95
96 Known Issues
97 ------------
98
99 * List key known issues with workarounds
100
101   For Nitrogen release, NIC contains multiple renderers, where each renderer can be used at the same time
102   without uninstalling NIC and restarting ODL.
103
104 End-of-life
105 ===========
106
107 * List of features/APIs which are EOLed, deprecated, and/or removed in this or last
108   release
109
110 * odl-nic-renderer-nemo
111 * odl-nic-renderer-vtn
112 * odl-nic-core-hazelcast
113
114 Standards
115 =========
116
117 * List of standards implemented and to what extent
118
119   N/A
120
121 Release Mechanics
122 =================
123
124 * `Link to release plan <https://wiki.opendaylight.org/view/NIC:Nitrogen:Release_Plan>`_
125 * Describe any major shifts in release schedule from the release plan
126
127   Capability to use multiple Renderers at the same time.
128   Capability to support new Intent definitions.
129   Integration with Intent State Machine.
130   Integration with BGPCEP project in order to advertise routes using Intents.
131   Apply OpenFlow rules using OpenFlowPlugin Meters
132   Integration with Genius project in order to manage the Meter IDs.