Versions Compared

Old Version 23

changes.mady.by.user Toine Siebelink

Saved on

compared with

New Version Current

changes.mady.by.user Priyank Maheshwari

Saved on

Key

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

Table of Contents

Introduction

This page given an high level overview of Notifications used by CPS/NCMP for communication wit system outside CPS/NCMP about data changes.
There are also notifications used for asynchronous  method calls but there are kept out this overview for the sake of simplicity.


See also: CPS-1489: Overview of Kafka Topics in CPS Components

Component Diagram

Gliffy Diagram
macroId968c4ebd-26d8-425e-b89d-e858df3851f3
displayNameCPS Notifications Overview
nameCPS Notifications Overview
pagePin27


Event Descriptions

#DescriptionSourceTopicDestinationTriggerR12 Work ItemCloud
Event		Notes
1
CPS-Temporal data updatesCPS-Corecps.data-updated-events
CPS
-
Temporal
CPS-Core Data UpdateN/A
  1. On by default for all dataspaces! Populate notification.data-updated.filters.enabled-dataspaces to turn it off see
    Jira
    serverONAP Jira
    columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyCPS-1361
, Removed







2NCMP CM-Handle LCM (LifeCycle Management) eventsNCMP

ncmp-events

External (NCMP) ClientsNCMP CM-Handle State Change
(registration use-case)		N/ANo*
  1. See also CM-Handle State Changes and Notifications Overview
  2. On by default, can be disabled using notification.enabled
  3. AlternateId has been added (Spring 2024)
  4. *Cloud Version Pending (blocked by Ericsson as it is backward incompatible) see https://gerrit.onap.org/r/c/cps/+/137080
3NCMP Data AVC (forwarding #5)NCMP
  • determined by ncmp-subscription(s) 
  • 0-n topics possible*
External (NCMP) ClientsDMI Data AVC on passthrough datastore & NCMP Subscription#6a

No

The notifications should be on the set of topics specified by the union of all relevant subscriptions. This is why there is a difference between the subscription model (visible to a client/subscriber) and the subscription model used internally – The notification should not need to calculate, only look up the set of topics to emit on.
One cm-handle can have 0-many topics
The 'predicate' information is only to be forwarded to the DMI Plugin does not need to be stored (TBC with kieran mccarthy )

4CPS-Core Data AVCCPS-Core
  • determined by cps-core-subscription(s) 
  • 0-n topics possible*
External ClientsData Change & CPS-Core Subscription#7No

Any client can subscribe to CPS-Core for any data subscription. The subscription wil include the topic to be used

5DMI Data AVC (Attribute Value Change)DMI-PluginTBDNCMPDepends on DMI-Plugin
  • ONAP: VES Events from Device
#6a
#7		Yes
  1. Format (schema) of the Event is defined by (in) NCMP
  2. Topic names is defined by NCMP
  3. For passthrough datastore NCMP will emit a NCMP Data AVC (#3). Do we need to check tHE Datastore or just the cache enabled flag?
  4. If data is cached this event should lead to a CPS-Core(Cache) update and a CPS-Core Data AVC (#4)
6VES EventONAP Devices
ONAP DMI PluginChange on Device#7No
  1. Open issue: how to translate an ONAP device ID to a CM Handle ID?!

In-Progress

7Notification Subscription EventDME
(Data Mgmt and Exposure)
cm-avc-
subscriptionNCMPUser driven? CRUD operation Notification Subscriptions#6bYes

See also

The source can be anything that is authorized and knows the subscription event schema. It will be up to the encapsulating 'product' e.g. ONAP to decide if applications should use this interface directly. 

From NCMP perspective this is an access control challenge – If you are authorized to write to the cm-avc-subscription topic, NCMP will react

8Proprietary AVCProprietary DevicesN/AProprietary DMI PluginChange on DeviceN/ANoIrrelevant to ONAP Solution might not even by an 'event'. As long as it can be converted into a DMI Data AVC (#5)
9VES EventORAN Devices
Proprietary DMI PluginChange on Device
No

Similar to #6 above. Main fields:

  • href → can be mapped to cm-handle by plugin (without additional information from other fields)

Component Diagram

...

  • path → can be mapped to xpath by plugin 

In-Progress

10BatchOperationNCMPClient Provided TopicExternal Clients

Yes


11TrustLevel ChangesDMI
dmi-device-heartbeat
NCMP

Yes


12NCMP-AVC EventNCMP
cm-events
External Clients

Yes

April 2024,: Only used to forward TrustLevel Changes

13aDMI-CM EventDMI/Devicesdmi-cm-eventsNCMPAny change in the configuration in the devices
Yes

This is to notify NCMP about any CM change that happened in the network.

This event is also supposed to be used together with the Cm Subscriptions( to route to the defined topic - future work )

13bCm Data ChangeNCMPcm-eventsExternal ClientsAny change in the configuration in the devices and NCMP forwards to this topic
Yes

Whatever event is received from 13a is been forwarded by NCMP to external clients.

...