summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/nfvparser/index.rst4
-rw-r--r--docs/nfvparser/installation/index.rst2
-rw-r--r--docs/nfvparser/installation/installation.instruction.rst24
-rw-r--r--docs/nfvparser/release-notes/index.rst2
-rw-r--r--docs/nfvparser/release-notes/release-notes.rst250
-rw-r--r--docs/nfvparser/userguide/feature.userguide.rst2
-rw-r--r--docs/nfvparser/userguide/index.rst2
7 files changed, 50 insertions, 236 deletions
diff --git a/docs/nfvparser/index.rst b/docs/nfvparser/index.rst
index 70d80cc..ddacfb2 100644
--- a/docs/nfvparser/index.rst
+++ b/docs/nfvparser/index.rst
@@ -1,7 +1,7 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-The documentation for nfv-toscaparser
-=====================================
+The documentation for NFV Parser
+================================
.. toctree::
diff --git a/docs/nfvparser/installation/index.rst b/docs/nfvparser/installation/index.rst
index fdaf0d2..f1fb00b 100644
--- a/docs/nfvparser/installation/index.rst
+++ b/docs/nfvparser/installation/index.rst
@@ -4,7 +4,7 @@
.. http://creativecommons.org/licenses/by/4.0
***************************************
-OPNFV Parser Installation Instruction
+NFV Parser Installation Instruction
***************************************
.. toctree::
diff --git a/docs/nfvparser/installation/installation.instruction.rst b/docs/nfvparser/installation/installation.instruction.rst
index 751c446..c7d797a 100644
--- a/docs/nfvparser/installation/installation.instruction.rst
+++ b/docs/nfvparser/installation/installation.instruction.rst
@@ -2,33 +2,37 @@
.. http://creativecommons.org/licenses/by/4.0
-Parser nfv toscaparser Installation
+NFV Parser Installation
===================================
-Nfv tocsa provide two method for installation, please follow the below installation steps to install toscaparser.
+NFV Parer provide two ways for installation, please follow the below installation steps to install nfv parser.
By code source
^^^^^^^^^^^^^^
Step 1: Clone the parser project.
-Step 2: Install the tosca-parser sub project.
+.. code-block:: bash
+
+ git clone http://gerrit.onap.org/r/modeling/toscaparsers
+
+Step 2: Install the nfvparser 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
+ # change directory to nfvparser
+ cd ./toscaparsers/nfvparser
# install requirements
pip install -r requirements.txt
- # install tosca-parser
+ # install nfv-toscaparser
python setup.py install
-By pacage
+By package
^^^^^^^^^^
Step 1: Make user pip has been already installed.
@@ -40,11 +44,13 @@ Step 1: Make user pip has been already installed.
# for centos,rhel or fedora
yum install python-pip
-Step 2: install nfv-tsoca using pip
+Step 2: install nfv-toscaparser using pip
.. code-block:: bash
- pip install nfv-tosca
+ pip install nfv-toscaparser
+ or
+ pip install --pre nfv-toscaparser
**Notes**: It must uninstall pre-installed tosca-parser before install the component, which is sure to use the
diff --git a/docs/nfvparser/release-notes/index.rst b/docs/nfvparser/release-notes/index.rst
index 28a4046..9e2f309 100644
--- a/docs/nfvparser/release-notes/index.rst
+++ b/docs/nfvparser/release-notes/index.rst
@@ -4,7 +4,7 @@
.. http://creativecommons.org/licenses/by/4.0
**************************
-OPNFV Parser Release Notes
+NFV Parser Release Notes
**************************
.. toctree::
diff --git a/docs/nfvparser/release-notes/release-notes.rst b/docs/nfvparser/release-notes/release-notes.rst
index 395dd6b..6263188 100644
--- a/docs/nfvparser/release-notes/release-notes.rst
+++ b/docs/nfvparser/release-notes/release-notes.rst
@@ -1,228 +1,36 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
+
+
+NFV Parser Release Notes
+========================
+
+
+Version: x.y.z
+--------------
+
+
+:Release Date: 2017-10-15
-This document provides the release notes for nfv-toscaparser.
-
-.. contents::
- :depth: 3
- :local:
-
-
-Version history
----------------
-
-+--------------------+--------------------+--------------------+--------------------+
-| **Date** | **Ver.** | **Author** | **Comment** |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| 2017-09-25 | 0.5.0 | Shang Xiaodong | ONAP release 1 |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| | | | |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-
-
-Summary
-=======
-
-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
-============
-
-
-+--------------------------------------+--------------------------------------+
-| **Project** | ONAP Modeling |
-+--------------------------------------+--------------------------------------+
-| **Repo/commit-ID** | |
-+--------------------------------------+--------------------------------------+
-| **Release designation** | Release 1.0 |
-+--------------------------------------+--------------------------------------+
-| **Release date** | E.g. 2017-09-25 |
-+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | Simple TOSCA Template Parse/Preval- |
-| | idation tooling |
-+--------------------------------------+--------------------------------------+
-
-Version change
-^^^^^^^^^^^^^^
-
-Module version changes
-~~~~~~~~~~~~~~~~~~~~~~
-
-- OpenStack tosca-parser have changed from 0.8
-
-- new feature added according to the others ONAP project's requirements
-
-- Fixed some bugs.
-
-Document version changes
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-- nfv-toscaparser documentation has adoped a new format.
-
-Reason for version
-^^^^^^^^^^^^^^^^^^
-Feature additions
-~~~~~~~~~~~~~~~~~
-<STATE ADDED FEATURES BY REFERENCE TO JIRA>
-
-<EXAMPLE>:
-
-**JIRA BACK-LOG:**
-
-+---------------------+--------------------------------------+
-| **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
-~~~~~~~~~~~~~~~
-
-**JIRA TICKETS:**
-
-+---------------------+--------------------------------------+
-| **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
-------------
-
-Software deliverables
-^^^^^^^^^^^^^^^^^^^^^
-
-- nfv-toscaaparser
-
-
-Documentation deliverables
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-- release document
-- installation document
-- user guide document
-
-
-Known Limitations, Issues and Workarounds
-=========================================
-
-System Limitations
-^^^^^^^^^^^^^^^^^^
-
-
-Known issues
-^^^^^^^^^^^^
-
-
-**JIRA TICKETS:**
-
-+--------------------------------------+--------------------------------------+
-| **REFERENCE ID** | **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>:
+**New Features**
+ Initial release of nfvparser for Open Network Automation Platform (ONAP)
-Test runs with the following results:
-+--------------------------------------+--------------------------------------+
-| **TEST-SUITE** | **Results:** |
-| | |
-+--------------------------------------+--------------------------------------+
-| Unit test | PASS |
-+--------------------------------------+--------------------------------------+
+**Bug Fixes**
+ - `MODELING-23 <https://jira.onap.org/browse/MODELING-23>`_ Sync code for nfv-toscaprser.
+ - `MODELING-24 <https://jira.onap.org/browse/MODELING-24>`_ Add coverage test item for tox.
+
+**Known Issues**
+ None
+
+**Upgrade Notes**
+ None
+
+**Other**
+
+===========
+
+End of Release Notes
diff --git a/docs/nfvparser/userguide/feature.userguide.rst b/docs/nfvparser/userguide/feature.userguide.rst
index c674e30..f9282d4 100644
--- a/docs/nfvparser/userguide/feature.userguide.rst
+++ b/docs/nfvparser/userguide/feature.userguide.rst
@@ -4,7 +4,7 @@
-nfv parser Execution
+NFV Parser Execution
=====================
Following is shown how to use nfv-toscaparser:
diff --git a/docs/nfvparser/userguide/index.rst b/docs/nfvparser/userguide/index.rst
index addc37e..de1caa7 100644
--- a/docs/nfvparser/userguide/index.rst
+++ b/docs/nfvparser/userguide/index.rst
@@ -5,7 +5,7 @@
=======================
-OPNFV Parser User Guide
+NFV Parser User Guide
=======================
.. The feature user guide should provide an OPNFV user with enough information to