CPS Data Notifications Overview

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



Event Descriptions

#

Description

Source

Topic

Destination

Trigger

Cloud
Event

Notes

#

Description

Source

Topic

Destination

Trigger

Cloud
Event

Notes

1

CPS Temporal, Removed















2

NCMP CM-Handle LCM (LifeCycle Management) events

NCMP

ncmp-events

External (NCMP) Clients

NCMP CM-Handle State Change
(registration use-case)

N/A

No*

  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

3

NCMP Data AVC (forwarding #5)

NCMP

  • determined by ncmp-subscription(s) 

  • 0-n topics possible*

External (NCMP) Clients

DMI 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 )

4

CPS-Core Data AVC

CPS-Core

  • determined by cps-core-subscription(s) 

  • 0-n topics possible*

External Clients

Data Change & CPS-Core Subscription

#7

No

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

5

DMI Data AVC (Attribute Value Change)

DMI-Plugin

TBD

NCMP

Depends 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)

6

VES Event

ONAP Devices



ONAP DMI Plugin

Change on Device

#7

No

  1. Open issue: how to translate an ONAP device ID to a CM Handle ID?!

In-Progress

7

Notification Subscription Event

DME
(Data Mgmt and Exposure)

subscription

NCMP

User driven? CRUD operation Notification Subscriptions

#6b

Yes

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

8

Proprietary AVC

Proprietary Devices

N/A

Proprietary DMI Plugin

Change on Device

N/A

No

Irrelevant to ONAP Solution might not even by an 'event'. As long as it can be converted into a DMI Data AVC (#5)

9

VES Event

ORAN Devices



Proprietary DMI Plugin

Change on Device



No

Similar to #6 above. Main fields:

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

  • path → can be mapped to xpath by plugin 

In-Progress

10

BatchOperation

NCMP

Client Provided Topic

External Clients





Yes



11

TrustLevel Changes

DMI

dmi-device-heartbeat

NCMP





Yes



12

NCMP-AVC Event

NCMP

cm-events

External Clients





Yes

April 2024,: Only used to forward TrustLevel Changes

13a

DMI-CM Event

DMI/Devices

dmi-cm-events

NCMP

Any 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 )

13b

Cm Data Change

NCMP

cm-events

External Clients

Any 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.