Newer
Older
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
This type represents the information of an VNF package.
Giacomo Bernini
committed
- packageSecurityOption
Giacomo Bernini
committed
- vnfmInfo
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.
It shall be present after the VNF package content has been
on-boarded and absent otherwise.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfProvider:
description: >
Provider of the VNF package and the VNFD. This information is copied
from the VNFD.
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/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.
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/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/SOL002SOL003_def.yaml#/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/SOL002SOL003_def.yaml#/definitions/Version"
Giacomo Bernini
committed
compatibleSpecificationVersions:
description: >
Indicates which versions of the ETSI GS NFV-SOL 004 specification the
package complies to, as defined in the manifest of the package.
Each entry shall be formatted as defined in clause 4.3.2 of ETSI GS NFV-SOL 004.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/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.
Permitted hash algorithms are defined in ETSI GS NFV-SOL 004.
Giacomo Bernini
committed
packageSecurityOption:
description: >
Signals the security option used by the package as defined in clause 5.1 of ETSI GS NFV-SOL 004.
Valid values: OPTION_1, OPTION_2
type: string
enum:
- OPTION_1
- OPTION_2
signingCertificate:
description: >
The singleton signing certificate if it is included as a file in the VNF package.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
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"
additionalArtifacts:
description: >
Information about VNF package artifacts contained in the VNF package
that are not software images.
Giacomo Bernini
committed
Every local and external artifact declared in the manifest shall be
included, except the software images and the files that make up the
parts of the VNFD (see clause 10.4.4.3.2).
Signature files and certificate files are not considered as artifacts,
however, the content of the "Licenses" and "Testing" directories in the
VNF package is.
This attribute shall not be present before the VNF package content
is on-boarded. Otherwise, this attribute shall be present if the VNF
package contains additional artifacts.
type: array
items:
$ref: "#/definitions/VnfPackageArtifactInfo"
onboardingState:
description: >
On-boarding state of the VNF package.
$ref: "#/definitions/PackageOnboardingStateType"
Operational state of the VNF package.
If the value of the onboardingState attribute is not equal to
"ONBOARDED", the value of the operationalState attribute shall be
equal to "DISABLED".
$ref: "#/definitions/PackageOperationalStateType"
usageState:
description: >
Usage state of the VNF package.
If the value of the onboardingState attribute is not equal to
"ONBOARDED", the value of the usageState attribute shall be
equal to "NOT_IN_USE".
$ref: "#/definitions/PackageUsageStateType"
Giacomo Bernini
committed
vnfmInfo:
description: >
Specifies VNFMs compatible with the VNF. This information is copied from the VNFD.
ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on
TOSCA specifications.
userDefinedData:
description: >
User defined data for the VNF package.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
Giacomo Bernini
committed
onboardingFailureDetails:
description: >
Failure details of current onboarding procedure. See clause 6.3 of ETSI GS NFV-SOL 013
for the details of "ProblemDetails" structure.
If "onboardingState" is "ERROR", this attribute shall be present and contain error
information (such as failed onboarding or processing operation, affected artifact etc.),
unless it has been requested to be excluded via an attribute selector.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
_links:
description: >
Links to resources related to this resource.
type: object
self:
description: >
URI of this resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
vnfd:
description: >
Link to the "VNFD in an individual VNf package" resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
packageContent:
description: >
Link to the "VNF package content" resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
PkgmSubscriptionRequest:
This type represents a subscription request related to VNF package
management notifications about VNF package on-boarding or changes.
required:
- callbackUri
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:
The URI of the endpoint to send the notification to.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
authentication:
Authentication parameters to configure the use of Authorization when
sending notifications corresponding to this subscription, as defined
in clause 8.3.4 of ETSI GS NFV-SOL 013.
This attribute shall only be present if the subscriber requires
authorization of notifications.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"
PkgmSubscription:
description: >
This type represents a subscription related to notifications about
VNF package management.
type: object
Identifier of this "Individual 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
properties:
self:
description: >
URI of this resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
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
Giacomo Bernini
committed
- isEncrypted
- containerFormat
- diskFormat
- createdAt
- minDisk
- minRam
- size
- imagePath
id:
description: >
Identifier of the software image.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
name:
description: >
Name of the software image.
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
provider:
description: >
Provider of the software image.
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
version:
description: >
Version of the software image.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"
checksum:
description: >
Checksum of the software image file.
Permitted hash algorithms are defined in ETSI GS NFV-SOL 004.
Giacomo Bernini
committed
isEncrypted:
description: >
Reflects whether the image is encrypted (true) or not (false).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean"
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
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
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
- ISO
- QCOW2
- RAW
- VDI
- VHD
- VHDX
- VMDK
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.
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
VnfPackageArtifactInfo:
description: >
This type represents an artifact other than a software image which is
contained in a VNF package.
type: object
required:
- artifactPath
- checksum
Giacomo Bernini
committed
- isEncrypted
properties:
artifactPath:
description: >
Giacomo Bernini
committed
Path in the VNF package, which identifies the artifact and
also allows to access a copy of the artifact. The
Giacomo Bernini
committed
For an artifact contained as a file in the VNF package,
this attribute shall be present, and the value of this
attribute shall start with the name of the first segment
in the path in the package, i.e. it shall not be prefixed
by path separator characters such as "." and "/".
EXAMPLE: foo/bar/runm@ster.sh
For an external artifact represented as a URI in the
VNF descriptor, this attribute shall be present if the
artifact has been downloaded by the NFVO and shall be
absent otherwise. If present, it shall contain the
artifactPath under which the artifact can be obtained
using the "Individual artifact in a VNF package" resource
defined in clause 10.4.6. It is the responsibility of the
NFVO to synthesize this path in a manner that avoids any
collision of the synthesized artifact path with the paths
and names of artifacts included in the package.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
checksum:
description: >
Checksum of the artifact file.
Permitted hash algorithms are defined in ETSI GS NFV-SOL 004.
$ref: "#/definitions/Checksum"
Giacomo Bernini
committed
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
isEncrypted:
description: >
Reflects whether the artifact is encrypted (true) or not (false).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean"
artifactURI:
description: >
URI of the artifact as defined in the VNF package manifest.
Shall be present if the artifact is external to the package
and shall be absent otherwise.
EXAMPLE: https://example.com/m%40ster.sh
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
nonManoArtifactSetId:
description: >
Non-MANO artifact set identifier of the non-MANO artifact set to
which the artifact belongs, as defined in clause 4.3.7 of ETSI GS NFV-SOL 004.
Shall be provided if the artifact is a non-MANO artifact, and shall be omitted otherwise.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
artifactClassification:
description: >
Marks specific types of artifacts as defined in the VNF package.
If none of the specific classes listed below applies, the attribute shall not be present.
Valid values:
- HISTORY: a history artifact as per clause 4.3.3 in ETSI GS NFV-SOL 004
- TESTING: a testing artifact as per clause 4.3.4 in ETSI GS NFV-SOL 004
- LICENSE: a license artifact as per clause 4.3.5 in ETSI GS NFV-SOL 004
type: string
enum:
- HISTORY
- TESTING
- LICENSE
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
467
468
469
470
471
472
473
474
475
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"
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
vnfProductsFromProviders:
description: >
If present, match VNF packages that contain VNF products from
certain providers.
The attributes "vnfProductsFromProviders", "vnfdId" and "vnfPkgId"
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:
type: object
required:
- vnfProvider
properties:
vnfProvider:
description: >
Name of the VNF provider to match.
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/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.
Giacomo Bernini
committed
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/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/SOL002SOL003_def.yaml#/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/SOL002SOL003_def.yaml#/definitions/Version"
vnfdId:
description: >
Match VNF packages with a VNFD identifier listed in the attribute.
The attributes "vnfProductsFromProviders", "vnfdId" and "vnfPkgId"
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"
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.
The attributes "vnfProductsFromProviders", "vnfdId" and "vnfPkgId"
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: >
Giacomo Bernini
committed
Match particular operational states of the VNF package.
May be present if the "notificationTypes" attribute contains the
value "VnfPackageChangeNotification" and shall be absent
otherwise.
$ref: "#/definitions/PackageOperationalStateType"
usageState:
description: >
Giacomo Bernini
committed
Match particular usage states of the VNF package.
May be present if the "notificationTypes" attribute contains the
value "VnfPackageChangeNotification" and shall be absent
otherwise.
$ref: "#/definitions/PackageUsageStateType"
Giacomo Bernini
committed
vnfmInfo:
description: >
Match strings that specify VNFMs compatible with the VNF. See table 10.5.2.2-1.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
PackageOperationalStateType:
description: >
- ENABLED: The VNF package is enabled, i.e. it can be used for
Giacomo Bernini
committed
the creation of new "Individual VNF instance" resources.
- DISABLED: The VNF package is disabled, i.e. it shall not be used for
the creation of further "Individual VNF instance" resources
(unless and until the VNF package is re-enabled).
type: string
enum:
- ENABLED
- DISABLED
PackageUsageStateType:
description: >
- IN_USE: "Individual VNF instance" resources created from this VNF package exist.
- NOT_IN_USE: No "Individual VNF instance" resource created from this VNF package exists.
type: string
enum:
- IN_USE
- NOT_IN_USE
PackageOnboardingStateType:
description: >
CREATED: The "Individual VNF package" resource has been created.
UPLOADING: The associated VNF package content is being uploaded.
PROCESSING: The associated VNF package content is being processed, e.g.,
Giacomo Bernini
committed
validation.
ONBOARDED: The associated VNF package content has been on-boarded successfully.
ERROR: There was an error during upload of the VNF package content or external
artifacts, or during VNF package processing.
type: string
enum:
- CREATED
- UPLOADING
- PROCESSING
Giacomo Bernini
committed
- ONBOARDED
- ERROR