Release D doc update
[parser.git] / docs / developer / design / vRNC_tosca_intro.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 ======================================
5 OPNFV Parser tosca2heat - New Keywords
6 ======================================
7
8 1.NFV-tosca new keywords
9 ------------------------
10
11 All keywords in nfv tosca are not implemented in code, and will be
12 implemented by parser.
13
14 1.1 Nodes types
15 ~~~~~~~~~~~~~~~
16
17 Basic types
18 ^^^^^^^^^^^
19
20 * tosca.nodes.nfv.VDU
21 * tosca.nodes.nfv.CP
22 * tosca.nodes.nfv.VL
23
24 Extend types
25 ^^^^^^^^^^^^
26
27 * tosca.nodes.nfv.VL.ELine
28 * tosca.nodes.nfv.VL.ELAN
29 * tosca.nodes.nfv.VL.ETree
30 * tosca.nodes.nfv.FP
31
32 1.2 Capability types
33 ~~~~~~~~~~~~~~~~~~~~
34
35 Basic types
36 ^^^^^^^^^^^
37
38 * tosca.capabilities.nfv.VirtualBindable
39 * tosca.capabilities.nfv.VirtualLinkable
40 * tosca.capabilities.nfv.HA.ActiveActive
41 * tosca.capabilities.nfv.HA.ActivePassive
42 * tosca.capabilities.nfv.Metric
43
44 Extend types
45 ^^^^^^^^^^^^
46
47 * tosca.capabilities.nfv.Forwarder
48 * tosca.capabilities.nfv.CPU\_extension
49 * tosca.capabilities.nfv.Memory\_extension
50 * tosca.capabilities.nfv.Hypervisors
51 * tosca.capabilities.nfv.PCIe
52 * tosca.capabilities.nfv.network.Interfaces
53 * tosca.capabilities.nfv.network.Virtual\_switches
54 * tosca.capabilities.nfv.Storage
55
56 1.3 Relationship types
57 ~~~~~~~~~~~~~~~~~~~~~~
58
59 Basic types
60 ^^^^^^^^^^^
61
62 * tosca.relationships.nfv.VirtualBindsTo
63 * tosca.relationships.nfv.VirtualLinksTo
64 * tosca.relationships.nfv.HA
65 * tosca.relationships.nfv.Monitor
66
67 Extend types
68 ^^^^^^^^^^^^
69
70 * tosca.relationships.nfv.ForwardsTo
71
72 1.4 Group Types
73 ~~~~~~~~~~~~~~~
74
75 * tosca.groups.nfv.VNFFG
76
77 2.Simple-tosca new keywords
78 ---------------------------
79
80 Some keywords are only defined in tosca simple profile,but are not
81 supported in tosca-paser, and some keywords such as "policy type", are not yet defined
82 completely so far.
83
84 2.1 topology template keyname
85 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
86
87 * "substitution\_mappings" syntax
88
89     An optional declaration that exports the topology template as an
90     impletmentation of a node type, which is not supported by tosca-parser.
91
92 2.2 Group types
93 ~~~~~~~~~~~~~~~
94
95 Basic types
96 ^^^^^^^^^^^
97
98 * tosca.group.root
99
100 2.3 Policy Types
101 ~~~~~~~~~~~~~~~~
102
103 Basic types
104 ^^^^^^^^^^^
105
106 * tosca.policies.Root
107 * tosca.policies.Placement
108 * tosca.policies.Scaling
109
110 Extend types
111 ^^^^^^^^^^^^
112
113 * tosca.policies.Update
114 * tosca.policies.Performance
115 * tosca.policy.placement.Antilocate
116 * tosca.policy.placement.Colocate
117
118
119 =======================================
120 OPNFV Parser tosca2heat - vRNC Topology
121 =======================================
122
123 The simple vRNC topology is shown below: :numref:`figure_topo`
124
125 .. figure:: images/vRNC_Topology.png
126    :name: figure_topo
127    :width: 100%
128
129    vRNC Topology
130
131 -  vRNC includes four networks: EMS\_network, CTRL\_network,
132    Intermedia\_network and extermedia\_network;
133 -  vRNC includes four node types: MM, LB, CM and DM;
134 -  MM: Stands for Maintain Module, which links to EMS\_network,
135    CTRL\_network and extermedia\_network. It composes of active vdu and
136    standby vdu.
137 -  CM: Stands for Control Module, which links to CTRL\_network and
138    intermedia\_network. All CM nodes form resource pool and each node
139    composes of active vdu and standby vdu.
140 -  DM: Stands for Data Module, which links to CTRL\_network and
141    intermedia\_network. All DM nodes form resource pool and each node is
142    a vdu.
143 -  LB: Stands for LineCard Module, which links to CTRL\_network and
144    intermedia\_network and extermedia\_network. All LB nodes form
145    resource pool and each node is a vdu.
146
147 =========================================
148 OPNFV Parser tosca2heat - vRNC Definition
149 =========================================
150
151 The files dependency and correspoding specificaiton of vRNC definition
152 are shown below: :numref:`figure_def`
153
154 .. figure:: images/vRNC_Definition.png
155    :name: figure_def
156    :width: 100%
157
158    vRNC Definition
159
160 -  TOSCA\_definition\_1.0.yaml should be the lastest version, which is
161    updated by tosca-parser community, but some keywords (such as
162    substitution\_mappings) in the correspoding standard of
163    "TOSCA-simple-profile-YAML-v1.0" is not supported.
164 -  TOSCA\_nfv\_definition\_1.0.yaml is a new file, and not implemented
165    in code, and the correspoding standard of
166    "tosca-nfv-v1.0-wd02-rev02" is not complete now.