...
# Description Notes Decision 1 No Event properties defined for DMI AVC Event Priyank Maheshwari will need to specify and agreed event structure for DMI AVC Event with stakeholders ie. provide Jira ticket
Event Body should be compatible with RFC8641
kieran mccarthy
Priyank Maheshwari create JIRA to create the event body schema.
Jiraserver ONAP Jira serverId 425b2b0a-557c-3c0c-b515-579789cceedb key CPS-1668
2 Bulk Operation events details have not yet be defined (just headers) Sourabh Sourabh to provide Jira tickets
Jiraserver ONAP Jira serverId 425b2b0a-557c-3c0c-b515-579789cceedb key CPS-1658
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 those ie. not included in forwarded events
6 Event(Content) field in DMI Async Request Response Event has inconsistent name (compared with other schemas) Add V2 file Deprecate V1 Support both versions for a while Delete the V1 version (after some time ) CPS Team 27 Apr 2023 Create a V2 of the schema and rename eventContent as event. Do it as part of the schema addition.
7 NCMP Async Request Response Event (#5) contains both an Event and ForwardedEvent ForwardedEvent is not wrapped inside Event but question now is if we need 2 events at all?!
Sourabh Sourabh and Raviteja Karumuri can check how it is actually working and then we decide ( create a JIRA ticket )
Wiki for the Study on NCMPAsyncRequestResponse event schema
Conclusion: events not designed as proposed, very inconsistent. Never go a bug because these async events aren't used at all (confirmed by Csaba Koscis) Instead bulk request wil be used for topology use cases.
10 May 2023 kieran mccarthy and team agreed to:
Temporary disable the legacy async request feature (task created: Jiraserver ONAP Jira serverId 425b2b0a-557c-3c0c-b515-579789cceedb key CPS-1694
) Aas part of a lower priority work items (but during Montreal) fix related events with learnings from the new batch-usecase. (task created Jiraserver ONAP Jira serverId 425b2b0a-557c-3c0c-b515-579789cceedb key CPS-1693
) 8 Dmi Data AVC Event, use of eventSource field Priyank Maheshwari wanted to store 'datastore' in this field but kieran mccarthy explained it to use for different purposes
kieran mccarthy Clients can use this field as per their requirements.
9 Can Kafka Headers be described with 'schema's owned and managed by NCMP POC to follow.
Jiraserver ONAP Jira serverId 425b2b0a-557c-3c0c-b515-579789cceedb key CPS-1657
Defining header schema.
Integration of header with kafka.
Naming and versioning convention for the header schemas. 'id'
Does the headers schema have a version too?!
03 May 2023 Priyank Maheshwari confirmed headers can be described with a separate schema.
Both header schema's and event schemas wil be published on https://docs.onap.org/projects/onap-cps/en/latest/cps-events.html
Header schema name and version will be maintained in the 'id' metadata field of header's schema .
Defined Common Header schema. Extended it and used in a base class
10 Depending #10 can schema inherit/extend a common schema for common headers Commonly define them and then define what are mandatory(required) or optional as per the schema extending it.
If a field is not used in the extended schema then it should be able to handle it.
Extend the POC ( on #9 ) to cover this.
09 May 2023 Priyank Maheshwari did the POC and the conclusion of that was that :-
One schema can extend the other schema. We cannot override the mandatory/optional parameter from the Parent schema. 03 May 2023 PoC ongoing
09 May 2023 Toine Siebelink agrees to go ahead with separate schema/header per event. There will be some duplication but it will have its advantage when versioning.
11 Is anyone using Async Request feature? See
Jiraserver ONAP Jira serverId 425b2b0a-557c-3c0c-b515-579789cceedb key CPS-1660
we need to re-design event #4 (Covers Point 6 as well) and #5 in a backward incompatible way. If no-one is using this feature right now (suspected) we can do this more easily/cheaper!
03 May 2023 Csaba Kocsis confirmed this is not used by Ericsson currently. No plans to use soon for single-cmhandle requests either (TBC). Need to decide priority (Csaba Kocsis to find out of fixing the legacy schema(s)
12 Do we need additionalProperties for DMI ASync Data Request respondes (events #4, #5) The original code populates a framework defined 'additionalProperties' field with a singel key-value pair: "response-data",{<json data>}. No other (private) properties are added either in DMI PLugin or NCMP code. The name is just coincidence and misleading. In fact this 'additionalProperties' field should NOT have been used at all! No, the new schema should NOT add 'additionalProperties' field at all use 'additionalProperties:no' in the schema 13 AVC Subscription Event (DME → NCMP) (events #3) Want to understand what consists of datatype definition under Subscription Event.What value comes under 'schemaName' & 'SchemaVersion' of Datatype definition under AVC Subscription Event? Reconfirmation needed on 'schemaName' & 'SchemaVersion' should be in the payload? In meeting26 Apr 2023 or dd-mm-yyyy kieran mccarthy updated #3 is ON HOLD to analyse further.
...
ExpandAVC Event Object Field Type Description Kafka Header Event Payload Field 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 Needs clarification, see issue #8 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
...
Expandtitle 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 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 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 Event (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1) Field 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
Proposed New Schema: Jiraserver ONAP Jira serverId 425b2b0a-557c-3c0c-b515-579789cceedb key CPS-1660
Field Type Description Kafka Header Event Payload Field Notes eventID string The unique id identifying the event generated by DMI eventCorrelationId string The request id passed by NCMP
eventTime string The timestamp when original event occurred eventSource string The source of the event What value should contain in this? Needs clarification, see issue #8 eventType string The type of the event eventSchema string The event schema for async request response events
eventSchemaVersion string The event schema version for async request response events
event Event The payload of an event Defined by event object below
Type: Event (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1) Field Type Description Kafka Header Event Payload Field Notes eventCorrelationId string The request id passed by NCMP
as above @Toine asked to add this property. responseStatus string The received status of the response
responseCode string The received code of the response
responseData object The data payload
contains payload of type object
#6 Bulk Response Event (DMI → NCMP) Description Bulk Batch (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
ExpandBulkResponseEvent BatchResponseEvent 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 #2
Type: Event (cps:org.onap.cps.ncmp.event.async :dmi-async-b ulk batch -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 Batch (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
Expandtitle Bulk Response Event - Client Topic
BulkResponseEvent BatchResponseEvent 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 #2
Type: Event (cps:org.onap.cps.ncmp.event.async :ncmp-async-b ulk batch -response-event-schema:v1)
Field Type Description Kafka Header Event Payload Field Notes No Properties defined (Entire event treated as single object)
...
