diff options
| -rw-r--r-- | docs/nfvparser/index.rst | 8 | ||||
| -rw-r--r-- | docs/nfvparser/installation/index.rst | 13 | ||||
| -rw-r--r-- | docs/nfvparser/installation/installation.instruction.rst | 52 | ||||
| -rw-r--r-- | docs/nfvparser/release-notes/index.rst | 13 | ||||
| -rw-r--r-- | docs/nfvparser/release-notes/release-notes.rst | 259 | ||||
| -rw-r--r-- | docs/nfvparser/userguide/feature.userguide.rst | 27 | ||||
| -rw-r--r-- | docs/nfvparser/userguide/index.rst | 25 |
7 files changed, 395 insertions, 2 deletions
diff --git a/docs/nfvparser/index.rst b/docs/nfvparser/index.rst index d64d115..70d80cc 100644 --- a/docs/nfvparser/index.rst +++ b/docs/nfvparser/index.rst @@ -1,8 +1,12 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -The documentation for nfvparser -=============================== +The documentation for nfv-toscaparser +===================================== .. toctree:: :maxdepth: 1 + + installation/index + release-notes/index + userguide/index diff --git a/docs/nfvparser/installation/index.rst b/docs/nfvparser/installation/index.rst new file mode 100644 index 0000000..fdaf0d2 --- /dev/null +++ b/docs/nfvparser/installation/index.rst @@ -0,0 +1,13 @@ +.. _parser-installation: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +*************************************** +OPNFV Parser Installation Instruction +*************************************** + +.. toctree:: + :maxdepth: 1 + + installation.instruction diff --git a/docs/nfvparser/installation/installation.instruction.rst b/docs/nfvparser/installation/installation.instruction.rst new file mode 100644 index 0000000..751c446 --- /dev/null +++ b/docs/nfvparser/installation/installation.instruction.rst @@ -0,0 +1,52 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +Parser nfv toscaparser Installation +=================================== + +Nfv tocsa provide two method for installation, please follow the below installation steps to install toscaparser. + +By code source +^^^^^^^^^^^^^^ + +Step 1: Clone the parser project. + +Step 2: Install the tosca-parser sub project. + +.. code-block:: bash + + # uninstall pre-installed tosca-parser + pip uninstall -y tosca-parser + + # change directory to tosca-parser + cd parser/tosca2heat/tosca-parser + + # install requirements + pip install -r requirements.txt + + # install tosca-parser + python setup.py install + +By pacage +^^^^^^^^^^ +Step 1: Make user pip has been already installed. + +.. code-block:: bash + + # for ubuntu or debin + apt-get install python-pip + or + # for centos,rhel or fedora + yum install python-pip + +Step 2: install nfv-tsoca using pip + +.. code-block:: bash + + pip install nfv-tosca + + +**Notes**: It must uninstall pre-installed tosca-parser before install the component, which is sure to use the +OPNFV version of tosca-parser other than openstack's components. + diff --git a/docs/nfvparser/release-notes/index.rst b/docs/nfvparser/release-notes/index.rst new file mode 100644 index 0000000..28a4046 --- /dev/null +++ b/docs/nfvparser/release-notes/index.rst @@ -0,0 +1,13 @@ +.. _parser-releasenotes: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +************************** +OPNFV Parser Release Notes +************************** + +.. toctree:: + :maxdepth: 1 + + release-notes diff --git a/docs/nfvparser/release-notes/release-notes.rst b/docs/nfvparser/release-notes/release-notes.rst new file mode 100644 index 0000000..3c1dc70 --- /dev/null +++ b/docs/nfvparser/release-notes/release-notes.rst @@ -0,0 +1,259 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +This document provides the release notes for <Danube Release> of <Parser>. + +.. contents:: + :depth: 3 + :local: + + +Version history +--------------- + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2017-03-06 | 1.0 | Howard Huang | Danube Release | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2017-09-25 | 2.0 | Shang Xiaodong | Euphrates release | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| | | | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ + +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. + + +Release Data +============ + + ++--------------------------------------+--------------------------------------+ +| **Project** | OPNFV Parser | ++--------------------------------------+--------------------------------------+ +| **Repo/commit-ID** | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Danube 1.0 | ++--------------------------------------+--------------------------------------+ +| **Release date** | E.g. 2015-04-16 | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | OPNFV Template Translation/Prevalida-| +| | tion tooling | ++--------------------------------------+--------------------------------------+ + +Version change +^^^^^^^^^^^^^^ + +Module version changes +~~~~~~~~~~~~~~~~~~~~~~ + +- OpenStack tosca-parser and heat-translator have changed from 0.6 to 0.7 + +- new verigraph module + +- no feature changes in yang2tosca and policy2tosca since Colorado Release. + +Document version changes +~~~~~~~~~~~~~~~~~~~~~~~~ + +- Parser Dabube Release documentation has adoped a new format. + +Reason for version +^^^^^^^^^^^^^^^^^^ +Feature additions +~~~~~~~~~~~~~~~~~ +<STATE ADDED FEATURES BY REFERENCE TO JIRA> + +<EXAMPLE>: + +**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. | ++--------------------------------------+--------------------------------------+ + + +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 | ++--------------------------------------+--------------------------------------+ + + +Deliverables +------------ + +Software deliverables +^^^^^^^^^^^^^^^^^^^^^ + +- tosca2heat +- yang2tosca +- policy2tosca +- verigraph +- apigateway + +Documentation deliverables +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +- release document +- design document +- development document +- testing document + + +Known Limitations, Issues and Workarounds +========================================= + +System Limitations +^^^^^^^^^^^^^^^^^^ + + + + +Known issues +^^^^^^^^^^^^ + + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| | | ++--------------------------------------+--------------------------------------+ +| | | ++--------------------------------------+--------------------------------------+ + +Workarounds +^^^^^^^^^^^ + +<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE> + +<EXAMPLE>: + +- In case the contact with a compute is lost - restart the compute host +- In case the disk is full on a controller - delete all files in /tmp + +Test Result +=========== +<STATE THE QA COVERAGE AND RESULTS> + +<EXAMPLE>: + +Fuel@OPNFV Arno RC2 has undergone QA 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 | ++--------------------------------------+--------------------------------------+ +| Parser with functest in joid | SKIP | ++--------------------------------------+--------------------------------------+ + +References +========== + + +For more information on the OPNFV Danube release, please see: + +http://opnfv.org/danube diff --git a/docs/nfvparser/userguide/feature.userguide.rst b/docs/nfvparser/userguide/feature.userguide.rst new file mode 100644 index 0000000..c674e30 --- /dev/null +++ b/docs/nfvparser/userguide/feature.userguide.rst @@ -0,0 +1,27 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) <optionally add copywriters name> + + + +nfv parser Execution +===================== + +Following is shown how to use nfv-toscaparser: + +.. code-block:: bash + + tosca-parser --template-file=<path to the YAML template> [--nrpv] [--debug] + or + tosca-parser --template-file=<path to the CSAR zip file> [--nrpv] [--debug] + or + tosca-parser --template-file=<URL to the template or CSAR> [--nrpv] [--debug] + options: + --nrpv Ignore input parameter validation when parse template. + --debug debug mode for print more details other than raise exceptions when errors happen + +Example: + +.. code-block:: bash + + tosca-parser --template-file=vRNC.yaml --nrpv diff --git a/docs/nfvparser/userguide/index.rst b/docs/nfvparser/userguide/index.rst new file mode 100644 index 0000000..addc37e --- /dev/null +++ b/docs/nfvparser/userguide/index.rst @@ -0,0 +1,25 @@ +.. _parser-userguide: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +======================= +OPNFV Parser User Guide +======================= + +.. The feature user guide should provide an OPNFV user with enough information to +.. use the features provided by the feature project in the supported scenarios. +.. This guide should walk a user through the usage of the features once a scenario +.. has been deployed and is active according to the installation guide provided +.. by the installer project. + +.. toctree:: + :maxdepth: 1 + + feature.userguide +.. The feature.userguide.rst file should contain the text for this document +.. additional documents can be added to this directory and added in the right order +.. to this file as a list below. + + |