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 | ||||||||
---|---|---|---|---|---|---|---|---|
|
Event Descriptions
# | Description | Source | Topic | Destination | Trigger | R12 Work Item | Cloud Event | Notes |
---|---|---|---|---|---|---|---|---|
1 |
cps.data-updated-events
- On by default for all dataspaces! Populate
notification.data-updated.filters.enabled-dataspaces
to turn it off seeJira server ONAP Jira columnIds issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId 425b2b0a-557c-3c0c-b515-579789cceedb key CPS-1361
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* |
|
3 | NCMP Data AVC (forwarding |
#5) | NCMP |
|
External (NCMP) Clients | DMI Data AVC on passthrough datastore & NCMP Subscription |
#6a |
- Open issue: can multiple subscriptions result in multiple events on different channels?! (RBAC TBAC ?)
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. | |||||||
4 | CPS-Core Data AVC | CPS-Core |
| 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
| #6a #7 | Yes |
|
| ||||||||
6 | VES Event | ONAP Devices | ONAP DMI Plugin | Change on Device | #7 | No |
|
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 |
Component Diagram
...
(#5) | ||||||||
9 | VES Event | ORAN Devices | Proprietary DMI Plugin | Change on Device | No | Similar to #6 above. Main fields:
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. |
...