CPS Event Structure

Overview

CPS-1628 - Getting issue details... STATUS

This page gives a description of CPS events including their fields
Events will be split into events and Kafka headers

Issues & Decisions:

#	Description	Notes	Decision
1	No Event properties defined for DMI AVC Event		Priyank Maheshwari will need to specify and agreed event structure for DNI AVC Event with stakeholders
2	No Event properties defined for Bulk Response Events [Internal & client]
3	Should all the events have same kafka headers		kieran mccarthy 26 Apr 2023 Posissbly Common (base) set of headers but mandatory aspect might differ. In practice we might need a separate headers (shema?) for each event
4	Clarify the format of the version eventSchemaVersion	v1 or 1.0	kieran mccarthy to check ORAN preference
5	What to do with additional event headers (from DMI Plugins)		kieran mccarthy 26 Apr 2023 if DMI produce Additional headers NCMP will discard thoe ie. not included in forwarded events
6	Event(Content) field in DMI Async Request Response Event has inconsistent name (compared with other schemas)
7	NCMP Async Request Response Event contains both an Event and ForwardedEvent	ForwardedEvent is not wrapped inside Event but question now is if we need 2 events at all?!
8	Bulk Operation events details have not yet be defined (just headers)	Sourabh Sourabh to create Jira's

Event Overview

#	Description	Source	Destination	Status	Notes	Full Schema Name	Diagram Ref.
1	LCM Event	NCMP	External Client Apps	In Use	Life Cycle Management Events, when cmHandles are added or removed	cps:org.onap.ncmp.cmhandle.lcm-event:v1	CM-Handle State Changes and Notifications Overview#Notificationhandlingincode
2	DMI Data AVC Event	DMI	NCMP	Implemented, Not in use	Attribute Value Change in configuration management (CM) data.	cps:org.onap.cps.ncmp.events:avc-event-schema:v1	5 in CPS Data Notifications Overview#ComponentDiagram
3	AVC Subscription Create Event	External Client Apps	NCMP - Fwd to DMI	Implemented, Not in use	Create Event Only	cps:org.onap.cps.ncmp.events:avc-subscription-event:v1	7 in CPS Data Notifications Overview#ComponentDiagram
4	DMI Async Request Response Event	DMI	NCMP	In Use	DMI passes response onto Kafka topic specified by client.	cps:org.onap.cps.ncmp.events:dmi-async-request-response-event-schema:v1	3b → 4a in CPS-821 Spike: Support Async read-write operations on CPS-NCMP interface#ProposedDesign
5	NCMP Async Request Response Event	NCMP	External Client Apps	In Use	Forward No.4 to client specified topic	cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1	4b → 5 in CPS-821 Spike: Support Async read-write operations on CPS-NCMP interface#ProposedDesign
6	Bulk Response Event (Internal)	DMI	NCMP	In Progress	Internal Kafka topic	cps:org.onap.cps.ncmp.event:dmi-async-bulk-response-event-schema:v1	5 in CPS-1515: Spike: Support Multiple CM-Handles for NCMP Get Operation (bulk / batch operations)
7	Bulk Response Event (Client)	NCMP	External Client Apps	In Progress	Forwarding the DMI responses to the client topic	cps:org.onap.cps.ncmp.event:ncmp-async-bulk-response-event-schema:v1	6 in CPS-1515: Spike: Support Multiple CM-Handles for NCMP Get Operation (bulk / batch operations)

#1 LCM Event (NCMP → Client Apps)

Description

LCM (Life Cycle Management) Event. Sent by NCMP when the state of a CM Handle changes. For diagram see CM-Handle State Changes and Notifications Overview#Notificationhandlingincode

LCM Event Details

Current LCM Event Object

Field	Type	Description	Kafka Header	Notes (M=Mandatory, O=Optional)
eventID	string	The unique id identifying the event	x	M
eventCorrelationId	string	The id identifying the event. In LCMEvent this is always a cmhandleId	x	M
eventTime	string	The timestamp when original event occurred	x	M
eventSource	string	The source of the event	x	M
eventType	string	The type of the event	x	M
eventSchema	string	The schema that this event adheres to.	x	M E.g. cps:org.onap.ncmp.cmhandle.lcm-event
eventSchemaVersion	string	The version of the schema that this event adheres to	x	M e.g v1.0
event	Event	The payload of an event		M

Type:Event (cps:org.onap.ncmp.cmhandle.lcm-event:v1)

Field	Type	Description	Event Payload Field	Notes
cmHandleId	string	cmHandle id	x
oldValues	Values	Values that represents the state of a cmHandle	x	Defined by values object below
newValues	Values	Values that represents the state of a cmHandle	x	Defined by values object below

Type:Values

Field	Type	Description	Event Payload Field	Notes
dataSyncEnabled	string	cmHandle id	x
cmHandleState	string	State of cmHandle	x	Enum: ["ADVISED", "READY", "LOCKED", "DELETING", "DELETED"]
cmHandleProperties	object	cmHandle properties	x	List of Java <String, String> Maps

#2 DMI Data AVC Event (ONAP DMI → NCMP)

Description

A normalized AVC Event that ONAP DMI Plugin will send to NCMP. NCMP can process the event and update cached data if needed. See 5 in CPS Data Notifications Overview#ComponentDiagram
Other DMI Plugin might snet similar events, using same headers but different payload and value for 'eventSchema' Depending on the AVC subscription details those events might or might not be forwarded to the Client Apps.

AVC Event Details

AVC Event Object

Field	Type	Description	Kafka Header	Notes (M=Mandatory, O=Optional)
eventID	string	The unique id identifying the event	x	M
eventCorrelationId	string	The id identifying the event	x	M
eventTime	string	The timestamp when original event occurred	x	O
eventSource	string	The source of the event	x	O
eventType	string	The type of the event	x	M (e.g. cps:org.onap.cps.ncmp.events:avc-event)
eventSchema	string	The schema that this event adheres to	x	M (e.g. cps:org.onap.cps.ncmp.events:avc-event-schema)
eventSchemaVersion	string	The version of the schema that this event adheres to	x	M (e.g. v1.0 orv2.0)
event	Event	The payload of an event		M

Type: Event (cps:org.onap.cps.ncmp.events:avc-event-schema:v1)

Field	Type	Description	Kafka Header	Event Payload Field	Notes
No Properties defined (entire event treated as single object) See open issue #1

#3 AVC Subscription Event (DME → NCMP)

Description

AVC Subscription Event (External Clients Apps → NCMP) : ON HOLD - kieran mccarthy to analyze further

AVC Subscription Event

Subscription Event Object

Field

Type

Description

Kafka Header

Event Payload Field

Notes

version

string

The event type version

ekiemcc : What is this version? This should be covered in the header now?

eventType

string

The event type

ekiemcc : This is now covered by the header? Is this needed any longer in the body?

Enum:

["CREATE"]

event

Event

The payload for an event

Defined by event object below

Event Object (cps:org.onap.cps.ncmp.events:avc-subscription-event:v1)

Field	Type	Description	Event Payload Field	Notes
subscription	Subscription	The subscription details	x	Defined by subscription object below
dataType	DataType	The datatype content	x	Defined by dataType object below
predicates	Predicates	Additional values to be added into the subscription	x	Defined by predicates object below

Type: Subscription

Field	Type	Description	Event Payload Field	Notes
clientID	string	The client ID	x
name	string	The name of the subscription	x
isTagged	boolean	optional parameter, default is false	x	default: false

Type: DataType

Field	Type	Description	Event Payload Field
dataspace	string	The dataspace name	x
dataCategory	string	The category type of the data	x
dataProvider	string	The provider name of the data	x
schemaName	string	The name of the schema	x
schemaVersion	string	The version of the schema	x

Type: Predicates

Field	Type	Description	Event Payload Field
targets	array	CM Handles to be targeted by the subscription	x
datastore	string	datastore which is to be used by the subscription	x
xpath-filter	string	filter to be applied to the CM Handles through this event	x

#4 DMI Async Request Response Event (DMI → NCMP)

Description

This event is for the asynchronous responses from DMI to NCMP following (synchronous) requests (from NCMP) specifying a (response) topic. See 3b → 4a in CPS-821 Spike: Support Async read-write operations on CPS-NCMP interface#ProposedDesign

DMI Async Request Response Event

DmiAsyncRequestResponse Event Object

Field	Type	Description	Kafka Header	Notes
eventID	string	The unique id identifying the event generated by DMI	x
eventCorrelationId	string	The request id passed by NCMP	x
eventTime	string	The timestamp when original event occurred	x
eventTarget	string	The target of the event	x
eventType	string	The type of the event	x
eventSchema	string	The event schema for async request response events	x
eventSchemaVersion	string	The event schema version for async request response events	x
eventSource	string	The source of the event	x
eventContent	EventContent	The payload of an event		The name of this fields is inconsistent with all other event schemas, see issue #6

Type: EventContent (cps:org.onap.cps.ncmp.events:dmi-async-request-response-event-schema:v1)

Field	Type	Description	Event Payload Field	Notes
repsonse-data-schema	string	The schema of response data	x
response-status	string	The status of the response	x
response-code	string	The code of the response	x
response-data	object	The data payload	x	contains payload of type object

#5 NCMP Async Request Response Event (NCMP → Client App)

Description

This event is for the asynchronous responses from NCMP to Client Apps following (synchronous) requests (from client) specifying a (response) topic. See 4b → 5 in CPS-821 Spike: Support Async read-write operations on CPS-NCMP interface#ProposedDesign

NCMP Async Request Response Event

NcmpAsyncRequestResponse Event Object

Field	Type	Description	Kafka Header	Notes
eventID	string	The unique id identifying the event generated by DMI	x
eventCorrelationId	string	The request id passed by NCMP	x
eventTime	string	The timestamp when original event occurred	x
eventTarget	string	The target of the event	x
eventType	string	The type of the event	x
eventSchema	string	The event schema for async request response events	x
eventSchemaVersion	string	The event schema version for async request response events	x
event	Event	The payload of an event		Defined by event object below
forwardedEvent	ForwardedEvent	The payload of a forwarded event		Relation to Event field unclear, do we need 2 events at all see issue #7

Type: Event (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)

Field	Type	Description	Event Payload Field	Notes
eventID	string	The unique id identifying the event generated by DMI	x	Only in payload in v1 of the payload schema. To be removed in v2 version (will be in the header only)
eventCorrelationId	string	The request id passed by NCMP	x	as above
eventTime	string	The timestamp when original event occurred	x	as above
eventTarget	string	The target of the event	x	as above
eventType	string	The type of the event	x	as above
eventSchema	string	The event schema for async request response events	x	as above
eventSource	string	The source of the event	x
response-data-schema	string	The received schema of response data	x
response-status	string	The received status of the response	x
response-code	string	The received code of the response	x
response-data	object	The data payload	x	contains payload of type object

Type: forwardedEvent (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)

Field	Type	Description	Event Payload Field	Notes
eventID	string	The unique id identifying the event generated by DMI	?	Can NCMP put these in the header and remove them from the 'forwardedEvent'
eventCorrelationId	string	The request id passed by NCMP	?	as above
eventTime	string	The timestamp when original event occurred	?	as above
eventTarget	string	The target of the event	?	as above
eventType	string	The type of the event	?	as above
eventSchema	string	The event schema for async request response events	?	as above
eventSchemaVersion	string	The event schema version for async request response events	?	as above
eventSource	string	The source of the event	?	as above
response-data-schema	string	The received schema of response data	x
response-status	string	The received status of the response	x
response-code	string	The received code of the response	x
response-data	object	The data payload	x	contains payload of type object

#6 Bulk Response Event (DMI → NCMP)

Description

Bulk (data) request will always result in asynchronous events (responses) sent to the client. This event is the response from DMI to NCMP. See 5 in CPS-1515: Spike: Support Multiple CM-Handles for NCMP Get Operation (bulk / batch operations)#BulkRequestMessageFlow

Bulk Response Event

BulkResponseEvent Object

Field	Type	Description	Kafka Header	Event Payload Field	Notes
eventID	string	The unique id identifying the event generated by DMI	x
eventCorrelationId	string	The request id passed by NCMP	x
eventTarget	string	The destination topic of the client	x
eventTime	string	The timestamp when original event occurred	x
eventType	string	The type of the event	x
eventSchema	string	The event schema for async request response events	x
eventSchemaVersion	string	The event schema version for async request response events	x
event	Event	The payload of an event		x	java object not yet defined by schema, see issue#8

Type: Event (cps:org.onap.cps.ncmp.event:dmi-async-bulk-response-event-schema:v1)

Field	Type	Description	Kafka Header	Event Payload Field	Notes
No Properties defined (Entire event treated as single object)

#7 Bulk Response Event (NCMP → Client App)

Description

Bulk (data) request will always result in asynchronous events (responses) sent to the client. This event is the response from DMI to NCMP. See 6 in CPS-1515: Spike: Support Multiple CM-Handles for NCMP Get Operation (bulk / batch operations)#BulkRequestMessageFlow

Bulk Response Event - Client Topic

BulkResponseEvent Object

Field	Type	Description	Kafka Header	Event Payload Field	Notes
eventID	string	The unique id identifying the event generated by DMI	x
eventCorrelationId	string	The request id passed by NCMP	x
eventTime	string	The timestamp when original event occurred	x
eventType	string	The type of the event	x
eventSchema	string	The event schema for async request response events	x
eventSchemaVersion	string	The event schema version for async request response events	x
event	Event	The payload of an event		x	Java object not yet defined by schema, see issue#8

Type: Event (cps:org.onap.cps.ncmp.event:ncmp-async-bulk-response-event-schema:v1)

Field	Type	Description	Kafka Header	Event Payload Field	Notes
No Properties defined (Entire event treated as single object)

Space shortcuts

Page tree

Overview

Issues & Decisions:

Event Overview

#1 LCM Event (NCMP → Client Apps)

Description

Current LCM Event Object

Type:Event (cps:org.onap.ncmp.cmhandle.lcm-event:v1)

Type:Values

#2 DMI Data AVC Event (ONAP DMI → NCMP)

Description

AVC Event Object

Type: Event (cps:org.onap.cps.ncmp.events:avc-event-schema:v1)

#3 AVC Subscription Event (DME → NCMP)

Description

Event Object (cps:org.onap.cps.ncmp.events:avc-subscription-event:v1)

Type: Subscription

Type: DataType

Type: Predicates

#4 DMI Async Request Response Event (DMI → NCMP)

Description

Type: EventContent (cps:org.onap.cps.ncmp.events:dmi-async-request-response-event-schema:v1)

#5 NCMP Async Request Response Event (NCMP → Client App)

Description

Type: Event (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)

Type: forwardedEvent (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)

#6 Bulk Response Event (DMI → NCMP)

Description

#7 Bulk Response Event (NCMP → Client App)

Description