summaryrefslogtreecommitdiffstats
path: root/docs/userguide
diff options
context:
space:
mode:
authorshangxdy <shang.xiaodong@zte.com.cn>2016-08-18 21:14:39 +0800
committershangxdy <shang.xiaodong@zte.com.cn>2016-08-20 00:12:32 +0800
commit6fecb729f550f4f543739375df8148ab9de38668 (patch)
tree996dcba33a4d323541b917186235db77cbf35b94 /docs/userguide
parent951b5b7e58eed31bc44d55c0b541f1383953b3d8 (diff)
Update the documents in Release C
As a developer; I want anybody who cares of project of parser to know what new features in release C; So i update the distribution documents. JIRA:PRASER-87 Change-Id: I0537ba55fa12daa2975f1b794908bca457cfd9c2 Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
Diffstat (limited to 'docs/userguide')
-rw-r--r--docs/userguide/featureusage.rst96
-rw-r--r--docs/userguide/index.rst26
-rw-r--r--docs/userguide/testusage.rst54
3 files changed, 164 insertions, 12 deletions
diff --git a/docs/userguide/featureusage.rst b/docs/userguide/featureusage.rst
index f133134..db2557f 100644
--- a/docs/userguide/featureusage.rst
+++ b/docs/userguide/featureusage.rst
@@ -2,11 +2,95 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
-<Feature> capabilities and usage
-================================
-Describe the specific capabilities and usage for <XYZ> feature.
+Installation
+============================
-<Feature and API usage guidelines and example>
------------------------------------------------
-Describe with examples how to use specfic features.
+Please follow the below installation steps to install parser.
+Step 1: Clone the parser project.
+
+.. code-block:: bash
+
+ git clone https://gerrit.opnfv.org/gerrit/parser
+
+Step 2: Install the heat-translator sub project.
+
+.. code-block:: bash
+
+ # uninstall pre-installed tosca-parser
+ pip uninstall -y heat-translator
+
+ # change directory to heat-translator
+ cd parser/tosca2heat/heat-translator
+
+ # install requirements
+ pip install -r requirements.txt
+
+ # install heat-translator
+ python setup.py install
+
+Step 3: 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
+
+
+ **Notes** It must uninstall pre-installed tosca-parser and heat-translator before install the two
+ components, and install heat-translator before installing tosca-parser, which is sure to use the
+ OPNFV version of tosca-parser and heat-translator other than openstack's components.
+
+Execution
+===========================
+
+Step 1: Change directory to where the tosca yaml files are present, example is
+below with vRNC definiton.
+
+.. code-block:: bash
+
+ cd parser/tosca2heat/tosca-parser/toscaparser/extensions/nfv/tests/data/vRNC/Definitions
+
+
+Step 2: Run the python command heat-translator with the TOSCA yaml file as an input option.
+
+.. code-block:: bash
+
+ heat-translator --template-file=<input file> --template-type=tosca
+ --outpurt-file=<output hot file>
+
+Example:
+
+.. code-block:: bash
+
+ heat-translator --template-file=vRNC.yaml \
+ --template-type=tosca --output-file=vRNC_hot.yaml
+
+Notes: heat-translator will call class of ToscaTemplate in tosca-parser firstly to validate and parse input yaml file,
+then tranlate the file into hot file, if you only want to validate or check the input file
+and don't want to translate, please use tosaca-parser as following:
+
+.. code-block:: bash
+
+ tosca-parser --template-file=<input yaml file>
+
+Example:
+
+.. code-block:: bash
+
+ tosca-parser --template-file=vRNC.yaml
+
+References
+===========================
+Refer two upstream components:
+ https://github.com/openstack/tosca-parser/blob/master/doc/source/usage.rst
+ https://github.com/openstack/heat-translator/blob/master/doc/source/usage.rst
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
new file mode 100644
index 0000000..9174daa
--- /dev/null
+++ b/docs/userguide/index.rst
@@ -0,0 +1,26 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
+=================
+Parser User Guide
+=================
+Parser is an open source project and licensed under Apache 2. Parser will help
+to provide a tooling mechanism, by parsing Telecom operators VNF descriptors
+(YANG templates) into TOSCA templates and then further translate TOSCA templates
+into certain common templates, which could be used in IaaS orchestration projects
+like OpenStack Heat(the template file is HOT, which stands for Heat Orchestrator
+Template), this document is about simple TOSCA to HOT, and the example is a vRNC
+(virtual Radio Network Controller) definition with format translated from simple
+TOSCA(parser's input file format) to HOT(parser's output file format), which can
+be deployed by heat directly.
+
+Contents:
+
+.. toctree::
+ :numbered:
+ :maxdepth: 2
+
+.. include:: featureusage.rst
+.. include:: testusage.rst
diff --git a/docs/userguide/testusage.rst b/docs/userguide/testusage.rst
index 9f9bdc9..35dacae 100644
--- a/docs/userguide/testusage.rst
+++ b/docs/userguide/testusage.rst
@@ -2,11 +2,53 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
-<Testing> capabilities and usage
-================================
-Describe the specific capabilities and usage for <XYZ> testing.
+Test use tox
+===========================
+1. run tox in tosca-parser sub project
-<Testing usage guidelines and example>
---------------------------------------
-Describe with examples how to use specfic test frameworks.
+.. code-block:: bash
+
+ # change directory to tosca-parser
+ cd parser/tosca2heat/tosca-parser
+
+ # run with pep8
+ tox -epep8
+
+ # run unit test
+ tox -epy27
+
+or
+
+.. code-block:: bash
+
+ # change directory to tosca-parser
+ cd parser/tosca2heat/tosca-parser
+
+ # run tox
+ tox
+
+
+2. run tox in heat-translator sub project
+
+.. code-block:: bash
+
+ # change directory to heat-translator
+ cd parser/tosca2heat/heat-translator
+
+ # run with pep8
+ tox -epep8
+
+ # run unit test
+ tox -epy27
+ tox -epy34
+
+or
+
+.. code-block:: bash
+
+ # change directory to heat-translator
+ cd parser/tosca2heat/heat-translator
+
+ # run tox
+ tox