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