From d0aaa7ed4390201b13fbe1cfa52ee2ad450833e9 Mon Sep 17 00:00:00 2001 From: shangxdy Date: Tue, 31 Oct 2017 17:47:09 +0800 Subject: Update release notes for nfv-toscaparser Update nfv-toscaparser release notes JIRA: MODELING-33 Change-Id: Ifa6290d6bc6a8f4abd821bdb8acba494f7f3eaa3 Signed-off-by: shangxdy --- docs/nfvparser/release-notes/release-notes.rst | 229 +++++++++++-------------- 1 file changed, 99 insertions(+), 130 deletions(-) diff --git a/docs/nfvparser/release-notes/release-notes.rst b/docs/nfvparser/release-notes/release-notes.rst index 3c1dc70..395dd6b 100644 --- a/docs/nfvparser/release-notes/release-notes.rst +++ b/docs/nfvparser/release-notes/release-notes.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 -This document provides the release notes for of . +This document provides the release notes for nfv-toscaparser. .. contents:: :depth: 3 @@ -16,30 +16,21 @@ Version history | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +--------------------+--------------------+--------------------+--------------------+ -| 2017-03-06 | 1.0 | Howard Huang | Danube Release | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 2017-09-25 | 2.0 | Shang Xiaodong | Euphrates release | +| 2017-09-25 | 0.5.0 | Shang Xiaodong | ONAP release 1 | | | | | | +--------------------+--------------------+--------------------+--------------------+ | | | | | | | | | | +--------------------+--------------------+--------------------+--------------------+ -Important notes -=============== - -**Attention**: Parser's submodules should be installed independantly from OPNFV platform, for -instructions please refer to the installation documention. - Summary ======= -OPNFV Parser Danube release has provides four submodules to serve as translation/prevalidation -tools: tosca2heat, yang2tosca, policy2tosca, and verigraph. Specifically, tosca2heat module -provides an integration of OpenStack tosca-parser and heat-translater -upstream projects 0.7 release with additional Parser unique features. +Modeling has provides two submodules to serve as simple tosca template parse/prevalidation +tools: nfv-toscaparser and javatoscachecker. Specifically, nfv-toscaparser module provides +an integration of OpenStack tosca-parser and OPNFV parser with additional some unique features +from ONAP. Release Data @@ -47,16 +38,16 @@ Release Data +--------------------------------------+--------------------------------------+ -| **Project** | OPNFV Parser | +| **Project** | ONAP Modeling | +--------------------------------------+--------------------------------------+ | **Repo/commit-ID** | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Danube 1.0 | +| **Release designation** | Release 1.0 | +--------------------------------------+--------------------------------------+ -| **Release date** | E.g. 2015-04-16 | +| **Release date** | E.g. 2017-09-25 | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Template Translation/Prevalida-| -| | tion tooling | +| **Purpose of the delivery** | Simple TOSCA Template Parse/Preval- | +| | idation tooling | +--------------------------------------+--------------------------------------+ Version change @@ -65,16 +56,16 @@ Version change Module version changes ~~~~~~~~~~~~~~~~~~~~~~ -- OpenStack tosca-parser and heat-translator have changed from 0.6 to 0.7 +- OpenStack tosca-parser have changed from 0.8 -- new verigraph module +- new feature added according to the others ONAP project's requirements -- no feature changes in yang2tosca and policy2tosca since Colorado Release. +- Fixed some bugs. Document version changes ~~~~~~~~~~~~~~~~~~~~~~~~ -- Parser Dabube Release documentation has adoped a new format. +- nfv-toscaparser documentation has adoped a new format. Reason for version ^^^^^^^^^^^^^^^^^^ @@ -86,59 +77,59 @@ Feature additions **JIRA BACK-LOG:** -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| PARSER-111 | Verigraph Code Base | -+--------------------------------------+--------------------------------------+ -| PARSER-112 | Init api gateway framework | -+--------------------------------------+--------------------------------------+ -| PARSER-113 | Add input validation test case | -+--------------------------------------+--------------------------------------+ -| PARSER-114 | Add output in vRNC for substitution | -| | mappings. | -+--------------------------------------+--------------------------------------+ -| PARSER-115 | Add output validation for | -| | substitution. | -+--------------------------------------+--------------------------------------+ -| PARSER-116 | Add output validation test case for | -| | substitution. | -+--------------------------------------+--------------------------------------+ -| PARSER-121 | Add ip output in compute node | -+--------------------------------------+--------------------------------------+ -| PARSER-125 | Package for funectest with docker | -| | container. | -+--------------------------------------+--------------------------------------+ -| PARSER-135 | Support costum datatype in | -| | capability. | -+--------------------------------------+--------------------------------------+ -| PARSER-136 | Support metadata validation | -+--------------------------------------+--------------------------------------+ -| PARSER-137 | Support yaml file with suffix of yml | -+--------------------------------------+--------------------------------------+ -| PARSER-138 | Support costum datatype definition | -| | cin parameters. | -+--------------------------------------+--------------------------------------+ -| PARSER-141 | Add required parameters validation | -| | for nested service | -+--------------------------------------+--------------------------------------+ -| PARSER-142 | Add parameter validation in design | -| | time for ONAP | -+--------------------------------------+--------------------------------------+ -| PARSER-144 | Add import file with suffix of yml | -| | testcases | -+--------------------------------------+--------------------------------------+ -| PARSER-146 | Support template version of | -| | tosca_simple_yaml_1_1 | -+--------------------------------------+--------------------------------------+ -| PARSER-148 | Add debug mode parameter | -+--------------------------------------+--------------------------------------+ -| PARSER-151 | Refactor heat-translator setup.py | -+--------------------------------------+--------------------------------------+ -| PARSER-154 | code optimizations about graph | -| | manipulation and formula generation. | -+--------------------------------------+--------------------------------------+ ++---------------------+--------------------------------------+ +| **REFERENCE ID** | **SLOGAN** | +| | | ++---------------------+--------------------------------------+ +| 1 | Verigraph Code Base | ++---------------------+--------------------------------------+ +| 2 | Init api gateway framework | ++---------------------+--------------------------------------+ +| 3 | Add input validation test case | ++---------------------+--------------------------------------+ +| 4 | Add output in vRNC for substitution | +| | mappings. | ++---------------------+--------------------------------------+ +| 5 | Add output validation for | +| | substitution. | ++---------------------+--------------------------------------+ +| 6 | Add output validation test case for | +| | substitution. | ++---------------------+--------------------------------------+ +| 7 | Add ip output in compute node | ++---------------------+--------------------------------------+ +| 8 | Package for funectest with docker | +| | container. | ++---------------------+--------------------------------------+ +| 9 | Support costum datatype in | +| | capability. | ++---------------------+--------------------------------------+ +| 10 | Support metadata validation | ++---------------------+--------------------------------------+ +| 11 | Support yaml file with suffix of yml | ++---------------------+--------------------------------------+ +| 12 | Support costum datatype definition | +| | cin parameters. | ++---------------------+--------------------------------------+ +| 13 | Add required parameters validation | +| | for nested service | ++---------------------+--------------------------------------+ +| 14 | Add parameter validation in design | +| | time for ONAP | ++---------------------+--------------------------------------+ +| 15 | Add import file with suffix of yml | +| | testcases | ++---------------------+--------------------------------------+ +| 16 | Support template version of | +| | tosca_simple_yaml_1_1 | ++---------------------+--------------------------------------+ +| 17 | Add debug mode parameter | ++---------------------+--------------------------------------+ +| 18 | Refactor heat-translator setup.py | ++---------------------+--------------------------------------+ +| 19 | code optimizations about graph | +| | manipulation and formula generation. | ++---------------------+--------------------------------------+ Bug corrections @@ -146,30 +137,30 @@ Bug corrections **JIRA TICKETS:** -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| PARSER-117 | Fix ci bug when integrated with | -| | functest | -+--------------------------------------+--------------------------------------+ -| PARSER-122 | Fix docs bug | -+--------------------------------------+--------------------------------------+ -| PARSER-145 | Fix exceptions overwritten when | -| | nested import service topology | -+--------------------------------------+--------------------------------------+ -| PARSER-152 | fix costum datatype definition | -| | in parameters | -+--------------------------------------+--------------------------------------+ -| PARSER-153 | Fix StatefulEntityType when | -| | entitytype is not define | -+--------------------------------------+--------------------------------------+ -| PARSER-155 | Fix substitution mapping assigned | -| | value to nodetemplate | -+--------------------------------------+--------------------------------------+ -| PARSER-156 | Fix functest_run script for role | -| | of heat_stack_owner | -+--------------------------------------+--------------------------------------+ ++---------------------+--------------------------------------+ +| **REFERENCE ID** | **SLOGAN** | +| | | ++---------------------+--------------------------------------+ +| 1 | Fix ci bug when integrated with | +| | functest | ++---------------------+--------------------------------------+ +| 2 | Fix docs bug | ++---------------------+--------------------------------------+ +| 3 | Fix exceptions overwritten when | +| | nested import service topology | ++---------------------+--------------------------------------+ +| 4 | fix costum datatype definition | +| | in parameters | ++---------------------+--------------------------------------+ +| 5 | Fix StatefulEntityType when | +| | entitytype is not define | ++---------------------+--------------------------------------+ +| 6 | Fix substitution mapping assigned | +| | value to nodetemplate | ++---------------------+--------------------------------------+ +| 7 | Fix functest_run script for role | +| | of heat_stack_owner | ++---------------------+--------------------------------------+ Deliverables @@ -178,19 +169,15 @@ Deliverables Software deliverables ^^^^^^^^^^^^^^^^^^^^^ -- tosca2heat -- yang2tosca -- policy2tosca -- verigraph -- apigateway +- nfv-toscaaparser + Documentation deliverables ^^^^^^^^^^^^^^^^^^^^^^^^^^ - release document -- design document -- development document -- testing document +- installation document +- user guide document Known Limitations, Issues and Workarounds @@ -200,8 +187,6 @@ System Limitations ^^^^^^^^^^^^^^^^^^ - - Known issues ^^^^^^^^^^^^ @@ -209,7 +194,7 @@ Known issues **JIRA TICKETS:** +--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | +| **REFERENCE ID** | **SLOGAN** | | | | +--------------------------------------+--------------------------------------+ | | | @@ -233,27 +218,11 @@ Test Result : -Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results: +Test runs with the following results: +--------------------------------------+--------------------------------------+ | **TEST-SUITE** | **Results:** | | | | +--------------------------------------+--------------------------------------+ -| Parser with functest in fuel | PASS | -+--------------------------------------+--------------------------------------+ -| Parser with functest in apex | PASS | -+--------------------------------------+--------------------------------------+ -| Parser with functest in daisy | PASS | -+--------------------------------------+--------------------------------------+ -| Parser with functest in compass | PASS | +| Unit test | PASS | +--------------------------------------+--------------------------------------+ -| Parser with functest in joid | SKIP | -+--------------------------------------+--------------------------------------+ - -References -========== - - -For more information on the OPNFV Danube release, please see: - -http://opnfv.org/danube -- cgit 1.2.3-korg