summaryrefslogtreecommitdiffstats
path: root/docs/ONAP Model Spec/dm/NodeTypes.rst
blob: 5c8055d3f968063c01c6fe800047d4495e93fa46 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
.. Copyright 2019 (China Mobile)
.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode

Node Types
==========

| **tosca.nodes.nfv.Vdu.Compute:**
|     derived_from: tosca.nodes.Root
|     description:  Describes the virtual compute part of a VDU which is a construct   supporting the description of the deployment and operational behavior of a VNFC 
|     properties:
|       name: 
|         type: string
|         description: Human readable name of the VDU
|         required: true
|     description:
|       type: string
|       description: Human readable description of the VDU 
|       required: true
|     boot_order:
|       type: list # explicit index (boot index) not necessary, contrary to IFA011. 
|       description: References a node template name from which a valid boot device is created 
|       required: false|
|       entry_schema:
|         type: string
|     nfvi_constraints:  
|       type: list
|       description: Describes constraints on the NFVI for the VNFC instance(s) created from this VDU 
|       entry_schema:
|         type: string
|       required: false
|     monitoring_parameters:
|         type: list
|         description: Describes monitoring parameters applicable to a VNFC instantiated from this VDU
|         required: false
|         entry_schema:
|           type: tosca.datatypes.nfv.VnfcMonitoringParameter
|     #configurable_properties: 
|        #type: tosca.datatypes.nfv.VnfcConfigurableProperties
|        #required: false
|        # derived types are expected to introduce
|        # configurable_properties with its type derived from 
|        # tosca.datatypes.nfv.VnfcConfigurableProperties
|     vdu_profile:          
|        type: tosca.datatypes.nfv.VduProfile
|        description: Defines additional instantiation data for the VDU.Compute node 
|        required: true
|     sw_image_data:
|         type: tosca.datatypes.nfv.SwImageData
|         description: Defines information related to a SwImage artifact used by this Vdu.Compute node
|         required: false # property is required when the node template has an associated artifact of type tosca.artifacts.nfv.SwImage and not required otherwise
|     boot_data: 
|       type: string
|       description: Contains a string or a URL to a file contained in the VNF package used to customize a virtualised compute resource at boot time. The bootData may contain variable parts that are replaced by deployment specific values before being sent to the VIM. 
|       required: false
|     #inject_files: #Introduced from Beijing release, used for vCPE usecase, outside the scope of SOL001 v2.5.1
|       #  type: tosca.datatypes.nfv.injectFile
|       # required: false  #Aligned with ONAP R2 IM. it should be false.
|     #meta_data: #Introduced from Beijing release, used for metadata attached to the VM or container, outside the scope of SOL001 v2.5.1
|       # type: map 
|       # entry_schema:
|         # type: string 
|       # required: false 
|   capabilities:
|     virtual_compute: 
|       type: tosca.capabilities.nfv.VirtualCompute
|       occurrences: [ 1, 1 ]
|     virtual_binding: 
|       type: tosca.capabilities.nfv.VirtualBindable
|       occurrences: [1, UNBOUND]
|   requirements:
|     - virtual_storage:
|         capability: tosca.capabilities.nfv.VirtualStorage
|         relationship: tosca.relationships.nfv.Vdu.AttachedTo
|         occurences: [ 0, UNBOUNDED ]
| 
| 
| **tosca.nodes.nfv.Vdu.VirtualBlockStorage:** 
|     derived_from: tosca.nodes.Root
|     description: This node type describes the specifications of requirements related to virtual block storage resources
|     properties:
|       virtual_block_storage_data:
|         type: tosca.datatypes.nfv.VirtualBlockStorageData
|         description: Describes the block storage characteristics.
|         required: true
|       sw_image_data:
|         type: tosca.datatypes.nfv.SwImageData
|         description: Defines information related to a SwImage artifact used by this Vdu.Compute node.
|         required: false # property is required when the node template has an associated artifact of type tosca.artifacts.nfv.SwImage and not required otherwise 
|     capabilities:
|       virtual_storage:
|         type: tosca.capabilities.nfv.VirtualStorage
|         description: Defines the capabilities of virtual_storage.
| 
| 
| **tosca.nodes.nfv.Vdu.VirtualObjectStorage:**
|     derived_from: tosca.nodes.Root
|     description: This node type describes the specifications of requirements related to virtual object storage resources
|     properties:
|       virtual_object_storage_data:
|         type: tosca.datatypes.nfv.VirtualObjectStorageData
|         description: Describes the object  storage characteristics.
|         required: true
|     capabilities:
|       virtual_storage:
|         type: tosca.capabilities.nfv.VirtualStorage
|         description: Defines the capabilities of virtual_storage.
|
|
| **tosca.nodes.nfv.Vdu.VirtualFileStorage:** 
|     derived_from: tosca.nodes.Root
|     description: This node type describes the specifications of requirements related to virtual file storage resources
|     properties:
|       virtual_file_storage_data:
|         type: tosca.datatypes.nfv.VirtualFileStorageData
|         description: Describes the file  storage characteristics.
|         required: true
|     capabilities:
|       virtual_storage:
|         type: tosca.capabilities.nfv.VirtualStorage
|         description: Defines the capabilities of virtual_storage.
|     requirements:
|       - virtual_link:
|           capability: tosca.capabilities.nfv.VirtualLinkable
|           relationship: tosca.relationships.nfv.VirtualLinksTo
|           #description: Describes the requirements for linking to virtual link
|
|
| **tosca.nodes.nfv.Cp:**
|     derived_from: tosca.nodes.Root 
|     description:  Provides information regarding the purpose of the connection point 
|     properties:
|       layer_protocol:
|         type:list
|         description: Identifies which protocol the connection point uses for connectivity purposes 
|         entry_schema:
|           constraints:
|            - valid_values: [ethernet, mpls, odu2, ipv4, ipv6, pseudo_wire ]
|         required:true
|       role: #Name in ETSI NFV IFA011 v0.7.3 cpRole
|         type:string
|         description: Identifies the role of the port in the context of the traffic flow patterns in the VNF or parent NS 
|         constraints:
|           - valid_values: [ root, leaf ]
|         required:false
|       description:
|         type: string
|         description: Provides human-readable information on the purpose of the connection point 
|         required: false
|       protocol:
|         type: list
|         description: Provides information on the addresses to be assigned to the connection point(s) instantiated from this Connection Point Descriptor 
|         entry_schema:
|           type: tosca.datatypes.nfv.CpProtocolData
|         required:false
|       trunk_mode:
|         type: boolean
|         description: Provides information about whether the CP instantiated from this Cp is in Trunk mode (802.1Q or other), When operating in "trunk mode", the Cp is capable of carrying traffic for several VLANs. Absence of this property implies that trunkMode is not configured for the Cp i.e. It is equivalent to boolean value "false". 
|         required: false
|       #allowed_address_data: # Introduced from Beijing release, align with resource IM, outside the scope of SOL001 v2.5.1                        
|         type: tosca.datatypes.nfv.AddressData   # In the IM, it is a array, but here it is not a array. TBD.
|         required: false
| 
| 
| **tosca.nodes.nfv.VduCp:**
|     derived_from: tosca.nodes.nfv.Cp
|     description: describes network connectivity between a VNFC instance based on this VDU and an internal VL 
|     properties:
|       bitrate_requirement:
|         type: integer  # in bits per second
|         description: Bitrate requirement in bit per second on this connection point 
|         required:false
|         constraints:
|           - greater_or_equal: 0
|       virtual_network_interface_requirements: 
|         type: list
|         description: Specifies requirements on a virtual network interface realising the CPs instantiated from this CPD  
|         entry_schema:
|           type: tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements
|         required:false
|       order:      
|         type: integer
|         description: The order of the NIC on the compute instance (e.g.eth2)
|         required: false
|         constraints:
|           - greater_or_equal: 0
|       vnic_type:
|         type: string
|         description: Describes the type of the virtual network interface realizing the CPs instantiated from this CPD
|         required: false
|         constraints:
|           - valid_values: [ normal, virtio, direct-physical ] 
|       #vnic_name: # Introduced from Beijing release, aligned with ONAP resource IM, outside the scope of SOL001 v2.5.1
|       #  type: string
|       #  required:false    
|       requirements:
|           - virtual_link:
|             capability: tosca.capabilities.nfv.VirtualLinkable
|             relationship: tosca.relationships.nfv.VirtualLinksTo
|           - virtual_binding:
|             capability: tosca.capabilities.nfv.VirtualBindable
|             relationship: tosca.relationships.nfv.VirtualBindsTo
|             node: tosca.nodes.nfv.Vdu.Compute
| 
|
| **tosca.nodes.nfv.VnfExtCp:
|     derived_from: tosca.nodes.nfv.Cp
|     description: Describes a logical external connection point, exposed by the VNF enabling connection with an external Virtual Link
|     properties:
|       virtual_network_interface_requirements:
|         type: list
|         description: The actual virtual NIC requirements that is been assigned when instantiating the connection point
|         required: false
|         entry_schema:
|           type: tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements
|     requirements:
|       - external_virtual_link:
|           capability: tosca.capabilities.nfv.VirtualLinkable
|           relationship: tosca.relationships.nfv.VirtualLinksTo
|       - internal_virtual_link: #name in ETSI NFV IFA011 v0.7.3: intVirtualLinkDesc
|           capability: tosca.capabilities.nfv.VirtualLinkable
|           relationship: tosca.relationships.nfv.VirtualLinksTo
| 
| **tosca.nodes.nfv.VnfVirtualLink:**
|     derived_from: tosca.nodes.Root
|     description: Describes the information about an internal VNF VL 
|     properties:
|       connectivity_type:
|         type: tosca.datatypes.nfv.ConnectivityType
|         description: Specifies the protocol exposed by the VL and the flow pattern supported by the VL 
|         required: true
|       description:
|         type: string
|         description: Provides human-readable information on the purpose of the VL 
|         required: false
|       test_access:
|         type: list
|         description: Test access facilities available on the VL 
|         entry_schema:
|           type: string
|         required: false
|       vl_profile:
|         type: tosca.datatypes.nfv.VlProfile
|         description: Defines additional data for the VL 
|         required: true
|       monitoring_parameters:
|         type: list
|         description: Describes monitoring parameters applicable to the VL
|         required: false
|         entry_schema:
|           type: tosca.datatypes.nfv.VirtualLinkMonitoringParameter
|     capabilities:
|       virtual_linkable:
|         type: tosca.capabilities.nfv.VirtualLinkable
| 
| 
| **tosca.nodes.nfv.VNF:**
|     derived_from: tosca.nodes.Root
|     description: The generic abstract type from which all VNF specific abstract node types shall be derived to form, together with other node types, the TOSCA service template(s) representing the VNFD
|     properties: 
|       descriptor_id: # instead of vnfd_id
|         type: string # GUID
|         description: Globally unique identifier of the VNFD
|         required: true
|       descriptor_version: # instead of vnfd_version
|         type: string
|         description: Identifies the version of the VNFD
|         required: true
|       provider: # instead of vnf_provider
|         type: string
|         description: Provider of the VNF and of the VNFD
|         required: true
|       product_name: # instead of vnf_product_name
|         type: string
|         description: Human readable name for the VNF Product
|         required: true
|       software_version: # instead of vnf_software_version
|         type: string
|         description: Software version of the VNF
|         required: true
|       product_info_name: # instead of vnf_product_info_name
|         type: string
|         description: Human readable name for the VNF Product 
|         required: false
|       product_info_description: # instead of vnf_product_info_description
|         type: string
|         description: Human readable description of the VNF Product
|         required: false
|       vnfm_info:
|         type: list
|         description: Identifies VNFM(s) compatible with the VNF
|         entry_schema:
|           type: string
|         required: true
|       localization_languages:
|         type: list
|         description: Information about localization languages of the VNF
|         entry_schema:
|           type: string#IETF RFC 5646 string
|         required: false
|       default_localization_language:
|         type: string #IETF RFC 5646 string
|         description: Default localization language that is instantiated if no information about selected localization language is available 
|         required: false
|       #configurable_properties:
|         #type: tosca.datatypes.nfv.VnfConfigurableProperties
|         #description: Describes the configurable properties of the VNF
|         #required: false
|         # derived types are expected to introduce configurable_properties 
|         # with its type derived from
|         # tosca.datatypes.nfv.VnfConfigurableProperties 
|       #modifiable_attributes:
|         #type: tosca.datatypes.nfv.VnfInfoModifiableAttributes
|         #description: Describes the modifiable attributes of the VNF|       
|         #required: false  
|         # derived types are expected to introduce modifiable_attributes
|         # with its type derived from
|         # tosca.datatypes.nfv.VnfInfoModifiableAttributes
|       lcm_operations_configuration:
|         type: tosca.datatypes.nfv.VnfLcmOperationsConfiguration
|         description: Describes the configuration parameters for the VNF LCM operations
|         required: false
|       monitoring_parameters:
|         type: list
|         entry_schema:
|           type: tosca.datatypes.nfv.VnfMonitoringParameter
|         description: Describes monitoring parameters applicable to the VNF.
|         required: false  
|       flavour_id:
|         type: string
|         description: Identifier of the Deployment Flavour within the VNFD
|         required: true  
|       flavour_description:
|         type: string
|         description: Human readable description of the DF
|         required: true
|       #vnf_profile:
|         #  type: tosca.datatypes.nfv.VnfProfile
|         #  description: Describes a profile for instantiating VNFs of a particular NS DF according to a specific VNFD and VNF DF
|         #  required: false   
|     requirements:
|       - virtual_link:
|           capability: tosca.capabilities.nfv.VirtualLinkable
|           relationship: tosca.relationships.nfv.VirtualLinksTo
|           occurrences: [ 0, 1 ]
|   # Additional requirements shall be defined in the VNF specific node type (deriving from tosca.nodes.nfv.VNF) corresponding to NS virtual links that need to connect to VnfExtCps 
|     interfaces:
|       Vnflcm:
|         type: tosca.interfaces.nfv.Vnflcm
|