This clause document describes the procedure for sending notifications related to VNF package management.
Precondition: The subscribed API consumer has subscribed previously for notifications related to VNF package management.
If an event occurs that matches the filtering criteria which are part of the subscription, Etsicatalog will generate notification that includes information about the event, and sends it in the body of a POST request to the URI
which the subscribed API consumer has registered as part of the subscription request.
The subscribed API consumer should acknowledges the successful delivery of the notification by returning a "204 No Content" response.
1.VnfPackage Onboarding Notification
When the vnf package performs the Onboarding operation onboarding VNF package successfully, Etsicatalog will filter all Subscriptions records:
...
- VnfPackage‘s vnfdId / vnfPkgId / vnfProductsFromProviders maching vnfProductsFromProviders matching subscription.filters
If there is some are matching subscription records, Etsicatalog will post notifications requests.will send a notification to the URI which is provided by the Client in its subscription request.
1.1 Flow of VnfPackage Onboarding Notification
| PlantUML Macro | ||
|---|---|---|
| ||
@startuml SOL003_AdapterClient -> ETSICatalog: Post PkgmSubscriptionRequest/Subscriptions\n(callbackUri=/URI-is-provided-by-the-client\nfilternfilters.notificationTypes=VnfPackageOnboardingNotification\nfilters.vnfProductsFromProviders/vnfdId/vnfPkgId=...) note over ETSICatalog: test notification endpoint ETSICatalog->SOL003_Adapter>Client: Get /URI-is-provided-by-the-client ETSICatalog<-SOL003_AdapterClient: 204 No Content note over ETSICatalog: Creates a new subscription ETSICatalog->SOL003_Adapter>Client: 201 Created alt SOL003_AdapterClient -> ETSICatalog: Put /vnf_packages/(vnfPkgId)/package_content else SOL003_AdapterClient -> ETSICatalog: Put /vnf_packages/(vnfPkgId)/package_content/upload_from_uri end ETSICatalog->SOL003_Adapter>Client: 202 Accepted note over ETSICatalog: Uploading of VNF package content note over ETSICatalog: Filter Subscriptions alt Filted by Subscriptions.filters.vnfProductsFromProviders/vnfdId/vnfPkgId ETSICatalog->SOL003_Adapter>Client: Post /URI-is-provided-by-the-client ETSICatalog<-SOL003_AdapterClient: 204 No Content end @enduml |
1.2 Subscribe API example:
| Code Block | ||
|---|---|---|
| ||
curl -X POST
http://{{baseUrl}}//api/vnfpkgm/v1/subscriptions
-H 'Content-Type: application/json'
-d '{
"filters": {
"notificationTypes": [
"VnfPackageOnboardingNotification"
],
"vnfdId": [
"uuid_vnfdid"
]
},
"callbackUri": "http://www.vnf1.com/notification",
"authentication": {
"authType": [
"BASIC"
],
"paramsBasic": {
"userName": "username",
"password": "userpwd"
}
}
}' |
1.3 Notification API example:
POST URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification
For this example, the URI provided by client is http://www.vnf1.com/notification according to the subscription request above.
| Code Block |
|---|
curl -X POST -u username:userpwd http://www.vnf1.com/notification
http://
-H 'Content-Type: application/json'
-d '{
"id":"notify_id",
"notificationType":"VnfPackageOnboardingNotification",
"timeStamp":"2019-12-16 14:41:16",
"vnfPkgId":"vnfPackage_uuid",
"vnfdId":"vnfdId_uuid",
"subscriptionId":"subscription_id",
"_links":{
"subscription":{
"href":"http://subscriptionuri"
},
"vnfPackage":{
"href":"http://vnfPackageuri"
}
}
}' |
2.VnfPackage Change Notification
When the vnf package performs the Deleting or Patching operation successfullyVNF package is modified or deleted, Etsicatalog will filter all Subscriptions records:
...
- VnfPackage’s vnfdId / vnfPkgId / vnfProductsFromProviders maching matching subscription.filters
If there is are some matching subscription records, Etsicatalog will post notifications requests.will send a notification to the URI which is provided by the Client in its subscription request.
2.1 Flow of VnfPackage Change Notification
| PlantUML Macro | ||
|---|---|---|
| ||
@startuml SOL003_AdapterClient -> ETSICatalog: Post PkgmSubscriptionRequest/Subscriptions\n(callbackUri=/URI-is-provided-by-the-client\nfilternfilters.notificationTypes=VnfPackageChangeNotification\nfilters.vnfProductsFromProviders/vnfdId/vnfPkgId=...) note over ETSICatalog: test notification endpoint ETSICatalog->SOL003_Adapter>Client: Get /URI-is-provided-by-the-client ETSICatalog<-SOL003_AdapterClient: 204 No Content note over ETSICatalog: Creates a new subscription ETSICatalog->SOL003_Adapter>Client: 201 Created alt SOL003_AdapterClient -> ETSICatalog: Delete /vnf_packages/(vnfPkgId) note over ETSICatalog: Deletes the VNF package ETSICatalog->SOL003_Adapter>Client: 200 OK else SOL003_AdapterClient -> ETSICatalog: Patch /vnf_packages/(vnfPkgId) note over ETSICatalog: Updates the information of the VNF package ETSICatalog->SOL003_Adapter>Client: 204 No Content end note over ETSICatalog: Filter Subscriptions alt Filted by Subscriptions.filters.vnfProductsFromProviders/vnfdId/vnfPkgId ETSICatalog->SOL003_Adapter>Client: Post /URI-is-provided-by-the-client ETSICatalog<-SOL003_AdapterClient: 204 No Content end @enduml |
2.2 Subscribe API example:
| Code Block | ||
|---|---|---|
| ||
curl -X POST
http://{{baseUrl}}/api/vnfpkgm/v1/subscriptions
-H 'Content-Type: application/json'
-d '{
"filters": {
"notificationTypes": [
"VnfPackageChangeNotification"
],
"vnfdId": [
"uuid_vnfdid"
]
},
"callbackUri": "http://www.vnf1.com/notification",
"authentication": {
"authType": [
"BASIC"
],
"paramsBasic": {
"userName": "username",
"password": "userpwd"
}
}
}' |
2.3 Notification API example:
POST URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageChangeNotification
For this example, the URI provided by client is http://www.vnf1.com/notification according to the subscription request above.
| Code Block |
|---|
curl -X POST -u username:userpwd
http://www.vnf1.com/notification
-H 'Content-Type: application/json' \
-d '{
"id":"notify_id",
"notificationType":"VnfPackageChangeNotification",
"timeStamp":"2019-12-16 14:41:16",
"vnfPkgId":"vnfPackage_uuid",
"vnfdId":"uuid_vnfdid",
"subscriptionId":"subscription_id",
"changeType":"OP_STATE_CHANGE",
"operationalState":"ENABLED",
"_links":{
"subscription":{
"href":"http://subscriptionuri"
},
"vnfPackage":{
"href":"http://vnfPackageuri"
}
}
}' |
3. Client APIs
The client should implement the followed APIs when creating the subscription: