Page Comparison

Table of Contents

...

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

Issues & Decisions

#Short NameSourceDestinationImpl. StatusNotesAgree exact list of comment headers.

Is there a separate field for datacontenttypeversion or is it part of datacontenttype ?

kafka

Also we need to look at the filtering strategy to filter the records by reading the headers only.

#

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 has confirmed.

Priyank Maheshwari created JIRA to create the event body schema.

Jira Legacy

server	System Jira
serverId	4733707d-2057-3a0f-ae5e-4fd8aff50176
key	CPS-1668

2

Bulk Operation events details have not yet be defined (just headers)

Sourabh Sourabh to provide Jira tickets

Jira Legacy

server	System Jira
serverId	4733707d-2057-3a0f-ae5e-4fd8aff50176
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~~

EX: 1.0.0 (without 'v')

kieran mccarthy to check ORAN preference

kieran mccarthy confirms through email on 12 May 2023 to use semantic versioning which ORAN follows https://semver.org.

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 (EST) 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:
Jira Legacy
server System Jira
serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
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
Jira Legacy
server System Jira
serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
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.

Jira Legacy

server	System Jira
serverId	4733707d-2057-3a0f-ae5e-4fd8aff50176
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

Jira Legacy

server	System Jira
serverId	4733707d-2057-3a0f-ae5e-4fd8aff50176
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)
See decision on issue #7

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 (DMI → NCMP) (events #3)

Want to understand what 'data' is datatype referring to 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 kieran mccarthy updated #3 is ON HOLD to analyse further.

Agreed with Toine Siebelink on18 May 2023 that Priyank Maheshwari will look into this from now as they are working on something related to this.

14

Align headers with CNFC Cloud Events

Using standard headers as defined by Cloud Events and possibly common header extension See Table below, CNFC Cloud Event alignment

CPS will use Cloud Events 3PP for all current and legacy events to ensure common format

23 May 2023 kieran mccarthyand Toine Siebelink agreed on general idea but exact list of common headers need to be agreed
Jira (first impl.) to be added!

15

During the meeting we saw that the

Kafka header fields were prefixed with "ce_ " so need to check if we are ok with that.

23 May 2023 kieran mccarthyand Toine Siebelink agreed on general idea but exact list of common headers need to be agreed

Event Overview

#	Short Name	Source	Destination	Impl. Status	Notes	Full Schema Name	Diagram Ref.
1	LCM Event	NCMP	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	Client	NCMP & DMIs	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	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 (batch operations)
7	Bulk Response Event (Client)	NCMP	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 (batch operations)

...

CNCF Cloud Event alignment

...

Before

...

After

...

Cloudy Event Library

Introduction....

These cloud events will be applied to all the internal and external events we have in CPS , NCMP and DMI Plugin.
Cloud events will be taking care of the fields which are part of kafka headers or part of the actual payload ( fields other than "data" are sent as kafka headers )
These CNCF cloud events will be applied to all the events listed in above sections ( LCM , DMI Data AVC etc. )

link to library

link to online example

...

M ( M ) ( M )( M ) ( O )~~datacontenttype~~
( O )( O ) eg : .

Before	After	CloudeEvent builder method	Example Value	Notes
eventId	id	.withId(	)			Mandatory
eventSource	source			Mandatory
N/A	specversion (default 1.0)			1.0	Mandatory - This is the version of the cloud events
eventType	type			Mandatory
eventTime	time			Optional
eventSchema	dataschema			Optional includes the version of the schema
	datacontenttype		application/json
event	data	( M ) actual event/payload now would be under "data" field.
Optional
eventCorrelationId	correlationid	.withExtension		( O ) This will be part of the extensions field in the cloud events and all the restrictions of the attribute field naming applies to it. i.e these fields will be in the small case. This is marked as optional as it applies to the event which has this field

...

.
event	data	.withData(json TBC)		( M ) actual event/payload now would be under "data" field.

Versions Compared

Old Version 91

New Version 92

Key

Issues & Decisions

Event Overview

Event Overview

CNCF Cloud Event alignment

Cloudy Event Library