You are viewing an old version of this page. View the current version .
Compare with Current
View Page History
« Previous
Version 39
Next »
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 # 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 parctvie 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
# Description Source Destination Status Notes Full Schema Name 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 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 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
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
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
6 Bulk Response Event (Internal) DMI NCMP In Progress Internal Kafka topic cps:org.onap.cps.ncmp.event:dmi-async-b ulk-response-event-schema:v17 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-b ulk-response-event-schema:v1
LCM Event Description
LCM Event Details
Current LCM Event Object Field Type Description Kafka Header Event Payload Field Notes 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
cps:org.onap.ncmp.cmhandle.lcm-event
eventSchemaVersion string The version of the schema that this event adheres to
x M
v1.0 → v2.0
event Event The payload of an event cps:org.onap.ncmp.cmhandle.lcm-event:v1 Defined by event object below
ekiemcc : Suggest to add the full schema name for the LCM event body and the eventSchemaVersion
Type:Event Field Type Description Kafka Header 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 Kafka Header 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
DMI AVC Event Description DMI AVC Event (DMI → NCMP)
AVC Event Details
AVC Event Object
Field Type Description Kafka Header Event Payload Field Notes 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 cps:org.onap.cps.ncmp.events:avc-event ? eventSchema string The schema that this event adheres to x M cps:org.onap.cps.ncmp.events:avc-event-schema eventSchemaVersion string The version of the schema that this event adheres to
x M v1.0 → v2.0 event Event The payload of an event cps:org.onap.cps.ncmp.events:avc-event-schema:v1
Type: Event
Field Type Description Kafka Header Event Payload Field Notes No Properties defined (Entire event treated as single object)
AVC Subscription Event Description AVC Subscription Event (DME → NCMP) : ON HOLD - Kieran 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 : eventType string The event type
ekiemcc :
Enum:
["CREATE"]
event Event The payload for an event Defined by event object below
Event Object Field Type Description Kafka Header 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 Kafka Header 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 Kafka Header Event Payload Field Notes 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 Kafka Header Event Payload Field Notes 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
DMI Async Request Response Event
Description DMI Asynchronous Request Response Event
DMI Async Request Response Event
DmiAsyncRequestResponse Event 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 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 cps:org.onap.cps.ncmp.events:dmi-async-request-response-event-schema:v1
Defined by eventContent object below
Type: EventContent Field Type Description Kafka Header 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
NCMP Async Request Response Event Description NCMP Asynchronous Request Response Event
NCMP Async Request Response Event
NcmpAsyncRequestResponse Event 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 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 Defined by forwardedEvent object below
ekiemcc : This is a sub-element of 'event' payload as I recall which woulld be defined by the 'eventSchema'?
Type: Event Field Type Description Kafka Header 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: forwarded EventField Type Description Kafka Header 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
Bulk Response Event (Internal) Description Bulk Response Event, uses event target for topic
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 defined by schema
Type: Event
Field Type Description Kafka Header Event Payload Field Notes No Properties defined (Entire event treated as single object)
Bulk Response Event (Client) Description Bulk Response Event, uses client defined topic
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 defined by schema
Type: Event
Field Type Description Kafka Header Event Payload Field Notes No Properties defined (Entire event treated as single object)