CPS-1065 Spike: CM data notifications from NCMP to applications including subscriptions

References

CPS-1065 - Getting issue details... STATUS

Open Issues & Decisions

#	Issue	Notes	Decision
1	List scenarios	Need to clarify scenarios	Refer to Internal study
2	Topics	what topics are used in what scenario (topic for each Datastore ?)	See Topics section below. All NCMP notifications to be published on the public cm-events topic by default regardless of data type, notification type or datastore the change came from. This topics acts as the TBAC_ALL topic. cm-events topic name should be configurable in deployment settings. Future : In future NCMP shall publish the notification based on TBAC where the notification is published on the appropriate target group topic cm-events[-<target-group-name>] matching the target group(s) the data type(s) is associated with. Not in scope of this story.
3	Handle unknown event schemas	Wrap event?	Unsupported for now. Thrown exception and log error.

Event Flow Sketch

CM Event Specification Outline

{

  "eventId"          : "9999",           # some generic event uuid generated by DMI Plugin
“eventCorrelationId”      : “cmhandleId-001”, # cmhandleId used for event correlation
"eventTime"          : "2021-11-16T16:42:25-04:00",
  "eventSource"           : "org.onap.ncmp",
  "eventType"           : "org.onap.ncmp.cm-network-avc-event", # event type for async request response events
  ”eventSchema” : “rfc8641",       # event schema for async request response events
  ”eventSchemaVersion” : “v1", # event schema version

"event": {
<RFC 8641-yang-datastore-notification-payload> # See next slide for example
}

}

RFC 8641 : yang-datastore notification definition

notifications:

+---n push-update

| +--ro id? sn:subscription-id

| +--ro datastore-contents? <anydata>

| +--ro incomplete-update? empty

+---n push-change-update {on-change}?

+--ro id? sn:subscription-id

+--ro datastore-changes

| +--ro yang-patch

| +--ro patch-id string

| +--ro comment? string

| +--ro edit* [edit-id]

| +--ro edit-id string

| +--ro operation enumeration

| +--ro target target-resource-offset

| +--ro point? target-resource-offset

| +--ro where? enumeration

| +--ro value? <anydata>

+--ro incomplete-update? empty

'operation' type definition

Event Payload Example

Proposed CM event

{

  "eventId" : "9999", # some generic event uuid generated by DMI Plugin
“eventCorrelationId” : “cmhandleId-001”, # cmhandleId used for event correlation
"eventTime" : "2021-11-16T16:42:25-04:00",
  "eventSource" : "org.onap.ncmp",
  "eventType" : "org.onap.ncmp.cm-notification-event", # event type
  ”eventSchema” : “org.onap.ncmp:cm-notification-event", # event schema
”eventSchemaVersion” : “v1", # event schema version

"event": {

"push-change-update" : {

"datastore-changes" : {
"ietf-yang-patch:yang-patch" : {
"patch-id" : "34534ffd98", # Some unreadable patch id generated by the machine
"edit" : [
{
"edit-id" : "ded43434-1",
"operation" : "create",
"target" : "/_3gpp-common-managed-element:ManagedElement=Kista-001/_3gpp-nr-nrm-gnbdufunction:GNBDUFunction=1/_3gpp-nr-nrm-nrcelldu:NRCellDU=1",
"value" : {
"_3gpp-nr-nrm-nrcelldu:NRCellDU" : [
{
"id" : 1,
}
]
}
},

{
"edit-id" : "ded43434-1-1",
"operation" : "create",
"target" : "/_3gpp-common-managed-element:ManagedElement=Kista-001/_3gpp-nr-nrm-gnbdufunction:GNBDUFunction=1/_3gpp-nr-nrm-nrcelldu:NRCellDU=1/attributes",
"value" : {
"attributes" : {
"cId" : 511,
"userLabel" : "some-cell-label",
...
}
}
},

{
"edit-id" : "ded43434-2",
"operation" : "create",
"target" : "/_3gpp-common-managed-element:ManagedElement=Kista-001/_3gpp-nr-nrm-gnbdufunction:GNBDUFunction=1/_3gpp-nr-nrm-nrcelldu:NRCellDU=1/attributes/pLMNIdList=35301",
"value" : {
"_3gpp-nr-nrm-nrcelldu:pLMNIdList" : [
{
"mcc" : 353,
"mnc" : "01",
...

}

}
]
}
},
{
"edit-id" : "ded43434-3",
"operation" : "merge",
"target" : "/_3gpp-common-managed-element:ManagedElement=Kista-001/_3gpp-nr-nrm-gnbdufunction:GNBDUFunction=1/_3gpp-nr-nrm-nrcelldu:NRCellDU=3/attributes",
"value" : {
"attributes" :
{
"cId" : 412,
"userLabel" : "yet-another-cell-label",
...
}
}
},
{
"edit-id" : "ded43434-4",
"operation" : "delete",
"target" : "/_3gpp-common-managed-element:ManagedElement=Kista-001/_3gpp-nr-nrm-gnbdufunction:GNBDUFunction=1/_3gpp-nr-nrm-nrcelldu:NRCellDU=4"
}
]
}
}
}

}
}

CM Change Event Subscription Proposal

Create Subscription

The Create Subscription flow is as follows :

Create Subscription Format

Create Example

{
"version": "<event type version>",
"eventType": "subscriptionCreated",
"event": {
"subscription": {
"clientID": "<unique identifier for the client >",
"name": "<unique subscription name per client>",
"isTagged": "<yes|no>, optional parameter, default is no"
},
"dataType": {
"dataspace": "<data space>",
"dataCategory": "<data category type>",
"dataProvider": "<data provider type>"
"schemaName": "<schema name>"
"schemaVersion": "<schema version>"
},
"predicates": {
"<parameter>": "<value>",
"param2": [
"value21",
"value22"
]

}
}
}

{
"version": "1.0",
"eventType": "subscriptionCreated",
"event": {
"subscription": {
"clientID": "SCO-9989752",
"name": "cm-subscription-001"
},
"dataType": {
"dataspace": "ALL",
"dataCategory": "CM",
"dataProvider": "CM-SERVICE"
"schemaName": "org.onap.ncmp.cm-notification-event"
"schemaVersion": "1.0"
},
"predicates": {
"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//”

}
}
}

Update Subscription

Topics

Topic types

Topic Name	Description	Direction
cm-avc[-<targetgroup>]	topic for publication of events from NCMP to clients (suggest to rename existing topic from 'ncmp-events' to cm-avc). In preparation to future needs the there may be separate topics for different security groups. NCMP solution should consider this in its design this upfront. By default cm-avc is the default topic where ALL events are published by default. Different client may subscribe to different topics (ALL and/or target group specific). It is their responsibility to subscribe to the appropriate topics as new target groups come into existance. For now the only topic in scope of this story is the 'cm-avc' topic.	ncmp → client consumer
dmi-cm-events	internal topic for communications between dmi-plugin ↔ ncmp for avc and subscription events	ncmp→ dmi
cm-avc-subscription	topic for avc event subscriptions. This topic may be (pre)defined external to NCMP. If externally defined topic then it shall be possible to tell NCMP the topic name and where to find it.	client → ncmp
cm-avc-dmi-subscription	topic for avc event subscriptions event toward dmi plugin(s). This topic is internally defined by NCMP. All CM AVC subscriptions will be sent from NCMP to DMI plugins via this topic.	ncmp → dmi for subscription LCM dmi → ncmp register device subscription in cmhandle

Topic partitioning

All events for the same cmhandleId should be sent to the same partition. This will guarantee ordering. Ordering is only guaranteed per topic, not across topic (future consideration).