From 8bf4f82ab08df8886584192dad3131b209208423 Mon Sep 17 00:00:00 2001 From: A H Date: Tue, 16 May 2017 11:43:38 -0700 Subject: [PATCH] Add NEMO Release Notes Change-Id: Ie615520b2f9abb9e3ee8c5861867c960410734eb Signed-off-by: A H --- .../project-specific-guides/nemo.rst | 86 +++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 docs/getting-started-guide/project-specific-guides/nemo.rst diff --git a/docs/getting-started-guide/project-specific-guides/nemo.rst b/docs/getting-started-guide/project-specific-guides/nemo.rst new file mode 100644 index 000000000..879131ced --- /dev/null +++ b/docs/getting-started-guide/project-specific-guides/nemo.rst @@ -0,0 +1,86 @@ +====================== +NEtwork MOdeling(NEMO) +====================== + +Major Features +============== + + +* 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. +* 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). +* openflow renderer is a sourthbound render to translate the mapping result of VN-PN to flow table in devices supporting for openflow protocol. +* cli render is also a sourthbound render to translate the mapping result of VN-PNinto forwarding table in devices supporting for traditional protocol. +* 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. + +NEMO Engine UI +-------------- + +* **Feature Name:** odl-nemo-engine-ui +* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=nemo.git;a=blob;f=nemo-features/src/main/features/features.xml; +* **Feature Description:** DSL based for the abstraction of network models and conclusion of operation patterns. +* **Top Level:** Yes +* **User Facing:** Yes +* **Experimental:** No +* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/nemo/job/nemo-csit-1node-engine-all-carbon/ + +Documentation +============= + +* **User Guide(s):** + + * `NEMO User Guide `_ + +* **Developer Guide(s):** + + * `NEMO Developer Guide `_ + +Security Considerations +======================= + +* There are no security issues found. + +Quality Assurance +================= + +* `Link to Sonar Report `_ 42.8% +* `Link to CSIT Jobs `_ +* `Manual Tests `_ +* External System Test is done manually, since the sandbox environment could not satisfy NEMO's requirements. + +Migration +--------- + +* Nothing beyond general Carbon migration requirements. + +Compatiblity +------------ + +* Nothing beyond general Carbon compatibility constraints. + +Bugs Fixed +---------- + +* `Bug Report `_ + +Known Issues +------------ + + +* 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 the Carbon version. +* For using cli-renderer, the physical network should be constructed with HuaWei's device: NE40E. More devices will be considered in the Carbon version. + +End-of-life +=========== + +* Nothing deprecated, EOL. + +Standards +========= + +* N/A + +Release Mechanics +================= + +* `NEMO Release Plan `_ +* Project was on schedule -- 2.36.6