diff options
author | MatthewLi <matthew.lijun@huawei.com> | 2016-01-25 02:44:55 -0500 |
---|---|---|
committer | MatthewLi <matthew.lijun@huawei.com> | 2016-01-25 21:20:35 -0500 |
commit | f763149f87564d6dc4e0a605dbe5df720ffe4f9a (patch) | |
tree | 5ee363920a6c1135cb4543a3adc76c9a6703c7dc /docs/parser_docs/yang2tosca/yang2tosca.rst | |
parent | 3e62d1a0dc6b86963e7d184fc06acfc3d98adb64 (diff) |
update parser document
JIRA: PARSER-14
document format has been updated, this patch is to improve the document
in parser project to satisfy the requirement of sphinx.
Change-Id: I629fa84a1b0333e9b59c24cdf7444733f7b35582
Signed-off-by: MatthewLi <matthew.lijun@huawei.com>
Diffstat (limited to 'docs/parser_docs/yang2tosca/yang2tosca.rst')
-rw-r--r-- | docs/parser_docs/yang2tosca/yang2tosca.rst | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/docs/parser_docs/yang2tosca/yang2tosca.rst b/docs/parser_docs/yang2tosca/yang2tosca.rst new file mode 100644 index 0000000..7235fc3 --- /dev/null +++ b/docs/parser_docs/yang2tosca/yang2tosca.rst @@ -0,0 +1,66 @@ +======================== +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. + git clone https://github.com/mbj4668/pyang.git + or + wget https://github.com/mbj4668/pyang/archive/master.zip + +Step 2: Change directory to the downloaded directory and run the setup file. + 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. + git clone https://gerrit.opnfv.org/gerrit/parser + +Execution +=========================== + +Step 1: Change directory to where the scripts are present. + 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. + python parser.py -n "YANG filename" + Example: + 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. + cat "YANG filename_tosca.yaml" + Example: + cat example_tosca.yaml |