docs/ONAP release 2 spec/im/vnfd.rst


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

.. Copyright 2018 (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

Class: Vnfd
===========

+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| **Attribute  Name**         | **Type**                    | **Multiplicity** | **Description**     | **Applied Stereotypes**                              |
+=============================+=============================+==================+=====================+======================================================+
| vnfdId                      | Identifier                  | 1                | Identifier          | support:                                             |
|                             |                             |                  | of this             | MANDATORY                                            |
|                             |                             |                  | VNFD                |                                                      |
|                             |                             |                  | information         |                                                      |
|                             |                             |                  | element.            |                                                      |
|                             |                             |                  | This                |                                                      |
|                             |                             |                  | attribute           |                                                      |
|                             |                             |                  | shall be            |                                                      |
|                             |                             |                  | globally            |                                                      |
|                             |                             |                  | unique.             |                                                      |
|                             |                             |                  |                     |                                                      |
|                             |                             |                  | NOTE: The           |                                                      |
|                             |                             |                  | VNFD                |                                                      |
|                             |                             |                  | Identifier          |                                                      |
|                             |                             |                  | shall be            |                                                      |
|                             |                             |                  | used as the         |                                                      |
|                             |                             |                  | unique              |                                                      |
|                             |                             |                  | identifier          |                                                      |
|                             |                             |                  | of the VNF          |                                                      |
|                             |                             |                  | Package             |                                                      |
|                             |                             |                  | that                |                                                      |
|                             |                             |                  | contains            |                                                      |
|                             |                             |                  | this VNFD.          |                                                      |
|                             |                             |                  |                     |                                                      |
|                             |                             |                  | Any                 |                                                      |
|                             |                             |                  | modification        |                                                      |
|                             |                             |                  | of the              |                                                      |
|                             |                             |                  | content of          |                                                      |
|                             |                             |                  | the VNFD or         |                                                      |
|                             |                             |                  | the VNF             |                                                      |
|                             |                             |                  | Package             |                                                      |
|                             |                             |                  | shall               |                                                      |
|                             |                             |                  | result in a         |                                                      |
|                             |                             |                  | new VNFD            |                                                      |
|                             |                             |                  | Identifier.         |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| vnfProvider                 | String                      | 1                | Provider of         | support:                                             |
|                             |                             |                  | the VNF and         | MANDATORY                                            |
|                             |                             |                  | of the              |                                                      |
|                             |                             |                  | VNFD.               |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| vnfProductName              | String                      | 1                | Name to             | support:                                             |
|                             |                             |                  | identify            | MANDATORY                                            |
|                             |                             |                  | the VNF             |                                                      |
|                             |                             |                  | Product.            |                                                      |
|                             |                             |                  | Invariant           |                                                      |
|                             |                             |                  | for the VNF         |                                                      |
|                             |                             |                  | Product             |                                                      |
|                             |                             |                  | lifetime.           |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| vnfSoftwareVersion          | String                      | 1                | Software            | support:                                             |
|                             |                             |                  | version of          | MANDATORY                                            |
|                             |                             |                  | the VNF.            |                                                      |
|                             |                             |                  | This is             |                                                      |
|                             |                             |                  | changed             |                                                      |
|                             |                             |                  | when there          |                                                      |
|                             |                             |                  | is any              |                                                      |
|                             |                             |                  | change to           |                                                      |
|                             |                             |                  | the                 |                                                      |
|                             |                             |                  | software            |                                                      |
|                             |                             |                  | that is             |                                                      |
|                             |                             |                  | included in         |                                                      |
|                             |                             |                  | the VNF             |                                                      |
|                             |                             |                  | Package.            |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| vnfdVersion                 | String                      | 1                | Identifies          | support:                                             |
|                             |                             |                  | the version         | MANDATORY                                            |
|                             |                             |                  | of the              |                                                      |
|                             |                             |                  | VNFD.               |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| vnfProductInfoName          | String                      | 0..1             | Human               | support:                                             |
|                             |                             |                  | readable            | MANDATORY                                            |
|                             |                             |                  | name for            |                                                      |
|                             |                             |                  | the VNF             |                                                      |
|                             |                             |                  | Product.            |                                                      |
|                             |                             |                  | Can change          |                                                      |
|                             |                             |                  | during the          |                                                      |
|                             |                             |                  | VNF Product         |                                                      |
|                             |                             |                  | lifetime.           |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| vnfProductInfoDescription   | String                      | 0..1             | Human               | support:                                             |
|                             |                             |                  | readable            | MANDATORY                                            |
|                             |                             |                  | description         |                                                      |
|                             |                             |                  | of the VNF          |                                                      |
|                             |                             |                  | Product.            |                                                      |
|                             |                             |                  | Can change          |                                                      |
|                             |                             |                  | during the          |                                                      |
|                             |                             |                  | VNF Product         |                                                      |
|                             |                             |                  | lifetime.           |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| vnfmInfo                    | String                      | 0..N             | Identifies          | support:                                             |
|                             |                             |                  | VNFM(s)             | MANDATORY                                            |
|                             |                             |                  | compatible          |                                                      |
|                             |                             |                  | with the            | valueRange:                                          |
|                             |                             |                  | VNF                 | use the                                              |
|                             |                             |                  | described           | name of                                              |
|                             |                             |                  | in this             | micro-service                                        |
|                             |                             |                  | version of          | of the vnfm                                          |
|                             |                             |                  | the VNFD.           | drive. For                                           |
|                             |                             |                  |                     | vendor                                               |
|                             |                             |                  |                     | specific                                             |
|                             |                             |                  |                     | VNFM, the                                            |
|                             |                             |                  |                     | value                                                |
|                             |                             |                  |                     | composes of                                          |
|                             |                             |                  |                     | "vendorname"                                         |
|                             |                             |                  |                     | and                                                  |
|                             |                             |                  |                     | "vnfmdriver",                                        |
|                             |                             |                  |                     | e.g.                                                 |
|                             |                             |                  |                     | "mycompanyvnfmdriver";                               |
|                             |                             |                  |                     | for generic                                          |
|                             |                             |                  |                     | VNFM, the                                            |
|                             |                             |                  |                     | value is                                             |
|                             |                             |                  |                     | "gvnfmdriver".                                       |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| localizationLanguage        | String                      | 0..N             | Information         | support:                                             |
|                             |                             |                  | about               | MANDATORY                                            |
|                             |                             |                  | localization        |                                                      |
|                             |                             |                  | languages           | valueRange:                                          |
|                             |                             |                  |                     | refer to                                             |
|                             |                             |                  | of the VNF          | ISO936 \                                             |
|                             |                             |                  | (includes           | `https://www.iso.org/iso-639-language-codes.html     |
|                             |                             |                  | e.g.                | <https://www.iso.org/iso-639-language-codes.html>`__ |
|                             |                             |                  | strings in          |                                                      |
|                             |                             |                  | the VNFD).          |                                                      |
|                             |                             |                  |                     |                                                      |
|                             |                             |                  | NOTE: This          |                                                      |
|                             |                             |                  | allows to           |                                                      |
|                             |                             |                  | provide one         |                                                      |
|                             |                             |                  | or more             |                                                      |
|                             |                             |                  | localizatio         |                                                      |
|                             |                             |                  | n                   |                                                      |
|                             |                             |                  | languages           |                                                      |
|                             |                             |                  | to support          |                                                      |
|                             |                             |                  | selecting a         |                                                      |
|                             |                             |                  | specific            |                                                      |
|                             |                             |                  | localizatio         |                                                      |
|                             |                             |                  | n                   |                                                      |
|                             |                             |                  | language at         |                                                      |
|                             |                             |                  | VNF                 |                                                      |
|                             |                             |                  | instantiati         |                                                      |
|                             |                             |                  | on                  |                                                      |
|                             |                             |                  | time.               |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| defaultLocalizationLanguage | String                      | 0..1             | Default             | support:                                             |
|                             |                             |                  | localization        | MANDATORY                                            |
|                             |                             |                  | language            |                                                      |
|                             |                             |                  | that is             | valueRange:                                          |
|                             |                             |                  | instantiated        | refer to                                             |
|                             |                             |                  | if no               | ISO936 \                                             |
|                             |                             |                  | information         | `https://www.iso.org/iso-639-language-codes.html     |
|                             |                             |                  | about               | <https://www.iso.org/iso-639-language-codes.html>`__ |
|                             |                             |                  | selected            |                                                      |
|                             |                             |                  | localization        | condition:                                           |
|                             |                             |                  | language is         | Shall be                                             |
|                             |                             |                  | available.          | present if                                           |
|                             |                             |                  |                     | "localizationLanguage"                               |
|                             |                             |                  |                     | is present                                           |
|                             |                             |                  |                     | and shall                                            |
|                             |                             |                  |                     | be absent                                            |
|                             |                             |                  |                     | otherwise.                                           |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| vdu                         | Vdu                         | 1..N             | Virtualisation      | support:                                             |
|                             |                             |                  | Deployment          | MANDATORY                                            |
|                             |                             |                  | Unit.               |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| virtualComputeDesc          | VirtualComputeDesc          | 1..N             | Defines             | support:                                             |
|                             |                             |                  | descriptors         | MANDATORY                                            |
|                             |                             |                  | of virtual          |                                                      |
|                             |                             |                  | compute             |                                                      |
|                             |                             |                  | resources           |                                                      |
|                             |                             |                  | to be used          |                                                      |
|                             |                             |                  | by the VNF.         |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| virtualStorageDesc          | VirtualStorageDesc          | 0..N             | Defines             | support:                                             |
|                             |                             |                  | descriptors         | MANDATORY                                            |
|                             |                             |                  | of virtual          |                                                      |
|                             |                             |                  | storage             |                                                      |
|                             |                             |                  | resources           |                                                      |
|                             |                             |                  | to be used          |                                                      |
|                             |                             |                  | by the VNF.         |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| intVirtualLinkDesc          | VirtualLinkDesc             | 0..N             | Represents          | support:                                             |
|                             |                             |                  | the type of         | MANDATORY                                            |
|                             |                             |                  | network             |                                                      |
|                             |                             |                  | connectivity        |                                                      |
|                             |                             |                  | mandated by         |                                                      |
|                             |                             |                  | the VNF             |                                                      |
|                             |                             |                  | provider            |                                                      |
|                             |                             |                  | between two         |                                                      |
|                             |                             |                  | or more CPs         |                                                      |
|                             |                             |                  | which               |                                                      |
|                             |                             |                  | includes at         |                                                      |
|                             |                             |                  | least one           |                                                      |
|                             |                             |                  | internal            |                                                      |
|                             |                             |                  | CP.                 |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| vnfReservedCpd              | VduCpd                      | 0..N             | Reserved IP         | support:                                             |
|                             |                             |                  | Address for         | MANDATORY                                            |
|                             |                             |                  | VNF which           |                                                      |
|                             |                             |                  | is not              |                                                      |
|                             |                             |                  | bounded to          |                                                      |
|                             |                             |                  | any                 |                                                      |
|                             |                             |                  | specific            |                                                      |
|                             |                             |                  | VNFC, but           |                                                      |
|                             |                             |                  | assigned            |                                                      |
|                             |                             |                  | manually            |                                                      |
|                             |                             |                  | from                |                                                      |
|                             |                             |                  | outside and         |                                                      |
|                             |                             |                  | potentially         |                                                      |
|                             |                             |                  | shared as a         |                                                      |
|                             |                             |                  | floating IP         |                                                      |
|                             |                             |                  | among               |                                                      |
|                             |                             |                  | VNFCs.              |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| vnfExtCpd                   | VnfExtCpd                   | 1..N             | Describes           | support:                                             |
|                             |                             |                  | external            | MANDATORY                                            |
|                             |                             |                  | interface(s)        |                                                      |
|                             |                             |                  | exposed by          |                                                      |
|                             |                             |                  | this VNF            |                                                      |
|                             |                             |                  | enabling            |                                                      |
|                             |                             |                  | connection          |                                                      |
|                             |                             |                  | with a VL.          |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| deploymentFlavour           | VnfDf                       | 1..N             | Describes           | support:                                             |
|                             |                             |                  | specific            | MANDATORY                                            |
|                             |                             |                  | DF(s) of a          |                                                      |
|                             |                             |                  | VNF with            |                                                      |
|                             |                             |                  | specific            |                                                      |
|                             |                             |                  | requirements        |                                                      |
|                             |                             |                  | for                 |                                                      |
|                             |                             |                  | capacity            |                                                      |
|                             |                             |                  | and                 |                                                      |
|                             |                             |                  | performance.        |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| configurableProperties      | VnfConfigurableProperties   | 0..1             | Describes           | support:                                             |
|                             |                             |                  | the                 | MANDATORY                                            |
|                             |                             |                  | configurable        |                                                      |
|                             |                             |                  | properties          |                                                      |
|                             |                             |                  | of the VNF          |                                                      |
|                             |                             |                  | (e.g.               |                                                      |
|                             |                             |                  | related to          |                                                      |
|                             |                             |                  | auto                |                                                      |
|                             |                             |                  | scaling and         |                                                      |
|                             |                             |                  | auto                |                                                      |
|                             |                             |                  | healing).           |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| modifiableAttributes        | VnfInfoModifiableAttributes | 0..1             | Describes           | support:                                             |
|                             |                             |                  | the                 | MANDATORY                                            |
|                             |                             |                  | modifiable          |                                                      |
|                             |                             |                  | attributes          |                                                      |
|                             |                             |                  | of the VNF.         |                                                      |
|                             |                             |                  |                     |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| lifeCycleManagementScript   | LifeCycleManagementScript   | 0..N             | Includes a          | support:                                             |
|                             |                             |                  | list of             | MANDATORY                                            |
|                             |                             |                  | events and          |                                                      |
|                             |                             |                  | corresponding       |                                                      |
|                             |                             |                  | management          |                                                      |
|                             |                             |                  | scripts             |                                                      |
|                             |                             |                  | performed           |                                                      |
|                             |                             |                  | for the             |                                                      |
|                             |                             |                  | VNF.                |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| elementGroup                | VnfdElementGroup            | 0..N             | Describes           | support:                                             |
|                             |                             |                  | the                 | MANDATORY                                            |
|                             |                             |                  | associated          |                                                      |
|                             |                             |                  | elements of         |                                                      |
|                             |                             |                  | a VNFD for          |                                                      |
|                             |                             |                  | a certain           |                                                      |
|                             |                             |                  | purpose             |                                                      |
|                             |                             |                  | during VNF          |                                                      |
|                             |                             |                  | lifecycle           |                                                      |
|                             |                             |                  | management.         |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| vnfIndicator                | VnfIndicator                | 0..N             | Declares            | support:                                             |
|                             |                             |                  | the VNF             | MANDATORY                                            |
|                             |                             |                  | indicators          |                                                      |
|                             |                             |                  | that are            |                                                      |
|                             |                             |                  | supported           |                                                      |
|                             |                             |                  | by this             |                                                      |
|                             |                             |                  | VNF.                |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| logo                        | String                      | 0..1             | File path           | support:                                             |
|                             |                             |                  | of the              | MANDATORY                                            |
|                             |                             |                  | vendor              |                                                      |
|                             |                             |                  | specified           |                                                      |
|                             |                             |                  | logo.               |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+
| guide                       | String                      | 0..1             | UUID of the         | support:                                             |
|                             |                             |                  | vendor              | MANDATORY                                            |
|                             |                             |                  | guide/documentation |                                                      |
|                             |                             |                  | which is            |                                                      |
|                             |                             |                  | attached to         |                                                      |
|                             |                             |                  | VNF and can         |                                                      |
|                             |                             |                  | be                  |                                                      |
|                             |                             |                  | downloaded          |                                                      |
|                             |                             |                  | from the            |                                                      |
|                             |                             |                  | model.              |                                                      |
+-----------------------------+-----------------------------+------------------+---------------------+------------------------------------------------------+