update parser documentbrahmaputra.1.0

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>
(cherry picked from commit f763149f87564d6dc4e0a605dbe5df720ffe4f9a)

2 files changed, 217 insertions, 0 deletions

diff --git a/docs/parser_docs/yang2tosca/clearwater_tosca.yaml b/docs/parser_docs/yang2tosca/clearwater_tosca.yaml
new file mode 100644
index 0000000..2b4dd52
--- /dev/null
+++ b/docs/parser_docs/yang2tosca/clearwater_tosca.yaml
@@ -0,0 +1,151 @@
+tosca_definitions_version: tosca_simple_yaml_1_0_0
+description: >
+  This module defines a VNF Deployment Unit.
+
+metadata:
+  template_name: clearwater
+  template_author: HP
+
+dsl_definitions:
+  compute_props_host_ellis: &compute_props_host_ellis
+    num_cpu: 4
+    mem_size: 4096
+  compute_props_host_bono: &compute_props_host_bono
+    num_cpu: 3
+    mem_size: 2048
+
+node_types:
+  tosca.nodes.compute.ellis:
+    derived_from: tosca.nodes.compute
+
+  tosca.nodes.compute.bono:
+    derived_from: tosca.nodes.compute
+
+topology_template:
+  # a description of the topology template
+  description: >
+
+
+  inputs:
+   storage_size:
+     type: scalar-unit.size
+     default: 2048 M
+     description: The required storage resource
+
+   storage_location:
+     type: string
+     description: >
+       Block storage mount point (filesystem path).
+
+  node_templates:
+    ellis:
+      type: tosca.nodes.compute.ellis
+      capabilities:
+        host:
+          properties: *compute_props_host_ellis
+        scalable:
+          properties:
+            min_instances: 1
+            default_instances: 1
+      requirements:
+        - local_storage:
+            node: ellis_BlockStorage
+            relationship:
+              type: AttachesTo
+                properties:
+                  location: { get_input: storage_location }
+      interfaces:
+        Standard:
+          start:
+            implementation: start.sh
+          delete:
+            implementaion: stop.sh
+          stop:
+            implementaion: shutdown.sh
+
+    ellis_BlockStorage:
+      type: tosca.nodes.BlockStorage
+      properties:
+        size: { get_input: storage_size }
+
+    bono:
+      type: tosca.nodes.compute.bono
+      capabilities:
+        host:
+          properties: *compute_props_host_bono
+        scalable:
+          properties:
+            min_instances: 3
+            default_instances: 3
+      requirements:
+        - local_storage:
+            node: bono_BlockStorage
+            relationship:
+              type: AttachesTo
+                properties:
+                  location: { get_input: storage_location }
+      interfaces:
+        Standard:
+          start:
+            implementation: start.sh
+          delete:
+            implementaion: stop.sh
+          stop:
+            implementaion: shutdown.sh
+
+    bono_BlockStorage:
+      type: tosca.nodes.BlockStorage
+      properties:
+        size: { get_input: storage_size }
+
+    clearwater_network1:
+      type: tosca.nodes.network.Network
+      properties:
+        ip_version: 4
+
+    ellis_port1:
+      type: tosca.nodes.network.Port
+      requirements:
+        - binding:
+            node: ellis
+        - link:
+            node: clearwater_network1
+
+    clearwater_network2:
+      type: tosca.nodes.network.Network
+      properties:
+        ip_version: 4
+
+    ellis_port2:
+      type: tosca.nodes.network.Port
+      requirements:
+        - binding:
+            node: ellis
+        - link:
+            node: clearwater_network2
+
+    clearwater_network1:
+      type: tosca.nodes.network.Network
+      properties:
+        ip_version: 4
+
+    bono_port1:
+      type: tosca.nodes.network.Port
+      requirements:
+        - binding:
+            node: bono
+        - link:
+            node: clearwater_network1
+
+    clearwater_network2:
+      type: tosca.nodes.network.Network
+      properties:
+        ip_version: 4
+
+    bono_port2:
+      type: tosca.nodes.network.Port
+      requirements:
+        - binding:
+            node: bono
+        - link:
+            node: clearwater_network2
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