Commit c43d91f5 authored by Samir Medjiah's avatar Samir Medjiah
Browse files

SOL003: v308 updates : SupportedIndicatorsChangeNotification added and minor fixes

parent f02f557c
Pipeline #4574 failed with stage
in 0 seconds
......@@ -499,7 +499,7 @@ components:
description: |
200 OK
The list of subscriptions has been queried successfully.
Shall be returned when the list of subscriptions has been queried successfully.
The response body shall contain in an array the representations of all active subscriptions
of the functional block that invokes the method, i.e. zero or more representations of
FM subscriptions as defined in clause 7.5.2.3.
......
......@@ -105,7 +105,9 @@ components:
content:
application/json:
schema:
$ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorValueChangeNotification
oneOf:
- $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorValueChangeNotification
- $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/SupportedIndicatorsChangeNotification
required: true
responses:
......
......@@ -189,13 +189,17 @@ definitions:
vnfInstanceId:
description: >
Identifier of the related VNF instance.
The NFVO shall set the value of the attribute by copying the value
from the associated GrantRequest.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfLcmOpOccId:
description: >
Identifier of the related VNF lifecycle management operation
occurrence.
The NFVO shall set the value of the attribute by copying the value
from the associated GrantRequest.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vimConnections:
vimConnectionInfo:
description: >
Provides information regarding VIM connections that are approved to
be used by the VNFM to allocate resources, and provides parameters
......@@ -203,7 +207,7 @@ definitions:
The VNFM shall update the " vimConnectionInfo" attribute of the
"VnfInstance" structure by adding unknown entries received in this
attribute.
This attribute is not intended for the modification of VimConnection
This attribute is not intended for the modification of vimConnectionInfo
entries passed earlier; for that, the VnfInfoModificationRequest
structure shall be used.
This attribute shall only be supported when VNF-related Resource
......@@ -239,7 +243,7 @@ definitions:
addResources:
description: >
List of resources that are approved to be added, with one entry per
resource.
resource. Shall be set when resources are approved to be added.
type: array
items:
$ref: "#/definitions/GrantInfo"
......@@ -247,21 +251,22 @@ definitions:
description: >
List of resources that are approved to be temporarily instantiated
during the runtime of the lifecycle operation, with one entry per
resource.
resource. Shall be set when resources are approved to be temporarily
instantiated.
type: array
items:
$ref: "#/definitions/GrantInfo"
removeResources:
description: >
List of resources that are approved to be removed, with one entry
per resource.
per resource. Shall be set when resources are approved to be removed.
type: array
items:
$ref: "#/definitions/GrantInfo"
updateResources:
description: >
List of resources that are approved to be modified, with one entry
per resource.
per resource. Shall be set when resources are approved to be updated.
type: array
items:
$ref: "#/definitions/GrantInfo"
......@@ -319,15 +324,29 @@ definitions:
externally-managed VL instances that have been passed previously in the
associated VNF lifecycle management request, if the lifecycle management request
has originated from the NFVO itself.
In case of granting an InstantiateVnf request that has originated from the NFVO
and that did not contain the "extVirtualLinks" attribute, this attribute shall be
set by the NFVO. Further in case of granting an InstantiateVnf request that has
originated from the NFVO and that did not contain the "extManagedVirtualLinks"
attribute, this attribute shall be set by the NFVO if there is the need to provide
information about externally-managed virtual links.
If this attribute is present , it need not contain
those entries that are unchanged compared to the entries that were passed
in the LCM operation which is related to this granting exchange.
External and/or externally-managed internal VLs can be passed in
VNF lifecycle management operation requests such as InstantiateVnf
or ChangeVnfFlavour, and/or in the grant response. The NFVO may choose
to override in the grant response external and/or externally-managed VL
instances that have been passed previously in the associated VNF lifecycle
management request, if the lifecycle management request has originated from the NFVO itself.
External and/or externally-managed internal VLs can be passed in VNF
lifecycle management operation requests such as InstantiateVnf, ChangeVnfFlavor,
ChangeExtVnfConnectivity or ChangeCurrentVnfPackage and/or in the grant response.
The NFVO may choose to override in the grant response external and/or
externally-managed VL instances that have been passed previously in the
associated VNF lifecycle management request, if the lifecycle management request
has originated from the NFVO itself.
In case of granting an InstantiateVnf request that has originated from the NFVO
and that did not contain the "extVirtualLinks" attribute, this attribute shall be
set by the NFVO. Further in case of granting an InstantiateVnf request that has
originated from the NFVO and that did not contain the "extManagedVirtualLinks"
attribute, this attribute shall be set by the NFVO if there is the need to provide
information about externally-managed virtual links.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData"
......@@ -349,6 +368,12 @@ definitions:
externally-managed VL instances that have been passed previously in the
associated VNF lifecycle management request, if the lifecycle management request
has originated from the NFVO itself.
In case of granting an InstantiateVnf request that has originated from the NFVO
and that did not contain the "extVirtualLinks" attribute, this attribute shall be
set by the NFVO. Further in case of granting an InstantiateVnf request that has
originated from the NFVO and that did not contain the "extManagedVirtualLinks"
attribute, this attribute shall be set by the NFVO if there is the need to provide
information about externally-managed virtual links.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtManagedVirtualLinkData"
......@@ -421,9 +446,11 @@ definitions:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
resourceTemplateId:
description: >
Reference to a resource template (VnfVirtualLinkDesc,
VirtualComputeDesc, VnfExtCpd, VirtualStorageDesc) in the
VNFD.
Reference to the applicable resource template in the VNFD as follows:
- if type="VL" : VnfVirtualLinkDesc
- if type="COMPUTE": VirtualComputeDesc
- if type="LINKPORT" : VnfExtCpd
- if type="STORAGE" : VirtualStorageDesc
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
resource:
description: >
......
......@@ -228,7 +228,7 @@ definitions:
VnfPackageSoftwareImageInfo:
description: >
This type represents an artifact contained in a VNF package which
This type represents an artifact contained in or external to a VNF package which
represents a software image.
type: object
required:
......@@ -244,7 +244,6 @@ definitions:
- minDisk
- minRam
- size
- imagePath
properties:
id:
description: >
......@@ -346,14 +345,38 @@ definitions:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
imagePath:
description: >
Path in the VNF package, which identifies the image artifact and also
Path which identifies the image artifact and also
allows to access a copy of the image artifact.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
For a software image 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/m%40ster.vhd
For an external software image represented as a URI in
the VNF descriptor, this attribute shall be present if the
image artifact has been downloaded by the NFVO and
shall be absent otherwise. If present, it shall contain the
artifactPath under which the image artifact can be
obtained using the "Individual artifact in a VNF package"
resource defined in clause 9.4.7. 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 image artifacts included in the
package.
type: string
imageUri:
description: >
URI of the image artifact as defined in the VNF package
manifest. Shall be present if the image artifact is external
to the VNF package and shall be absent otherwise.
EXAMPLE: https://example.com/m%40ster.vhd
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
VnfPackageArtifactInfo:
description: >
This type represents an artifact other than a software image which is
contained in a VNF package.
contained in or external to a VNF package.
type: object
required:
- artifactPath
......@@ -384,15 +407,6 @@ definitions:
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/SOL002SOL003_def.yaml#/definitions/Checksum"
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.
......@@ -403,6 +417,15 @@ definitions:
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
checksum:
description: >
Checksum of the artifact file.
Permitted hash algorithms are defined in ETSI GS NFV-SOL 004.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Checksum"
isEncrypted:
description: >
Reflects whether the artifact is encrypted (true) or not (false).
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean"
nonManoArtifactSetId:
description: >
Non-MANO artifact set identifier of the non-MANO artifact set to
......
......@@ -223,7 +223,7 @@ components:
EXAMPLE: foo/bar/m%40ster.sh
For an external artefact represented as a URI in the VNF snapshot package manifest, this variable shall
For an external artifact represented as a URI in the VNF snapshot package manifest, this variable shall
contain a sequence of one or more path segments as synthesized by the NFVO (see clause 12.5.3.3) representing
this artifact.
......@@ -334,7 +334,7 @@ components:
The response body shall include a copy of the VNF snapshot package file.
The "Content-Type" HTTP header shall be set according to the type of the file, i.e. to "application/zip"
for a VNF snapshot package as defined in ETSI GS NFV-SOL 010.
for a VNF snapshot package. The VNF snapshot package format is defined in ETSI GS NFV-SOL 010.
headers:
Version:
description: The used API version.
......@@ -412,8 +412,8 @@ components:
Shall be returned when the whole content of the artifact file has been read successfully.
The response body shall include a copy of the artifact file from the VNF snapshot package,
as defined by ETSI GS NFV-SOL 010.
The response body shall include a copy of the artifact file from the VNF snapshot package.
The VNF snapshot package format is defined in ETSI GS NFV-SOL 010.
The "Content-Type" HTTP header shall be set according to the content type of the artifact file.
If the content type cannot be determined, the header shall be set to the value "application/octet-stream".
......@@ -451,8 +451,8 @@ components:
If the NFVO supports range requests, this response shall be returned when a single consecutive byte range
from the content of the artifact file has been read successfully according to the request.
The response body shall contain the requested part of the artifact file from the VNF snapshot package,
as defined by ETSI GS NFV-SOL 010.
The response body shall contain the requested part of the artifact file from the VNF snapshot package.
The VNF snapshot package is defined in ETSI GS NFV-SOL 010.
The "Content-Type" HTTP header shall be set according to the content type of the artifact file. If the
content type cannot be determined, the header shall be set to the value "application/octet-stream".
......
......@@ -35,8 +35,8 @@ definitions:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
checksum:
description: >
Checksum of the stored VNF snapshot package. Permitted hash algorithms are defined in
ETSI GS NFV-SOL 010.
Checksum of the stored VNF snapshot package. Hash algorithms applicable to VNF
snapshot packages are defined in ETSI GS NFV-SOL 010.
NOTE: The attribute shall not be present before the VNF snapshot package content
has been uploaded or built. Otherwise, this attribute shall be present unless it
......@@ -50,15 +50,16 @@ definitions:
has been uploaded or built. Otherwise, this attribute shall be present unless it
has been requested to be excluded per attribute selector.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
vnfSnapshotInfoId:
vnfSnapshotId:
description: >
Identifier of information held by the NFVO about a specific VNF snapshot. This identifier
is allocated by the NFVO during the VNF snapshot creation.
Identifier of specific VNF snapshot in the VNF snapshot package.
This identifier is allocated by the VNFM during the VNF snapshot creation.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfcSnapshotInfoIds:
description: >
Identifier of information held by the NFVO about specific VNFC snapshot(s). This identifier
is allocated by the NFVO during the VNF snapshot creation.
Identifiers of information held by the VNFM about specific VNFC snapshots part
of the VNF snapshot and contained in the VNF snapshot package. This identifier
is allocated by the VNFM during the VNF snapshot creation.
NOTE: The attribute shall not be present before the VNF snapshot package content
has been uploaded or built. Otherwise, this attribute shall be present unless it
......@@ -158,7 +159,7 @@ definitions:
details:
description: >
Failure details containing error information (such as failed uploading or processing
operation, affected artefact, reason for cancellation, etc.). See clause 6.3 of
operation, affected artifact, reason for cancellation, etc.). See clause 6.3 of
ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
userDefinedData:
......@@ -210,8 +211,8 @@ definitions:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
checksum:
description: >
Checksum of the snapshot image file. Permitted hashalgorithms are defined in
ETSI GS NFV-SOL 010.
Checksum of the snapshot image file. Hash algorithms applicable to VNF
snapshot package artifacts are defined in ETSI GS NFV-SOL 010.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Checksum"
isEncrypted:
description: >
......@@ -360,7 +361,8 @@ definitions:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
checksum:
description: >
Checksum of the artifact file. Permitted hash algorithms are defined in ETSI GS NFV-SOL 010.
Checksum of the artifact file. Hash algorithms applicable to VNF
snapshot package artifacts are defined in ETSI GS NFV-SOL 010.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Checksum"
isEncrypted:
description: >
......@@ -390,7 +392,8 @@ definitions:
description: >
Path which allows to access a copy of the VNFD. The VNFD is implemented as
a collection of one or more files, and the path refers to the ZIP archive
file embedding these files as specified in the ETSI GS NFV-SOL 010.
file embedding these files. The VNF snapshot package format is defined
specified in the ETSI GS NFV-SOL 010.
The value of this attribute shall start with the name of the first segment
of the path in the package, i.e. it shall not be prefixed by path separator
characters such as "." and "/".
......@@ -398,8 +401,8 @@ definitions:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
checksum:
description: >
Checksum of the VNFD archive file. Permitted hash algorithms are defined in
ETSI GS NFV-SOL 004.
Checksum of the VNFD archive file. Hash algorithms applicable to VNF
snapshot package artifacts are defined in ETSI GS NFV-SOL 010.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Checksum"
isEncrypted:
description: >
......@@ -426,8 +429,8 @@ definitions:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
checksum:
description: >
Checksum of the VNF snapshot record file. Permitted hash algorithms are defined in
ETSI GS NFV-SOL 010.
Checksum of the VNF snapshot record file. Hash algorithms applicable to VNF
snapshot package artifacts are defined in ETSI GS NFV-SOL 010.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Checksum"
isEncrypted:
description: >
......
......@@ -98,7 +98,7 @@ definitions:
rootCauseFaultyResource:
description: >
The virtualised resources that are causing the VNF fault.
Shall be present if the alarm affects virtualized resources.
Shall be present if the alarm affects virtualised resources.
$ref: "#/definitions/FaultyResourceInfo"
alarmRaisedTime:
description: >
......@@ -154,7 +154,7 @@ definitions:
description: >
Attribute indicating if this fault is the root for other correlated
alarms. If true, then the alarms listed in the attribute
"correlatedAlarmId" are caused by this fault.
"correlatedAlarmIds" are caused by this fault.
type: boolean
correlatedAlarmIds:
description: >
......
......@@ -51,8 +51,8 @@ definitions:
VnfIndicatorNotificationsFilter:
description: >
This type represents a subscription filter related to notifications
about VNF indicator value changes.
This type represents a subscription filter for notifications
related to VNF indicators.
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
......@@ -220,6 +220,84 @@ definitions:
Link to the related "Individual VNF instance" resource. Shall be present
if the VNF instance information is accessible as a resource.
$ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
subscription:
description: >
Link to the related subscription.
$ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
SupportedIndicatorsChangeNotification:
description: >
This type represents a notification to inform the receiver that the set of indicators supported
by a VNF instance has changed. It shall comply with the provisions defined in table 8.5.2.6-1.
The notification shall be triggered by the VNFM when the set of supported VNF indicators has changed
as a side effect of the "Change current VNF package" operation. It may be triggered by the VNFM when
a VNF has been instantiated.
type: object
required:
- id
- notificationType
- subscriptionId
- timeStamp
- vnfInstanceId
- _links
properties:
id:
description: >
Identifier of this notification. If a notification is sent multiple times
due to multiple subscriptions, the "id" attribute of all these notifications
shall have the same value.
$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"SupportedIndicatorsChangeNotification" for this notification type.
type: string
enum:
- VnfIndicatorValueChangeNotification
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
vnfInstanceId:
description: >
Identifier of the VNF instance which provides the indicator value.
$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
supportedIndicators:
description: >
Set of VNF indicators supported by the VNF instance.
type: array
items:
type: object
required:
- vnfIndicatorId
properties:
vnfIndicatorId:
description: >
Identifier of the VNF indicator whose value has changed.
$ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
name:
description: >
Human readable name of the VNF indicator.
Shall be present if defined in the VNFD.
ETSI GS NFV-SOL 001 specifies the structure and format of
the VNFD based on TOSCA specifications.
$ref: string
_links:
description: >
Links for this resource.
type: object
required:
- subscription
properties:
vnfInstance:
description: >
Link to the related "Individual VNF instance" resource. Shall be present
if the VNF instance information is accessible as a resource.
$ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
subscription:
description: >
Link to the related subscription.
......
......@@ -185,7 +185,7 @@ definitions:
objectInstance:
description: >
Link to the resource representing the measured object instance to which the
notified change applies. Shall be present if the measured object instance
notification applies. Shall be present if the measured object instance
information is accessible as a resource.
$ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
pmJob:
......@@ -404,7 +404,7 @@ definitions:
New value of the "authentication" attribute, or "null"
to remove the attribute. If present in a request body,
these modifications shall be applied according to the
rules of JSON Merge PATCH.
rules of JSON Merge Patch (see IETF RFC 7396).
This attribute shall not be present in response bodies.
At least one of the attributes defined in this type shall be present in request bodies.
$ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"
......@@ -561,7 +561,7 @@ definitions:
New value of the "authentication" attribute, or "null"
to remove the attribute. If present in a request body,
these modifications shall be applied according to the
rules of JSON Merge PATCH.
rules of JSON Merge PATCH (see IETF RFC 7396).
This attribute shall not be present in response bodies.
At least one of the attributes defined in this type shall be present in request bodies.
$ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment