Move release notes out of getting started guide
[docs.git] / docs / release-notes / projects / dluxapps.rst
1 ========
2 DluxApps
3 ========
4
5 Major Features
6 ==============
7
8 odl-dluxapps-nodes
9 ------------------
10
11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/odl-dluxapps-nodes/pom.xml;h=672a6a317ccfe4b51c8fddd25e3e285b3018581e;hb=3eedd3072f269d652d0ddb664a0b8bf20cf81e6e
12 * **Feature Description:**  Application displays list of nodes in openflow (flow:1) topology.
13 * **Top Level:** Yes
14 * **User Facing:** Yes
15 * **Experimental:** Yes
16 * **CSIT Test:** N/A
17
18 odl-dluxapps-topology
19 ---------------------
20
21 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/odl-dluxapps-topology/pom.xml;h=5796edc2869cc2cf98b92b7c7bc4813848659bf7;hb=3eedd3072f269d652d0ddb664a0b8bf20cf81e6e
22 * **Feature Description:**  Basic topology application. Displays nodes and links from openflow (flow:1) topology.
23 * **Top Level:** Yes
24 * **User Facing:** Yes
25 * **Experimental:** Yes
26 * **CSIT Test:** N/A
27
28 odl-dluxapps-yangman
29 --------------------
30
31 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/odl-dluxapps-yangman/pom.xml;h=2a743ba9667bf60d144a8cb527a41f5323cd5a29;hb=3eedd3072f269d652d0ddb664a0b8bf20cf81e6e
32 * **Feature Description:**  GUI for data manipulation in controller. Generates forms based on loaded Yang models.
33   User can interact with controller without knowledge of Yang models, test them, etc. Replacement of YangUI app.
34 * **Top Level:** Yes
35 * **User Facing:** Yes
36 * **Experimental:** Yes
37 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/dluxapps/job/dluxapps-csit-1node-yangman-only-carbon/
38
39 odl-dluxapps-yangui
40 -------------------
41
42 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/odl-dluxapps-yangui/pom.xml;h=fe56512415f35f145cdd7925812533466182399c;hb=3eedd3072f269d652d0ddb664a0b8bf20cf81e6e
43 * **Feature Description:**  Previous version of YangUI. Will be removed in next release.
44 * **Top Level:** Yes
45 * **User Facing:** Yes
46 * **Experimental:** Yes
47 * **CSIT Test:** N/A
48
49 odl-dluxapps-yangvisualizer
50 ---------------------------
51
52 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=dluxapps.git;a=blob;f=features/odl-dluxapps-yangvisualizer/pom.xml;h=daf31e33454403f8d8f5cc8c3bce4a3938cc4a35;hb=3eedd3072f269d652d0ddb664a0b8bf20cf81e6e
53 * **Feature Description:**  Topology-like visualization of Yang models loaded in controller.
54 * **Top Level:** Yes
55 * **User Facing:** Yes
56 * **Experimental:** Yes
57 * **CSIT Test:** N/A
58
59 Documentation
60 =============
61
62 * **Developer Guide(s):**
63
64   * `DluxApps Developer Guide <https://wiki.opendaylight.org/view/DluxApps:DeveloperGuide>`_
65
66 Security Considerations
67 =======================
68
69 * There are no security issues found.
70
71 Quality Assurance
72 =================
73
74 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=72613>`_
75 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/dluxapps/search/?q=dluxapps-csit>`_
76 * GUI is tested mostly manually, CSITs are on the way.
77
78 Migration
79 ---------
80
81 * All applications are moved from Dlux project to DluxApps. Also feature names
82   changed, so instead odl-dlux-\* use odl-dluxapps-\*. Everything else works same.
83
84 Compatibility
85 -------------
86
87 * Release is compatible with previous.
88 * API changes are in feature names - odl-dlux-\* changes to odl-dluxapps-\*
89
90 Bugs Fixed
91 ----------
92
93 https://bugs.opendaylight.org/buglist.cgi?bug_status=__closed__&content=&no_redirect=1&order=Importance&product=dluxapps&query_format=specific
94
95 Known Issues
96 ------------
97
98 * `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&content=&no_redirect=1&order=Importance&product=dluxapps&query_format=specific>`_
99
100 End-of-life
101 ===========
102
103 * odl-dluxapps-yangui - deprecated
104
105 Standards
106 =========
107
108 * List of standrads implemented and to what extent
109
110   * N/A
111
112 Release Mechanics
113 =================
114
115 * `Link to release plan <https://wiki.opendaylight.org/view/DluxApps:Nitrogen_Release_Plan>`_
116 * UT coverage is not increased
117 * Yang Visualized refactor and redesign is not started