From 53b22cfb7ad8b323073213e4e55584261dd4e50a Mon Sep 17 00:00:00 2001 From: zhipengh Date: Thu, 2 Mar 2017 11:51:07 +0800 Subject: Danube Release Docs Fixup patch 1 Done in this patch 1. Fixes in overview.rst 2. Moves governance folder under docs 3. Adds arno release use case doc from https://wiki.opnfv.org/display/parser/Parser+Use+Cases to the requirement folder 4. Moves two old tosca2heat documents into developer/design/examples 5. Adds new empty tosca2heat and verigraph design document under developer/design. 6. Remove old contents in yang2tosca and policy2tosca design docs since they are all related to installation/execution, not design. 7. Fixes in installation.instruction.rst and usage,guide.rst To do in the following patches 1. Design doc writeup: Xiaodong(tosca2heat), Shiva(yang2tosca/policy2tosca), Serena(verigraph) 2. Release doc writeup: Xiaodong and Howard (postinstall.rst,scenario.description.rst), Serena(verigraph part of release-notes.rst), release-notes.rst Change-Id: If4f51067dd33acd2332e503ee31d6941b4df4c89 Signed-off-by: zhipengh --- docs/developer/overview/overview.rst | 56 ++++++++++++++++++++++++------------ 1 file changed, 38 insertions(+), 18 deletions(-) (limited to 'docs/developer/overview/overview.rst') diff --git a/docs/developer/overview/overview.rst b/docs/developer/overview/overview.rst index d1cad64..f9efebe 100644 --- a/docs/developer/overview/overview.rst +++ b/docs/developer/overview/overview.rst @@ -26,14 +26,23 @@ operators’ descriptors/records into TOSCA/CAMP templates and then further translate TOSCA/CAMP templates into certain common templates, which could be used in IaaS orchestration projects like OpenStack Heat. -Upgrades from Arno +For Arno Release ------------------------ +Parser is not one of the Arno Release projects, however the project has established +the code base for the later releases: -For Release B, Parser offers the following additional capabilities: +* OpenStack Heat Translator Kilo Release +* Initial documentation on use cases -* Integration of Heat-Translator Liberty release code. (both heat in-tree code and standalone package are provided) +Upgrades from Arno Release +------------------------ + +For Brahmaputra Release, Parser offers the following additional capabilities: + +* Update with the integration of OpenStack Heat-Translator Liberty Release, of which + both heat in-tree code and standalone package are provided. -* Yang2Tosca module which offers the capability to translate yang based +* New module yang2tosca module which offers the capability to translate yang based scriptors to tosca formate templates. Users could further use Heat-translator module to translate this tosca template to Heat Orchestration template. Yang2Tosca module could be installed seperately after user installed @@ -45,22 +54,22 @@ For Release B, Parser offers the following additional capabilities: from Release C to indicate which specific set of keywords are supported in Parser. -* The "vRNC_tosca_intro" document describes Parser's use case analysis on vRNC scenario. - The "example" folder contains examples of tosca-nfv standard and vRNC scenario. - See also https://wiki.opnfv.org/parser. +* The "vRNC_tosca_intro" document describes Parser's use case analysis on vRNC +scenario.The "example" folder contains examples of tosca-nfv standard and vRNC +scenario. See also https://wiki.opnfv.org/parser. -Upgrades from Brumapatra +Upgrades from Brahmaputra Release ----------------------- -For Release C, Parser offers the following additional capabilities: +For Colorado Release, Parser offers the following additional capabilities: -* Policy2Tosca module which enables policy related fields in tosca could be translated - into heat orchestration template correctly. Policy2Tosca module could be installed seperately - after user installed OPNFV C release platform. +* New module policy2tosca which enables policy related fields in tosca could be +translated into heat orchestration template correctly. Policy2Tosca module could +be installed seperately after user installed OPNFV C release platform. -* Tosca2Heat enhancements which includes a set of feature addons (such as substitution mapping) -for OpenStack tosca-parser module which is integrated in the OPNFV C release platform. And the -main details are listed below: +* New module tosca2heat enhancements which includes a set of feature addons (such +as substitution mapping) for OpenStack tosca-parser module which is integrated in +the OPNFV C release platform. And the main details are listed below: ** support substitution mapping semantic in tosca-parser: - support parse and validation about substitution mapping definition; @@ -82,8 +91,19 @@ main details are listed below: * Additional testing support. -Upgrades from Colorado ----------------------- +Upgrades from Colorado Release +------------------------------ + +For Danube Release, Parser offers the following additional capabilities: + +* New module verigraph which is a formal verification tool for service graphs. Given + a service graph, which can include stateful network functions and their configurations + (e.g., filtering rules for firewalls, and blacklists for anti-spamming filters), verigraph + can accurately and quickly check reachability properties in the graph (e.g. if a particular + flow of packets can go from one node of the graph to another node). Verigraph exploits + Satisfiability Modulo Theories (SMT) and the general-purpose SMT solver Z3. It includes a + library of network function models. -For Release D, Parser offers the following additional capabilities: +* The tosca2heat module updated with the intgeration of OpenStack tosca-parser and heat-translator + 0.7.0 releases. -- cgit 1.2.3-korg