Commit 43be9a88 authored by Gergely Csatari's avatar Gergely Csatari Committed by Michele Carignani
Browse files

VNF Package Management interface



Change-Id: Ie87643111015bced2af5776ca8f5652492266083
Signed-off-by: Gergely Csatari's avatarGergely Csatari <gergely.csatari@nokia.com>
parent a0233a67
This diff is collapsed.
# 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
\ No newline at end of file
responses:
406:
description: >
If the "Accept" header does not contain at least one name of a content
type for which the NFVO can provide a representation of the VNFD, the
NFVO shall respond with this response code.
The "ProblemDetails" structure may be included with the "detail"
attribute providing more information about the error.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
type: string
maximum: 1
minimum: 0
schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
416:
description: >
The byte range passed in the "Range" header did not match any available
byte range in the VNF package file (e.g. "access after end of file").
The response body may contain a ProblemDetails structure.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
type: string
maximum: 1
minimum: 0
schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
\ No newline at end of file
swagger: "2.0"
info:
version: "2.3.0"
title: SOL003 - VNF Lifecycle Management Notification interface
license:
name: "ETSI Forge copyright notice"
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact:
name: "NFV-SOL WG"
basePath: "/callback/v1"
schemes:
- https
consumes:
- "application/json"
produces:
- "application/json"
paths:
###############################################################################
# Notification endpoint VnfPackageOnboardingNotification #
###############################################################################
'/URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification':
#SOL003 location: 10.4.9
post:
description: >
The POST method delivers a notification from the server to the client.
parameters:
- name: VnfPackageOnboardingNotification
description: A notification about on-boarding of a VNF package.
in: body
required: true
schema:
$ref: "definitions/VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageOnboardingNotification"
responses:
204:
description: >
The notification was delivered successfully.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
type: string
maximum: 1
minimum: 0
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
get:
description: >
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
responses:
204:
description: >
The notification endpoint was tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP
request has provided an invalid authorization token.
type: string
maximum: 1
minimum: 0
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"