diff options
author | Ryota MIBU <r-mibu@cq.jp.nec.com> | 2016-02-26 03:38:12 +0900 |
---|---|---|
committer | Ryota MIBU <r-mibu@cq.jp.nec.com> | 2016-02-26 09:41:12 +0900 |
commit | 4e4c86a06d58b1816c074c7f9da4c58bbf10368c (patch) | |
tree | f6265994d5fa51494ee2c3b87c5b1fe4f8dffa2b /docs/parser_docs/yang2tosca | |
parent | b48e6c1b13c021bbedd2bf3a04e7a561e66d1faa (diff) |
docs: fix issues
Change-Id: Ie0917b70674a7a16c89c8e6bc79aed5e436cabdd
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
Diffstat (limited to 'docs/parser_docs/yang2tosca')
-rw-r--r-- | docs/parser_docs/yang2tosca/yang2tosca.rst | 74 |
1 files changed, 53 insertions, 21 deletions
diff --git a/docs/parser_docs/yang2tosca/yang2tosca.rst b/docs/parser_docs/yang2tosca/yang2tosca.rst index 7235fc3..5aaf463 100644 --- a/docs/parser_docs/yang2tosca/yang2tosca.rst +++ b/docs/parser_docs/yang2tosca/yang2tosca.rst @@ -1,9 +1,12 @@ -======================== +.. 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 @@ -12,29 +15,38 @@ templates into certain common templates, which could be used in IaaS orchestrati 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 + +.. 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. - cd pyang - python setup.py + +.. code-block:: bash + + cd pyang + python setup.py 2. python-lxml --------------------- +-------------- -Please follow the below installation link. - http://lxml.de/installation.html +Please follow the below installation link. http://lxml.de/installation.html Installation @@ -43,24 +55,44 @@ Installation Please follow the below installation steps to install parser. Step 1: Clone the parser project. - git clone https://gerrit.opnfv.org/gerrit/parser + +.. code-block:: bash + + git clone https://gerrit.opnfv.org/gerrit/parser Execution =========================== Step 1: Change directory to where the scripts are present. - cd parser/yang2tosca + +.. 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. - python parser.py -n "YANG filename" - Example: - python parser.py -n example.yaml + +.. 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. - cat "YANG filename_tosca.yaml" - Example: - cat example_tosca.yaml + +.. code-block:: bash + + cat "YANG filename_tosca.yaml" + +Example: + +.. code-block:: bash + + cat example_tosca.yaml |