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>

1 files changed, 264 insertions, 0 deletions

diff --git a/docs/parser_docs/tosca2heat/examples/Simple_RNC_definition.yaml b/docs/parser_docs/tosca2heat/examples/Simple_RNC_definition.yaml
new file mode 100644
index 0000000..921da0d
--- /dev/null
+++ b/docs/parser_docs/tosca2heat/examples/Simple_RNC_definition.yaml
@@ -0,0 +1,264 @@
+# Required TOSCA Definitions version string
+tosca_definitions_version: tosca_simple_yaml_1_0
+
+metadata:
+  template_name: tosca_simple_profile_for_nfv
+  template_author: opnfv_parser_project
+  template_version: tosca_simple_profile_for_nfv_1_0
+
+# Optional description of the definitions inside the file.
+description: >
+  NFV TOSCA simple profile for RNC types
+    1, Compute Node MM, CM, DM, LB...
+       1.1 MM: MaintainModule;
+       1.2 CM: Control Module;
+       1.3 DM: Data Module;
+       1.4 LB: LineCard Module
+    2, Network Node VL and CP
+
+imports:
+  - TOSCA_nfv_definition_1_0.yaml
+
+# list of node type definitions
+node_types:
+  rnc.nodes.VNF:
+    derived_from: tosca.nodes.nfv.VNF
+    properties:
+      vnftype:
+        type: string
+        description: type of the vnf
+        default:  UMTS
+        required: false
+        constraints:
+          - valid_values: [ TD, UMTS ]
+    requirements:
+      - virtualLink_VNFM:
+          capability: tosca.capabilities.nfv.VirtualLinkable
+      - virtualLink_EMS:
+          capability: tosca.capabilities.nfv.VirtualLinkable
+      - virtualLink_TRAFFIC:
+          capability: tosca.capabilities.nfv.VirtualLinkable
+          
+  rnc.nodes.compute.MM:
+    derived_from: tosca.nodes.nfv.VDU
+    properties:
+      activestatus:
+        type: integer
+        description: active or passive
+        constraints:
+            # 1 active, 0 passive
+            - valid_values: [ 0, 1 ]
+      id:
+        type: string
+        defaule: MM
+        description: >
+          A identifier of this VDU within the scope of the VNFD,
+          including version functional description and other
+          identification information.
+    requirements:
+      - host:
+          capability: tosca.capabilities.Container
+          node: rnc.nodes.compute.MM_Host
+          relationship: tosca.relationships.HostedOn
+          
+  rnc.nodes.compute.MM_Host:
+    derived_from: tosca.nodes.Compute
+    capabilities:
+      binding:
+         type: tosca.capabilities.network.Bindable
+      os:
+         type: tosca.capabilities.OperatingSystem
+      scalable:
+         type: tosca.capabilities.Scalable
+      host:
+        type: rnc.capabilities.Container
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+      storage:
+        type: tosca.capabilities.nfv.Storage
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+    attributes:
+      ip_address:
+        type: string
+
+  rnc.nodes.compute.CM:
+    derived_from: tosca.nodes.nfv.VDU
+    properties:
+      activestatus:
+        type: integer
+        description: 1 for active or 0 for passive
+        constraints:
+           # 1 active, 0 passive
+           - valid_values: [ 0, 1 ]
+    requirements:
+      - host:
+          capability: tosca.capabilities.Container
+          node: rnc.nodes.compute.CM_Host
+          relationship: tosca.relationships.HostedOn
+          
+  rnc.nodes.compute.CM_Host:
+    derived_from: tosca.nodes.Compute
+    capabilities:
+      binding:
+         type: tosca.capabilities.network.Bindable
+      os:
+         type: tosca.capabilities.OperatingSystem
+      scalable:
+         type: tosca.capabilities.Scalable
+      host:
+        type: rnc.capabilities.Container
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+      cpu_extension:
+        type: tosca.capabilities.nfv.CPU_extension
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+      memory_extension:
+        type: tosca.capabilities.nfv.Memory_extension
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+      hypervisors:
+        type: tosca.capabilities.nfv.Hypervisors
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+      PCIe:
+        type: tosca.capabilities.nfv.PCIe
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+      interfaces:
+        type: tosca.capabilities.nfv.network.Interfaces
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+      virtual_switches:
+        type: tosca.capabilities.nfv.network.Virtual_switches
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+    attributes:
+      ip_address:
+        type: string
+
+  rnc.nodes.compute.DM:
+    derived_from: tosca.nodes.nfv.VDU
+    requirements:
+      - host:
+          capability: tosca.capabilities.Container
+          node: rnc.nodes.compute.DM_Host
+          relationship: tosca.relationships.HostedOn
+
+  rnc.nodes.compute.DM_Host:
+    derived_from: tosca.nodes.Compute
+    capabilities:
+      binding:
+         type: tosca.capabilities.network.Bindable
+      os:
+         type: tosca.capabilities.OperatingSystem
+      scalable:
+         type: tosca.capabilities.Scalable
+      host:
+        type: rnc.capabilities.Container
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+      cpu_extension:
+        type: tosca.capabilities.nfv.CPU_extension
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+      memory_extension:
+        type: tosca.capabilities.nfv.Memory_extension
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+      hypervisors:
+        type: tosca.capabilities.nfv.Hypervisors
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+      PCIe:
+        type: tosca.capabilities.nfv.PCIe
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+      interfaces:
+        type: tosca.capabilities.nfv.network.Interfaces
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+      virtual_switches:
+        type: tosca.capabilities.nfv.network.Virtual_switches
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+    attributes:
+      ip_address:
+        type: string
+
+  rnc.nodes.compute.LB:
+    derived_from: tosca.nodes.nfv.VDU
+    requirements:
+      - host:
+          capability: tosca.capabilities.Container
+          node: rnc.nodes.compute.LB_Host
+          relationship: tosca.relationships.HostedOn
+
+  rnc.nodes.compute.LB_Host:
+    derived_from: tosca.nodes.Compute
+    capabilities:
+      binding:
+         type: tosca.capabilities.network.Bindable
+      os:
+         type: tosca.capabilities.OperatingSystem
+      scalable:
+         type: tosca.capabilities.Scalable
+      host:
+        type: rnc.capabilities.Container
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+      interfaces:
+        type: tosca.capabilities.nfv.network.Interfaces
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+      virtual_switches:
+        type: tosca.capabilities.nfv.network.Virtual_switches
+        valid_source_types: [ tosca.nodes.SoftwareComponent ]
+    attributes:
+      ip_address:
+        type: string
+
+  rnc.nodes.BlockStorage:
+    derived_from: tosca.nodes.BlockStorage
+
+  rnc.nodes.VL:
+    derived_from: tosca.nodes.nfv.VL.ELAN
+    properties:
+      ip_version:
+        type: integer
+        required: false
+        default: 4
+        constraints:
+            - valid_values: [ 4, 6 ]
+      cidr:
+        type: string
+        required: false
+      network_name:
+        type: string
+        required: false
+      dhcp_enabled:
+        type: boolean
+        required: false
+        default: true
+        description: >
+          Indicates should DHCP service be enabled on the network or not.
+
+  rnc.nodes.CP:
+    derived_from: tosca.nodes.nfv.CP
+    properties:
+      ip_address:
+        type: string
+        required: false
+      order:
+        type: integer
+        required: true
+        default: 0
+        constraints:
+          - greater_or_equal: 0
+      is_default:
+        type: boolean
+        required: false
+        default: false
+
+# list of capability type definitions
+capability_types:
+  rnc.capabilities.Container:
+    derived_from: tosca.capabilities.Container
+    properties:
+      swap:
+        type: scalar-unit.size
+        description: swap info
+        required: false
+        default: 0
+        constraints:
+            - greater_or_equal: 0 MB
+      iops:
+        type: integer
+        description: IOPS for disk
+        required: false
+        default: 0
+        constraints:
+          - greater_than: 0