ea709ce5078408e865721cbf87b27fbc252c9239
[docs.git] / docs / getting-started-guide / project-release-notes / nemo.rst
1 ======================
2 NEtwork MOdeling(NEMO)
3 ======================
4
5 Major Features
6 ==============
7
8
9 * odl nemo rest provides an abstracted intent model whose target is to enable network users/applications to describe their intent in an intuitive way without caring about the underlying physical network.
10 * nemo engine is the core module of NEMO project, which releases the mapping from intent to physical network. It includes two import process: intent-virtual network(VN) and virtual network-physical network(PN).
11 * openflow renderer is a sourthbound render to translate the mapping result of VN-PN to flow table in devices supporting for openflow protocol.
12 * cli render is also a sourthbound render to translate the mapping result of VN-PNinto forwarding table in devices supporting for traditional protocol.
13 * nemo engine ui is reponsible for showing the status of physical network, intent, generated virtual network and mapping result of VN-PN, which facilitate users to understand better the intent handling process if they want to.
14
15 NEMO Engine UI
16 --------------
17
18 * **Feature Name:** odl-nemo-engine-ui
19 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=nemo.git;a=blob;f=nemo-features/odl-nemo-engine-ui/pom.xml;
20 * **Feature Description:**  DSL based for the abstraction of network models and conclusion of operation patterns.
21 * **Top Level:** Yes
22 * **User Facing:** Yes
23 * **Experimental:** Yes
24 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nemo/job/nemo-csit-1node-engine-all-nitrogen/
25
26 Documentation
27 =============
28
29 * **User Guide(s):**
30
31   * :ref:`nemo-user-guide`
32
33 * **Developer Guide(s):**
34
35   * :ref:`nemo-dev-guide`
36
37 Security Considerations
38 =======================
39
40 * There are no security issues found.
41
42 Quality Assurance
43 =================
44
45 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=53347>`_ 42.8%
46 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/nemo/job/nemo-csit-1node-engine-all-nitrogen/>`_
47 * `Manual Tests <https://wiki.opendaylight.org/view/NEMO:System_Test>`_
48 * External System Test is done manually, since the sandbox environment could not satisfy NEMO's requirements.
49
50 Migration
51 ---------
52
53 * Nothing beyond general OpenDaylight migration requirements.
54
55 Compatibility
56 -------------
57
58 * Nothing beyond general OpenDaylight compatibility constraints.
59
60 Bugs Fixed
61 ----------
62
63 * `Bug Report <https://bugs.opendaylight.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&bug_status=VERIFIED&list_id=47710&product=nemo&query_format=advanced&resolution=--->`_
64
65 Known Issues
66 ------------
67
68
69 * For using openflow-renderer, requiring special switch to construct physical network. The install guide is in https://github.com/zhangmroy?tab=repositories. Other virtual switch, such as, ovs, will be support in future OpenDaylight version.
70 * For using cli-renderer, the physical network should be constructed with HuaWei's device: NE40E. More devices will be considered in the future OpenDaylight versions.
71
72 End-of-life
73 ===========
74
75 * Nothing deprecated, EOL.
76
77 Standards
78 =========
79
80 * N/A
81
82 Release Mechanics
83 =================
84
85 * `NEMO Release Plan <https://wiki.opendaylight.org/view/NEMO:Nitrogen:Release_Plan>`_
86 * Project was on schedule