Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

#

Issue

Notes

Decisions

1

Schema of the outcome response message (Schema 5)

Open Questions:

  1. What headers do we need?
  2. Do we need all Accepted, Rejected, Pending targets?

2dataType section needs to be confirmed.kieran mccarthy  to confirm for all the events.
3Grouping of the response for rejected and pending to be finalized.

Overview

// End to end solution in plaintext can be put in here.

  1. NCMP will receive the Subscription Request from EDM in the form of an Event.
  2. NCMP will be responsible for the below operations. ( Consumer Code for EDM Event )
    1. Since NCMP already knows the structure of the incoming subscription request it will map the incoming request to java object.
    2. Persist the request in the subscription-registry model which we already introduced.
  3. NCMP ( Producer Code and Record the published time ) 
    1. Enrich the request with the additional properties and a proper dmiRequestId ( subscriptionId+subscriptionName+dmiServiceName)
    2. Save the dmiRequestId in the distributed map along with the current-time. ( we can call it published time ) . This will be useful at a later point in time.
    3. Now forward the subscription request to the dmi-plugins based on the incoming target cmHandles we have. ( Since we have the information that which dmi-plugin is responsible for which cmHandle , we can figure this out ).
      1. At this level we could have forwarded the event to multiple dedicated topics.
  4. DMI-Plugin
    1. It will have a consumer code to listen from a particular topic.
    2. It will translate the event so that it is able to extract the important information from the event.
    3. DMI-Plugin is responsible to talk to the underlying Nodes it is managing inorder to register the subscription ( i.e provide the predicate information )  NOTE : We will skip this part in the onap-dmi-plugin implementation.
    4. DMI-Plugin will respond back with the response as accepted / rejected. We will have a response format which will be discussed in the dedicated place.
  5. NCMP ( Consumer for DMI-Plugin Response ) 
    1. We should continuously be checking if the published time has elapsed for that subscription response and we don't have to wait before sending the response back to the consumer. ( possibly we can discuss a solution using Hzaelcast TTL feature ) 
    2.  The incoming message will have the dmiRequestId which we can match in the map and check if the timer condition is satisfied ( i.e if the message arrives before the configured time and there are other pending requests , then we wait)
      1. if we contact multiple dmi plugins and all respond back within time then we collect the response from all of them and send a collective response and we dont have to wait for pre-configured time.
      2. if we contact multiple dmi plugins and none of them respond back within time then we respond as and when we recieve the response from them. 
      3. if we contact multiple dmi plugins and some of them respond back then we wait for preconfigured time and collect the response. We respond back with what we have till the cutoff time and then later when we receive the events we will send them through.

...

Code Block
languagebash
titleSubscription Create Event (Schema 1)
topic subscription

id generated by client
source "SCO-9989752"
specversion  "1.0"
type subscriptionCreated
time
dataschema org.onap.ncmp.cm.subscription:1.0.0
data

{
  "data": {
    "subscription": {
      "clientID": "SCO-9989752",
      "name": "cm-subscription-001"
    },
    "dataType": {
      "dataspace": "ALL",
      "dataCategory": "CM",
      "dataProvider": "CM-SERVICE"
    },
    "predicates": {
                   “targets” :  [“cmHandle1”, “cmHandle2”, “cmHandle3”]     #  cmhandle targets
        "datastore": “passthrough-operational",
        "datastore-xpath-filter": "//_3gpp-nr-nrm-gnbdufunction:GNBDUFunction/ 
             _3gpp-nr-nrm-nrcelldu:NRCellDU/ | //_3gpp-nr-nrm-gnbcuupfunction:GNBCUUPFunction// |
            //_3gpp-nr-nrm-gnbcucpfunction:GNBCUCPFunction/_3gpp-nr-nrm-nrcelldu:NRCellCU// |
            //_3gpp-nr-nrm-nrsectorcarrier:NRSectorCarrier//”  
 
    }
}

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


NCMP saves in CPS

...


Code Block
languagetext
titlePersisted Subscription Information (Schema 2)
{
	"clientID": "SCO-9989752",
    "subscriptionName": "cm-subscription-001"
	"isTagged" : "true" #optional
	"predicates": {
		"targetCmHandles":[
			{"cmHandleId":"cmHandle1", "status":"pending"},
			{"cmHandleId":"cmHandle2", "status":"pending"},
			{"cmHandleId":"cmHandle3", "status":"pending"}
		]
		"datastore":"passthrough-operational"
	}
	
}

// Show input and output schema

// Any logic if we want to discuss and make decision


NCMP to DMI-Plugins

Halil Cakal 

Code Block
languagetext
titleInput Schema (Schema 3) - Produced by NCMP and Consumed by DMI Plugins
topic: ncmp-dmi-cm-avc-subscription-dminame1

id uuid
source "SCO-9989752"
specversion  "1.0"
type subscriptionCreated
time // ncmp will generate
dataschema org.onap.ncmp.dmi.cm.subscription:1.0.0
data

{
"data":{
      "subscription":{
         "clientID":"SCO-9989752",
         "name":"cm-subscription-001",
         "isTagged":false
      },
      "dataType":{
         "dataspace":"ALL",
         "dataCategory":"CM",
         "dataProvider":"CM-SERVICE"
      },
      "predicates":{
         "targets":[             
			{"id" : <cmhandleid>,
             "additional-properties": ["shape":"circle"]},    
            {"id" : <cmhandleid>,
             "additional-properties": ["shape":"triangle"]},    
            {"id" : <cmhandleid>,
             "additional-properties": ["shape":"square"]}
         ],
         "datastore":"passthrough-running",
         "datastore-xpath-filter":"//_3gpp-nr-nrm-gnbdufunction:GNBDUFunction/_3gpp-nr-nrm-nrcelldu:NRCellDU/ | //_3gpp-nr-nrm-gnbcuupfunction:GNBCUUPFunction// | //_3gpp-nr-nrm-gnbcucpfunction:GNBCUCPFunction/_3gpp-nr-nrm-nrcelldu:NRCellCU// | //_3gpp-nr-nrm-nrsectorcarrier:NRSectorCarrier//"
      }
   }
}

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

...

Code Block
languagetext
topic: subscription-response

id uuid - generated by NCMP
source <NCMP>
specversion  "1.0"
type subscriptionCreatedStatus
time // NCMP would generate
correlationid: clientId:subscriptionName
dataschema org.onap.ncmp.cm.subscription:1.0.0
data

{
  "data": {
       “statusCode” : 207,  # Some error code reflecting partial success.  **   //  To be discussed with the whole team
       “statusMessage” : “Partially Applied Subscription”,
       “additionalInfo” : {
           “rejected” :  [{
                “details” : “faulty subscription format for target(s)”, // need to finalize the detailed message for grouping.
                “targets” : [“cmhandle1”, “cmhandle2”, “cmhandle3”]
           },
			{
                “details” : “faulty subscription format for target(s) - xyz”, // need to finalize the detailed message for grouping.
                “targets” : [“cmhandle1”]
           }
],
           “pending” : {
                “details” : “EMS/node connectivity issues, retrying”,
                “targets” : [“cmhandle4”, “cmhandle5”, “cmhandle6”]
       }
  }
}

// we dont have to send the accepted cmhandle details.
 
** 202 could indicate complete failure – 
    "data": {
       “statusCode” : 406,  # Some error code reflecting complete rejection of the request
       “statusMessage” : “Subscription rejected : Faulty Subscription Data”,
       “additionalInfo” : {
           “rejected” :  {
                “details” : “//NRxxCellDU is not a valid subscription type”
           },

Have another for Pending CMHandles gone to accepted

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

Open Question: what headers do we need?

// Draw architecture diagram

// Show input and output schema

...


Implementation proposal of DMI Response Timeout

...