Newer
Older
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
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
Checksum:
description: >
This type represents the checksum of a VNF package or an artifact file.
type: object
required:
- algorithm
- hash
properties:
algorithm:
description: >
Name of the algorithm used to generate the checksum, as defined in
ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512.
type: string
hash:
description: >
The hexadecimal value of the checksum.
type: string
OnboardedVnfPkgInfo:
description: >
This type represents the information of an on-boarded VNF package.
type: object
required:
- id
- vnfdId
- vnfProvider
- vnfProductName
- vnfSoftwareVersion
- vnfdVersion
- checksum
- operationalState
- usageState
- deletionPending
- _links
properties:
id:
description: >
Identifier of the on-boarded VNF package. This identifier is
allocated by the NFVO.
$ref: "../../../definitions/SOL002SOL003_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's copied from the VNFD of the on-boarded VNF package.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfProvider:
description: >
Provider of the VNF package and the VNFD. This information is copied
from the VNFD.
type: string
vnfProductName:
description: >
Name to identify the VNF product. Invariant for the VNF product
lifetime. This information is copied from the VNFD.
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.
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version"
vnfdVersion:
description: >
The version of the VNFD. This information is copied from the VNFD.
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version"
checksum:
description: >
Checksum of the on-boarded VNF package.
$ref: "#/definitions/Checksum"
softwareImages:
description: >
Information about VNF package artifacts that are software images.
This attribute shall be present unless it has been requested to be
excluded per attribute selector.
type: array
items:
$ref: "#/definitions/VnfPackageSoftwareImageInfo"
additionalArtifacts:
description: >
Information about VNF package artifacts contained in the VNF package
that are not software images.
type: array
items:
$ref: "#/definitions/VnfPackageArtifactInfo"
operationalState:
description: >
Operational state of the on-boarded instance of the VNF package.
$ref: "#/definitions/PackageOperationalStateType"
usageState:
description: >
Usage state of the on-boarded instance of the VNF package.
$ref: "#/definitions/PackageUsageStateType"
deletionPending:
description: >
The value "true" indicates that deletion of this instance of the VNF
package has been requested but the VNF package is still being used
by created VNFs.
This instance of the VNF package will be deleted once all VNFs
instantiated from this package are deleted.
type: boolean
userDefinedData:
description: >
User defined data for the VNF package.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
- vnfd
- packageContent
properties:
self:
description: >
URI of this resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
vnfd:
description: >
Link to the VNFD resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
packageContent:
description: >
Link to the "On-boarded VNF package content" resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
PackageOperationalStateType:
description: >
- 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).
type: string
enum:
- ENABLED
- DISABLED
PackageUsageStateType:
description: >
- IN_USE: VNF instances instantiated from this VNF package exist.
- NOT_IN_USE: No existing VNF instance is instantiated from this VNF
package.
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
The permitted values of the "notificationTypes" attribute are
spelled exactly as the names of the notification types to
facilitate automated code generation systems.
type: array
items:
type: string
enum:
- VnfPackageOnboardingNotification
- VnfPackageChangeNotification
vnfProvider:
description: >
Match VNF packages from a provider that is listed as part of this
attribute.
type: array
items:
type: string
vnfProductInfo:
description: >
Match particular VNF products.
type: array
items:
type: object
required:
- vnfProductName
properties:
vnfProductName:
description: >
Match VNF products with a particular name.
type: string
vnfSoftwareVersion:
description: >
Match VNF products with one of the software versions listed as
part of this attribute.
As "vnfSoftwareVersion" and "vnfdVersion" can change
independently from each other, care should be taken when
specifying both at the same time.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version"
vnfdVersion:
description: >
Match VNF products with one of the VNFD versions listed as
part of this attribute.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version"
vnfdId:
description: >
Match VNF packages with a VNFD identifier listed in the attribute.
On-boarded VNF package identifiers and VNFD identifiers are
alternatives to reference to particular VNF packages in a filter.
They should not be used both in the same filter instance, but one
alternative should be chosen.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
onboardedVnfPkgId:
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.
On-boarded VNF package identifiers and VNFD identifiers are
alternatives to reference to particular VNF packages in a filter.
They should not be used both in the same filter instance, but one
alternative should be chosen.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
operationalState:
description: >
Match particular operational state of the on-boarded VNF package.
May be present if the "notificationTypes" attribute contains the
value "VnfPackageChangeNotification", and shall be absent
otherwise.
$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.
$ref: "#/definitions/PackageUsageStateType"
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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
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: "../../../definitions/SOL002SOL003_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: "../../../definitions/SOL002SOL003_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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
authentication:
description: >
Authentication parameters to configure the use of Authorization
when sending notifications corresponding to this subscription.
This attribute shall only be present if the subscriber requires
authorization of notifications.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"
VnfPackageArtifactInfo:
description: >
This type represents an artifact other than a software image which is
contained in a VNF package.
type: object
required:
- artifactPath
- checksum
properties:
artifactPath:
description: >
Path in the VNF package, which identifies the artifact and also
allows to access a copy of the artifact.
type: string
checksum:
description: >
Checksum of the artifact file.
$ref: "#/definitions/Checksum"
metadata:
description: >
The metadata of the artifact that are available in the VNF package,
such as Content type, size, creation date, etc.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
VnfPackageSoftwareImageInfo:
description: >
This type represents an artifact contained in a VNF package which
represents a software image.
type: object
required:
- id
- name
- provider
- version
- checksum
- containerFormat
- diskFormat
- createdAt
- minDisk
- minRam
- size
- imagePath
properties:
id:
description: >
Identifier of the software image.
$ref: "../../../definitions/SOL002SOL003_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/SOL002SOL003VNFLifecycleManagement_def.yaml#/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
The list of permitted values was taken from "Container formats" in
http://docs.openstack.org/image-guide/image-formats.html
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
The list of permitted values was adapted from "Disk formats" in
http://docs.openstack.org/image-guide/image-formats.html
type: string
enum:
- AKI
- AMI
- ISO
- QCOW2
- RAW
- VDI
- VHD
- VHDX
- VMDK
createdAt:
description: >
Time when this software image was created.
$ref: "../../../definitions/SOL002SOL003_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: "../../../definitions/SOL002SOL003_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