summaryrefslogtreecommitdiffstats
path: root/docs/developer/design/yang2tosca.rst
diff options
context:
space:
mode:
authorjulien zhang <zhang.jun3g@zte.com.cn>2017-02-28 07:24:24 +0000
committerGerrit Code Review <gerrit@opnfv.org>2017-02-28 07:24:24 +0000
commit9a2b86ff190a16822ec3f68b2c1d070d54a47da9 (patch)
tree7315aac40f9aed6c91f83429791f591b74e79cb3 /docs/developer/design/yang2tosca.rst
parent69e33063b3703ae4529b556b63b3c4cc239c3d9a (diff)
parente243c1f9c40c5acee4fb89d99fae05f7a46768be (diff)
Merge "Release D doc update"
Diffstat (limited to 'docs/developer/design/yang2tosca.rst')
-rw-r--r--docs/developer/design/yang2tosca.rst98
1 files changed, 98 insertions, 0 deletions
diff --git a/docs/developer/design/yang2tosca.rst b/docs/developer/design/yang2tosca.rst
new file mode 100644
index 0000000..5aaf463
--- /dev/null
+++ b/docs/developer/design/yang2tosca.rst
@@ -0,0 +1,98 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+=================
+Parser YANG2TOSCA
+=================
+
+Overview
+========
+
+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.
+
+Prerequisites
+=============
+
+Parser requires the following to be installed.
+
+1. PYANG
+--------
+
+Please follow the below installation steps.
+
+Step 1: Clone pyang tool or download the zip file from the following link.
+
+.. code-block:: bash
+
+ git clone https://github.com/mbj4668/pyang.git
+
+OR
+
+.. code-block:: bash
+
+ wget https://github.com/mbj4668/pyang/archive/master.zip
+
+Step 2: Change directory to the downloaded directory and run the setup file.
+
+.. code-block:: bash
+
+ cd pyang
+ python setup.py
+
+2. python-lxml
+--------------
+
+Please follow the below installation link. http://lxml.de/installation.html
+
+
+Installation
+============================
+
+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
+
+Execution
+===========================
+
+Step 1: Change directory to where the scripts are present.
+
+.. code-block:: bash
+
+ cd parser/yang2tosca
+
+Step 2: Copy the YANG file which needs to be converted into TOSCA to
+ current (parser/yang2tosca) folder.
+
+Step 3: Run the python script "parser.py" with the YANG file as an input option.
+
+.. code-block:: bash
+
+ python parser.py -n "YANG filename"
+
+Example:
+
+.. code-block:: bash
+
+ python parser.py -n example.yaml
+
+Step 4: Verify the TOSCA YAMl which file has been created with the same name
+ as the YANG file with a “_tosca” suffix.
+
+.. code-block:: bash
+
+ cat "YANG filename_tosca.yaml"
+
+Example:
+
+.. code-block:: bash
+
+ cat example_tosca.yaml