CPS-858 Define notifications on CM handle Add & Delete

References

CPS-858 - Getting issue details... STATUS

Open Issues & Decisions

#	Issue	Notes	Decision
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.
2	should 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
3	should "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 , but Toine does. kieran mccarthy , where does this type come from?	schema urn should refer to ncmp - not cps.
4	should 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

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 Type

Detail

Event

CREATE

Add New CM Handle.
CM Handle added to NCMP in ADVISED state with publicCmhandleProperties

# 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” : “ADVISED”
“cmhandle-properties” : [
          “public-property-name-1” : “public-property-value-1”,
          “public-property-name-2” : “public-property-value-2”     ]
    }
}

UPDATE

Update cmhandle.

# eventCorrelationId contains the updated cmhandleId

cmhandle goes from ADVISED to READY once the schemas are discovered/added for the cmhandle

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”
    }
}