Page History

Table of Contents

References

Jira

server	ONAP Jira
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1616

Notifications and Subscriptions

CM Data Notification Subscription LCM (incl. merge)

Impl. Proposal CM Event Subscription LCM: Create Create Subscription CM Event

Jira

server	ONAP Jira
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1776

...

Jira

...

server

...

ONAP Jira

...

Interface

...

Requirement

...

Additional Information

...

serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-2251

Error Handling

#	Error Scenario	Expected behavior

Capabilities

...

#

...

Parameter

...

Expectation

...

Out-of-scope

Working with wildcards and subscription update which will be taken care by a separate epic.
Subscription create ( done as part of a different story )
Merging of the ongoing subscriptions.

Assumptions

The whole subscription event is deleted

#	Issue	Notes	Decisions
1	Delete use case works for a valid ongoing subscription only.
2	Works only for the passthrough datastores.

Issues & Decisions

The subscription delete request

#	Issue	Notes	Decisions
1	Delete the subscription from the database?	When do we actually delete the subscription from CPS DB ? We 24 Jun 2024 We plan to do it when we receive response from the DMI plugins and the underlying subscriptions from the devices are deleted.
2	What do we need to send to the DMI Plugin so that they are able to decide that how to delete the ongoing subscription.	subscription name + client id + cmhandle ids? + cmhandle properties? + datastore?	24 Jun 2024 We are sending cmHandle information and predicates information ( datastore , xpaths and cmHandle ) and private cmHandle properties.
3	Who	3	should be able to retry and make sure the subscriptions are deleted from the respective DMIs managing the devices.	kieran mccarthy The agenda for the next meeting. We can decide then. More on the "DELETING" stage ( if we want to have it )	kieran mccarthy As discussed on 17 Jul 2023	, The DME should be able to maintain Subscription State and make decision when to retry based on the response outcome we provide to it for create and/or delete use cases.

Overview


4	DME to NCMP Event to have targets and datastore-xpath-filter information for the subscription delete use case ?	17 Jul 2024 DME to only send the subscription id inorder to delete the request. NCMP will figure out the details corresponding to the provided subscription id and figure out what to request to DMI Plugin for deletion.	kieran mccarthy As per the discussion today 25 Jul 2023 we agreed to use targets , datastore-xpath-filters and datastores for the subscription delete use case. 17 Jul 2024 Revised approach is mentioned in the Notes section.
5	Do we send additional properties from NCMP to DMI	24 Jun 2024 We are sending additional/private properties as of now.
6	Can the DMI Plugin REJECT the Cm Subscription Delete Request ?	kieran mccarthy Wanted to check if this is the VALID use case we have ?

Algorithm for CM Subscription Delete

PlantUML Macro

title	Cm Subscription Delete Algo

@startuml
'https://plantuml.com/activity-diagram-beta

start
: DME to send Cm Subscription Delete Request;
: NCMP to extract out subscriptionId;
: using subscriptionId , Query all the ONGOING ACTIVE Cm Subscriptions;
: Populate details in Cm Notification Subscription Cache;
if (all the Subscription predicates are part of other ongoing Subscriptions ) then (YES)
  : directly delete the subscriptionId from the ongoing subscribers list from DB;
  : mark the subscription delete request as ACCEPTED in the cache;
  : respond back to the client with ACCEPTED ;
else (NO)
 : for all the 'last lights out' predicate information call the DMI Plugin;
 if (DMI Plugin accepts the delete request) then (YES)
    : using the information present in cmNotificationSubscriptionCache, delete the records from DB;
    : mark the subscription delete request as ACCEPTED in the cache;
    : respond back to the client with ACCEPTED;
 else (NO)
    : dont delete any records from DB;
    : mark the subscription delete request as REJECTED in the cache;
    : respond back to the client with REJECTED;
 endif
endif
: cleanup the cache;

stop

@enduml

Capture Incoming subscriptionId from the client.
Query the existing subscriptions we are tracking using the subscriptionId we got from the Cm Subscription Delete request.
Populate the cmSubscriptionCache with the relevant details ( this will be later used to send the response and manage the subscription ) using the above query we did.
Now check if the details we have are ALL the last subscribers or not.
1. if all are NOT the last subscribers then we can right away delete it from the DB and send back the response to the client without sending any request to the DMI.
2. if we have mixed records then we need to make a call to the DMI for the "last lights out" to get Acceptance from DMI
if DMI accepts it , then whatever we have in the cache can be used to DELETE the rows from the DB ( similar to what we did for create )
Once the rows are deleted then we can send back the response to the client and clear up the cache ( for ACCEPTED/REJECTED )
We receive an event of type : subscriptionDeleted from the client ( DME ) containing the subscription clientId and subscription name along with datastore and dataCategory details ( DMEtoNCMP )
We check in NCMP that we have an ongoing subscription using clientId and subscriptionName.
If we have ongoing subscription , we forward the event to dmi-plugins so that the changes are applied in the devices managed by dmi-plugin as well. ( Delete Subscription CM Event )
Now if the dmi-plugins have applied the request then we get an event back from dmi-plugin and NCMP will process that event and based on that it will delete the ongoing subscription request from the database itself. If the response from DMI plugins is accepted ( i.e it can delete the subscriptions from the underlying devices and no subscription delete request are in PENDING or REJECTED state )Then we delete the subscriptions from the DB as well. ( Delete Subscription CM Event )
After processing the received event from DMI , NCMP will send the final event to the client (DME). ( Delete Subscription CM Event )

Subscription Delete Sequence Diagram

PlantUML Macro

align	center
title	Subscription CmSubscription Delete Exclusive Usecase

@startuml "Subscription Delete"

actor rApp as "rApp/Client"autonumber

participant DME
participant NCMP
participant DMI_PLUGIN"CPS-DB"
participant "DMI-PLUGIN"

rAppDME --> DME
DME - NCMP : 'Request to delete the CmSubscription using subscriptionId'
NCMP --> NCMP : 1. Incoming subscriptionDelete event 'Check if the CmSubscription is fully shared or exclusive per DMI'
NCMP --> "DMI_-PLUGIN" : 2. ncmp to forward event to dmi plugin
DMI_PLUGIN -> DMI_PLUGIN: 3. Apply the requested event and respond with the status
DMI_PLUGIN'for exclusive CmSubscription(part of the subscription) notify the "DMI-PLUGIN"s to ACCEPT/REJECT the subscription'
"DMI-PLUGIN" --> NCMP : 'Request ACCEPTED by "DMI-PLUGIN"'
NCMP --> "CPS-DB" : 'Delete the CmSubscription from the database and update the cache with ACCEPTED'
NCMP --> DME : 'Respond with the status as ACCEPTED'

@enduml

PlantUML Macro

title	CmSubscription Delete Shared Usecase

@startuml
autonumber

participant DME
participant NCMP
participant "CPS-DB"

DME --> NCMP : 4.'Request Statusto ofDelete the subscriptionDeleteCmSubscription request whether accepted/rejected/pendingusing subscriptionId'
NCMP --> NCMP : 5. If all accepted then only remove the subcription data from DB 'Check if the CmSubscription is fully SHARED or EXCLUSIVE per DMI'
NCMP --> NCMP : 'for SHARED CmSubscription dont notify the "DMI-PLUGIN"s'
NCMP --> DME"CPS-DB" : 6. Respond with'Delete the CmSubscription from the statusdatabase thatand weupdate receivedthe fromcache dmiwith pluginACCEPTED'
DMENCMP --> rApp



@enduml DME : 'Respond with the status as ACCEPTED'

@enduml

Schema Definitions

DME to NCMP

...

Cm Subscription Delete

...

Request

Name
Parent
Type
Example
Mandatory ?
Notes
1 id header String
Y
2 version header String 1.0 Y
3
source
header String DME Y
4
type
header String subscriptionDeleteRequest Y
5
dataschema
header URI

org.onap.ncmp.cm.subscription:1.0.0

...

Y
6

...

data

Object
Y
7
subscriptionId
data String

cm-subscription-001

...

}

"javaType": "org.onap.cps.ncmp.events.avcsubscription1_0_0.client_to_ncmp"

NCMP to DMI-Plugins

...

	Y
8	predicates	data	Object		N

Example

Code Block

title	DME to NCMP Cm Subscription Delete Request
linenumbers	true
collapse	true

id : random-UUID
version : "1.0"
source : "DME"
type : "subscriptionDeleteRequest",
dataschema : org.onap.ncmp.cm.subscription:1.0.0  {
  "data": {
    "subscriptionId": "unique subscription id" // mandatory
}

NCMP to DMI-Plugin Subscription Request

	Name	Parent	Type	Example	Mandatory ?	Notes
1	id	header	String		Y
2	version	header	String	1.0	Y
3	source	header	String	NCMP	Y
4	type	header	String	subscriptionDeleteRequest	Y
5	dataschema	header	URI	org.onap.ncmp.dmi.cm.subscription:1.0.0	Y
6	correlationid	header	String	subscriptionId#dmiPluginName	Y	Concatenation of subscriptionId and dmi plugin name
7	data		Object		Y
8	cmHandles	data	Array		Y
9	cmhandleId	cmHandles	String		Y
10	privateProperties	cmHandles	Map		N
11	predicates	data	Array		N
12	targetFilter	predicates	Array of String		Y	list of cm handle ids
13	scopeFilter	predicates	Object		N
14	datastore	scopeFilter	String		Y	ncmp-datastore:passthrough-operational OR ncmp-datastore:passthrough-running
15	xpathFilter	scopeFilter	Array of String		Y

Example

Code Block

title	NCMP to DMI-Plugin Subscription Request
linenumbers	true
collapse	true

id : random UUID
version : 1.0
source : "NCMP"
type : "subscriptionDeleteRequest"
dataschema :

...

org.onap.ncmp.dmi.cm.subscription:1.0.0

...


correlationId ( concatenation of subscriptionId and dmi-plugin-name with a separator)
 
{
  "data":

...

DMI-Plugins to NCMP

...

 {
    "cmhandles" : [ // mandatory
    {
        "cmHandleId": "cmhandle1",
        "private-properties": {...}
    },
    {
        "cmHandleId": "cmhandle2",
        "private-properties": {...}
    },
    {
        "cmHandleId": "cmhandle3",
        "private-properties": {...}
    }
    ]
    "predicates": [
    {
        “targetFilter” :  [“cmHandle1”, “cmHandle2”, "cmhandle3"], // mandatory
        "scopeFilter" : {
           "datastore": “ncmp-datastore:passthrough-operational or ncmp-datastore:passthrough-running", // optional. default is passthrough-operational
           "xpath-filter": list of valid xpaths  // mandatory
      }
    },  
    {
        “targetFilter” :  [“cmHandle1”, “cmHandle2”, "cmhandle3"],
        "scopeFilter" : {
           "datastore": “ncmp-datastore:passthrough-operational or ncmp-datastore:passthrough-running", // optional. default is passthrough-operational
           "xpath-filter": list of valid xpaths  *
      }
    }
  ]
}

DMI-Plugin to NCMP Cm Subscription Delete Response

Name
Parent
Type
Example
Mandatory ?
Notes
1 id header String
Y
2 version header String 1.0 Y
3
source
header String DME Y
4
type
header String subscriptionDeleteResponse Y
5
dataschema
header URI

...

org.onap.ncmp.dmi.cm.subscription:1.0.0 Y
6

...

Notes

dmiName in Output Schema is populated from application.yml of DMI-plugin.
DMI-plugin subscribes to the topic to consume Input Schema given in application.yml of DMI-plugin.

...

dmi:
    service:
        name: ${DMI_SERVICE_NAME:ncmp-dmi-plugin}
app:
    dmi:
        avc:
            subscription-topic: ${DMI_CM_AVC_SUBSCRIPTION:ncmp-dmi-cm-avc-subscription-${dmi.service.name}}

NCMP to DME

Produced by NCMP to send it to the Client-Apps

...

correlationid	header	String	subscriptionId#dmiPluginName	Y	Concatenation of subscriptionId and dmi plugin name
7	data		Object		Y
8	statusCode	data	String		Y	1 - Accept the subscription request 104 - Reject the subscription request
9	statusMessage	data	String		Y	ACCEPTED REJECTED

Example

Code Block

title	DMI-Plugin to NCMP Cm Subscription Delete Response
linenumbers	true
collapse	true

id : random UUID
version : "1.0"
source : <dmi-plugin-name>
type : "subcriptionDeleteResponse"
dataschema : org.onap.ncmp.dmi.cm.subscription:1.0.0
correlationid : ( concatenation of subscriptionId and dmi-plugin-name with a separator)
{
"data" : {
   "statusCode": "1/104",  // mandatory
   "statusMessage" : "ACCEPTED/REJECTED" // mandatory
 }
}

NCMP to DME Cm Subscription Delete Response

Name
Parent
Type
Example
Mandatory ?
Notes
1 id header String
Y
2 version header String 1.0 Y
3
source
header String DME Y
4
type
header String subscriptionDeleteResponse Y
5
dataschema
header URI

org.onap.ncmp.cm.subscription:1.0.0

...

	Y
6	correlationid	header	String	subscriptionId	Y
7	data		Object		Y
8	subscriptionId	data	String		Y
9	acceptedTargets	data	Array of String		N
10	rejectedTargets	data	Array of String		N
11	pendingTargets	data	Array of String		N

Example

Code Block

title	NCMP to DME Cm Subscription Delete Response
linenumbers	true
collapse	true

id : random UUID
version : "1.0"
source : "NCMP"
type : "subcriptionDeleteResponse",
dataschema : org.onap.ncmp.cm.subscription:1.0.0,
correlationid : <subscriptionId> {
  "data": {
        "subscriptionId": "sample-subscription-id", // mandatory
        "acceptedTargets" : ["ch-1", ...], // optional
        "rejectedTargets" : ["ch-1", ...], // optional
        "pendingTargets" : ["ch-1", ...],  // optional
  }
}

Space shortcuts

Page tree

Versions Compared

Old Version 28

New Version Current

Key

References

Error Handling

Capabilities

Out-of-scope

Assumptions

Issues & Decisions

Overview

Algorithm for CM Subscription Delete

Subscription Delete Sequence Diagram

Schema Definitions

NCMP to DMI-Plugins

DMI-Plugins to NCMP

Notes

NCMP to DME

Produced by NCMP to send it to the Client-Apps