Newer
Older
rameshnaraya
committed
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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
definitions:
VnfPkgInfo:
type: object
required:
- id
- onboardingState
- operationalState
- usageState
properties:
id:
description: >
Identifier of the VNF package. This identifier is allocated by the NFVO.
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfdId:
description: >
This identifier, which is managed by the
VNF provider, identifies the VNF package and the VNFD in a globally unique way.
It is copied from the VNFD of the on boarded VNF package. It shall be present
after the VNF package content has been on-boarded and absent otherwise.
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfProvider:
description: >
Provider of the VNF package and the VNFD. This information is copied from the VNFD.
It shall be present after the VNF package content has been on-boarded and absent otherwise.
type: string
vnfProductName:
description: >
Name to identify the VNF product.Invariant for the VNF product lifetime.
This information is copied from the VNFD. It
shall be present after the VNF package content has been on-boarded and absent otherwise.
type: string
vnfSoftwareVersion:
description: >
Software version of the VNF. This is
changed when there is any change to the
software included in the VNF package.
This information is copied from the VNFD.
It shall be present after the VNF package
content has been on-boarded and absent otherwise.
$ref: "#/definitions/Version"
vnfdVersion:
description: >
The version of the VNFD. This information
is copied from the VNFD. It shall be
present after the VNF package content
has been on-boarded and absent otherwise.
$ref: "#/definitions/Version"
checksum:
description: >
Checksum of the on-boarded VNF
package. It shall be present after the VNF
package content has been on-boarded and absent otherwise.
$ref: "#/definitions/Checksum"
softwareImages:
description: >
Information about VNF package artifacts that are software images.
This attribute shall not be present before the VNF package content is on-boarded.
Otherwise, this attribute shall be present unless it has been requested to be
excluded per attribute selector.
type: "array"
items:
$ref: "#/definitions/VnfPackageSoftwareImageInfo"
Version:
description: >
Software version of the VNF. This is
changed when there is any change to the
software included in the VNF package.
This information is copied from the VNFD.
It shall be present after the VNF package
content has been on-boarded and absent otherwise.
type: string
Checksum:
description: >
This type represents the checksum of a VNF package or an artifact file.
required:
- algorithm
- hash
type: object
properties:
algorithm:
description: >
Name of the algorithm used to generate the checksum,
as defined in ETSI GS NFV-SOL 004 [5]. For example, SHA-256, SHA-512.
type: string
hash:
description: >
The hexadecimal value of the checksum.
type: string
PkgmLinks:
description: >
This type represents the links to resources that a VNF package management notification can contain.
required:
- vnfPackage
- subscription
type: object
properties:
vnfPackage:
description: >
Link to the resource representing the VNF package to
which the notified change applies, i.e. the individual onboarded
VNF package resource that represents the VNF package.
$ref: "SOL005_def.yaml#/definitions/Link"
subscription:
description: >
Link to the related subscription.
$ref: "SOL005_def.yaml#/definitions/Link"
VnfPackageSoftwareImageInfo:
description: >
This type represents an artifact contained in a VNF package which represents a software image.
required:
- id
- name
- provider
- version
- checksum
- containerFormat
- diskFormat
- createdAt
- minDisk
- minRam
- size
- imagePath
type: object
properties:
id:
description: >
Name of the algorithm used to generate the checksum,
as defined in ETSI GS NFV-SOL 004 [5]. For example, SHA-256, SHA-512.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
name:
description: >
Name of the software image.
type: string
provider:
description: >
Provider of the software image.
type: string
version:
description: >
Version of the software image.
$ref: "#/definitions/Version"
checksum:
description: >
Checksum of the software image file.
$ref: "#/definitions/Checksum"
containerFormat:
description: >
Container format indicates whether the software image
is in a file format that also contains metadata about the actual software.
Permitted values:
- AKI: a kernel image format
- AMI: a machine image format
- ARI: a ramdisk image format
- BARE: the image does not have a container or
metadata envelope
- DOCKER: docker container format
- OVA: OVF package in a tarfile
- OVF: OVF container format
type: string
enum:
- AKI
- AMI
- ARI
- BARE
- DOCKER
- OVA
- OVF
diskFormat:
description: >
Disk format of a software image is the format of the
underlying disk image.
Permitted values:
- AKI: a kernel image format
- AMI: a machine image format
- ARI: a ramdisk image format
- ISO: an archive format for the data contents of an
optical disc, such as CD-ROM
- QCOW2: a common disk image format, which can
expand dynamically and supports copy on write
- RAW: an unstructured disk image format
- VDI: a common disk image format
- VHD: a common disk image format
- VHDX: enhanced version of VHD format
- VMDK: a common disk image format
type: string
enum:
- AKI
- AMI
- ARI
- ISO
- QCOW2
- RAW
- VDI
- VHD
- VHDX
- VMDK
createdAt:
description: >
Time when this software image was created.
$ref: "SOL005_def.yaml#/definitions/DateTime"
minDisk:
description: >
The minimal disk for this software image in bytes.
type: integer
minRam:
description: >
The minimal RAM for this software image in bytes.
type: integer
size:
description: >
Size of this software image in bytes.
type: integer
userMetadata:
description: >
User-defined data.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
imagePath:
description: >
Path in the VNF package, which identifies the image
artifact and also allows to access a copy of the image
artifact.
type: string
NsdOperationalStateType:
type: "string"
description: >
"The enumeration NsdOperationalStateType shall comply with the provisions
defined in Table 5.5.4.3-1 of GS NFV_SOL 005. It indicates the operational
state of the resource.ENABLED = The operational state of the resource
is enabled. DISABLED = The operational state of the resource is disabled."
enum:
- "ENABLED"
- "DISABLED"
PackageOperationalStateType:
type: "string"
description: >
"The enumeration PackageOperationalStateType shall
comply with the provisions defined in Table 9.5.4.4-1."
Acceptable values are:
-ENABLED - The VNF package is enabled, i.e. it can be used for instantiation of new VNF instances.
-DISABLED - The VNF package is disabled, i.e. it cannot be used for further VNF instantiation requests (unless and until the VNF package is re-enabled).
enum:
- "ENABLED"
- "DISABLED"
PackageUsageStateType:
type: "string"
description: >
"The enumeration PackageUsageStateType shall comply with the provisions.
Acceptable values are:
-IN_USE - VNF instances instantiated from this VNF package exist.
-NOT_IN_USE - No existing VNF instance is instantiated from this VNF package"
enum:
- "IN_USE"
- "NOT_IN_USE"
CreateVnfPkgInfoRequest:
type: "object"
properties:
userDefinedData:
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
description: >
"This type represents the request parameters for creating
a new individual VNF package resource. It shall comply with
the provisions defined in Table 9.5.2.2-1."
VnfPkgInfoModifications:
description: >
This type represents modifications to the information of a VNF package.
It shall comply with the provisions defined in Table 9.5.2.3-1.
properties:
operationalState:
description: >
New value of the operational state of the on-boarded
instance of the VNF package.
$ref: "#/definitions/PackageOperationalStateType"
userDefinedData:
description: >
User defined data to be updated. For existing keys, the value is replaced.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
UploadVnfPkgFromUriRequest:
type: "object"
properties:
userDefinedData:
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
description: >
"The payload body contains the address information based on
which the NFVO can obtain the content of the VNF package"
PkgmSubscription:
description: >
This type represents a subscription related to notifications about VNF package management.
type: object
required:
- id
- callbackUri
- _links
properties:
id:
description: >
Identifier of this subscription resource
$ref: "SOL005_def.yaml#/definitions/Uri"
filter:
description: >
Filter settings for this subscription, to define the subset
of all notifications this subscription relates to. A
particular notification is sent to the subscriber if the filter
matches, or if there is no filter.
$ref: "#/definitions/PkgmNotificationsFilter"
callbackUri:
description: >
The URI of the endpoint to send the notification to
$ref: "SOL005_def.yaml#/definitions/Uri"
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
properties:
self:
description: >
URI of this resource.
$ref: "SOL005_def.yaml#/definitions/Link"
PkgmSubscriptionRequest:
description: >
This type represents a subscription request related to VNF package management notifications about VNF package on boarding or changes.
type: object
required:
- callbackUri
properties:
filter:
description: >
Filter settings for this subscription, to define the subset
of all notifications this subscription relates to. A
particular notification is sent to the subscriber if the filter
matches, or if there is no filter.
$ref: "#/definitions/PkgmNotificationsFilter"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "SOL005_def.yaml#/definitions/Uri"
authentication:
description: >
Authentication parameters to conFigure the use of
authorization when sending notifications corresponding
to this subscription, as defined in clause 4.5.3.4.
This attribute shall only be present if the subscriber
requires authorization of notifications.
$ref: "SOL005_def.yaml#/definitions/SubscriptionAuthentication"
PkgmNotificationsFilter:
description: >
This type represents a subscription filter related to notifications related to VNF package management.
At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter
to match (logical "and" between different filter attributes). If an attribute is an array, the attribute shall match if at least
one of the values in the array matches (logical "or" between the values of one filter attribute).
type: object
properties:
notificationTypes:
description: >
Match particular notification types.
Permitted values:
- VnfPackageOnboardingNotification
- VnfPackageChangeNotification
type: string
enum:
- VnfPackageOnboardingNotification
- VnfPackageChangeNotification
vnfProductsFromProviders:
description: >
If present, match VNF packages that contain VNF products from certain providers.
type: array
items:
type: object
required:
- vnfProvider
properties:
vnfProvider:
description: >
Name of the VNFprovider to match.
type: string
vnfProducts:
description: >
If present, match VNF packages that contain
VNF products with certain product names, from
one particular provider.
type: array
items:
type: object
required:
- vnfProductName
properties:
vnfProductName:
description: >
Name of the VNF product to match.
type: string
versions:
description: >
If present, match VNF packages that contain
VNF products with certain versions and a
certain product name, from one particular
provider.
type: array
items:
type: object
required:
- vnfSoftwareVersion
properties:
vnfSoftwareVersion:
description: >
VNF software version to match
$ref: "#/definitions/Version"
vnfdVersions:
description: >
If present, match VNF packages that contain
VNF products with certain VNFD versions, a
certain software version and a certain product
name, from one particular provider.
type: array
items:
$ref: "#/definitions/Version"
vnfdId:
description: >
Match VNF packages with a VNFD identifier
listed in the attribute.
type: array
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfPkgId:
description: >
Match VNF packages with a package identifier
listed in the attribute.
May be present if the "notificationTypes"
attribute contains the value
"VnfPackageChangeNotification", and shall be
absent otherwise.
type: array
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
operationalState:
description: >
Match VNF packages with a package identifier
listed in the attribute.
May be present if the "notificationTypes"
attribute contains the value
"VnfPackageChangeNotification", and shall be
absent otherwise.
type: array
items:
$ref: "#/definitions/PackageOperationalStateType"
usageState:
description: >
Match particular usage state of the on-boarded VNF package.
May be present if the "notificationTypes"
attribute contains the value
"VnfPackageChangeNotification", and shall be
absent otherwise.
type: array
items:
$ref: "#/definitions/PackageUsageStateType"