diff options
author | zhipengh <huangzhipeng@huawei.com> | 2017-03-02 11:51:07 +0800 |
---|---|---|
committer | zhipengh <huangzhipeng@huawei.com> | 2017-03-02 12:05:07 +0800 |
commit | 53b22cfb7ad8b323073213e4e55584261dd4e50a (patch) | |
tree | fc8c6bed95c2dc66cb812b7023bafdbd2799d3a6 /docs/developer/design/yang2tosca.rst | |
parent | 9a2b86ff190a16822ec3f68b2c1d070d54a47da9 (diff) |
Danube Release Docs Fixup patch 1
Done in this patch
1. Fixes in overview.rst
2. Moves governance folder under docs
3. Adds arno release use case doc from
https://wiki.opnfv.org/display/parser/Parser+Use+Cases to the
requirement folder
4. Moves two old tosca2heat documents into developer/design/examples
5. Adds new empty tosca2heat and verigraph design document under
developer/design.
6. Remove old contents in yang2tosca and policy2tosca design docs since
they are all related to installation/execution, not design.
7. Fixes in installation.instruction.rst and usage,guide.rst
To do in the following patches
1. Design doc writeup: Xiaodong(tosca2heat),
Shiva(yang2tosca/policy2tosca), Serena(verigraph)
2. Release doc writeup: Xiaodong and Howard
(postinstall.rst,scenario.description.rst), Serena(verigraph part of
release-notes.rst), release-notes.rst
Change-Id: If4f51067dd33acd2332e503ee31d6941b4df4c89
Signed-off-by: zhipengh <huangzhipeng@huawei.com>
Diffstat (limited to 'docs/developer/design/yang2tosca.rst')
-rw-r--r-- | docs/developer/design/yang2tosca.rst | 93 |
1 files changed, 1 insertions, 92 deletions
diff --git a/docs/developer/design/yang2tosca.rst b/docs/developer/design/yang2tosca.rst index 5aaf463..61d31b2 100644 --- a/docs/developer/design/yang2tosca.rst +++ b/docs/developer/design/yang2tosca.rst @@ -2,97 +2,6 @@ .. http://creativecommons.org/licenses/by/4.0 ================= -Parser YANG2TOSCA +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 |