Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 20 Next »

References

Error rendering macro 'jira' : Unable to locate Jira server for this macro. It may be due to Application Link configuration.

Open Issues & Decisions

#IssueNotesDecision
1

should dataspaceName be given another name?

dataspaces are private to an application (e.g. NCMP) they should not be shared

kieran mccarthy what do you mean by dataspaceName?

omit for now - put in later if needed/required.
2should schema urn be generalized, how might it impact publication to ORAN R1?

The schema of the payload is dictated by the source of the event

kieran mccarthy what do you refer to here?  Ans : the schema refers to 'org.onap'. 
Not sure if this is acceptable in an ORAN R1 specification.

Emailed ORAN guys to identify how to close the gap between ORAN and ONAP.
Not clear if we can publish an onap schema in ORAN!  Waiting on response.

.

Take this discussion separately.
Approach would be to define it in ORAN community first and then come to ONAP to support ORAN schemas

3should "ncmp" be used rather than "cps" in the type definitions

 i.e. org.onap.cps.cmhandle-lcm-event or org.onap.ncmp.cmhandle-lcm-event?

NCMP owns these events, 'cps' should not appear (even if cps is emitting them)

NCMP java classnames begin with org.onap.cps.ncmp – Tony does not care (smile), but Toine does.

kieran mccarthy , where does this type come from?

schema urn should refer to ncmp - not cps.
4should a bulk cmhandle event be supported?

Prefer to delay this decision, but keep it in mind so we do not need to break compatibility to support it.

-- Could be tricky as with horizontal scale NCMP, multiple will be emitting simulatneously

leave out of scope for now
5

should we consider the new state model changes on dmi-registry in the event as well?

CPS-799 Spike: Define states and state handling for CM handle


For now we have cmhandle-state only in the event payload.

But as per the spike(CPS-799) we have some information related to dataSyncState and datastore as well.

Should we be extending this payload to add in more information or we will create a separate schema ?


OR the schema suggested below is sufficient for the event listener.


6should we be introducing a correlationId inside the event payload?

There were few inputs from the team regarding adding a correlationId/cmHandleId inside the event payload itself (so that the event payload becomes self sufficient) and we can use the existing eventCorrelationId for event tracking and can also make it optional.


Eg : 

{
  "eventId"                   : "uuid",        
  "eventCorrelationId  : "random-uuid",      // this can be optional
  "eventTime"              : "2021-11-16T16:42:25-04:00",
  "eventSource"           : "org.onap.ncmp",                                 
  "eventType"              : "org.onap.ncmp.cmhandle-lcm-event",   
  ”eventSchema”         : “org.onap.ncmp:cmhandle-lcm-event:v1",   

  "event": {

     "cmHandleId"           : "cmhandle-001" ,
     “operation”               : “create”,
     “cmhandle-state”      : “READY”
     “cmhandle-properties” : [
          “public-property-name-1” : “public-property-value-1”,
          “public-property-name-2” : “public-property-value-2”     ]
    }
}



Proposal

 Proposed event for cmhandle LCM

{
  "eventId"                   : "00001",        
  "eventCorrelationId  : "cmhandle-001",      
  "eventTime"              : "2021-11-16T16:42:25-04:00",
  "eventSource"           : "org.onap.ncmp",                                 
  "eventType"              : "org.onap.ncmp.cmhandle-lcm-event",   
  ”eventSchema”         : “org.onap.ncmp:cmhandle-lcm-event:v1",   

  "event": {
     “operation”               : “create”,
     “cmhandle-state”      : “ADVISED”
     “cmhandle-properties” : [
          “public-property-name-1” : “public-property-value-1”,
          “public-property-name-2” : “public-property-value-2”     ]
    }
}

Proposal Details

Scope covers the Create, Update and Delete of CM Handles.

Update is required as an application must know when we go from ADVISED to READY state.

cmhandle update event is ONLY sent for publicly available cmhandle metadata. 
Changes to private cmhandle properties will not trigger a cmhandle LCM event.


cmhandle Event TypeDetailEvent
CREATE

Add New CM Handle.
CM Handle added to NCMP with publicCmhandleProperties and is in READY state 


# eventCorrelationId is used for the cmhandleId for 
org.onap.ncmp.cmhandle-lcm-event

"event" payload should include ALL public metadata for the cmhandle where appropriate.

{
  "eventId"                  : "00001",    
  "eventCorrelationId  : "cmhandle-001",       
  "eventTime"              : "2021-11-16T16:42:25-04:00",
  "eventSource"           : "org.onap.ncmp",                                 
  "eventType"              : "org.onap.ncmp.cmhandle-lcm-event",   
  ”eventSchema”         : “org.onap.ncmp:cmhandle-lcm-event:v1",   

  "event": {
     “operation”              : “create”,
     “cmhandle-state”     : “READY”
     “cmhandle-properties” : [
          “public-property-name-1” : “public-property-value-1”,
          “public-property-name-2” : “public-property-value-2”     ]
    }
}

UPDATE

Update cmhandle (e.g. a property update)

# eventCorrelationId contains the updated cmhandleId


modules / schemaSet is not sent in an org.onap.ncmp.cmhandle-lcm-event.

Module upgrade will be addressed separately.

Even if one public metadata property changes, ALL properties are sent in the update event.

If the update cmhandle event was because of a removed/deleted cmhandle public property then that property is simply missing from the list of public cmhandle properties.

{
  "eventId"                  : "00001",    
  "eventCorrelationId  : "cmhandle-001"      
  "eventTime"              : "2021-11-16T16:42:25-04:00",
  "eventSource"           : "org.onap.ncmp",                                 
  "eventType"              : "org.onap.ncmp.cmhandle-lcm-event",   
  ”eventSchema”         : “org.onap.ncmp:cmhandle-lcm-event:v1",   

  "event": {
     “operation”              : “update”,
     “cmhandle-state”     : “READY”
     “cmhandle-properties” : [
          “public-property-name-1” : “public-property-value-1”,
          “public-property-name-2” : “public-property-value-2”     ]
    }
}

DELETE

Delete cmhandle

# eventCorrelationId contains the deleted cmhandleId

{
  "eventId"                  : "00001",    
  "eventCorrelationId  : "cmhandle-001"      
  "eventTime"              : "2021-11-16T16:42:25-04:00",
  "eventSource"           : "org.onap.ncmp",                                 
  "eventType"              : "org.onap.ncmp.cmhandle-lcm-event",   
  ”eventSchema”         : “org.onap.ncmp:cmhandle-lcm-event:v1",   

  "event": {
     “operation”              : “delete”
    }
}
  • No labels