Page History

...

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

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 DMI AVC Event with stakeholders ie. provide Jira ticket	Event Body should be compatible with RFC8641 kieran mccarthy

to confirm

has confirmed.

Priyank Maheshwari

to create

created JIRA to create the event body schema.

2

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

Sourabh Sourabh to provide Jira tickets

Jira

server	ONAP Jira
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1658

3

Should all the events have same

kafka headers

Headers

kieran mccarthy 26 Apr 2023

Posissbly

Possibly Common (base) set of headers but mandatory aspect might differ. In practice we might need a separate headers (

shema

schema?) 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

additional headers NCMP will discard those

ie

i.e. 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

Create a V2 of the schema and rename eventContent as ~~event~~ `data`. 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

8Dmi 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.

9Can Kafka Headers be describe with 'schema's owned and managed by NCMP

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:

POC to follow.

  Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-

1657

Defining header schema.

Integration of header with kafka.

Naming and versioning convention for the header schemas.

Higlights 03 May 2023
- Defined Common Header schema. Extended it and used in a base class.

Now defining the publisher to send the event and the headers.

10Depending #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.

11Is anyone using Async Request feature?See

Event Overview

...

cps:org.onap.cps.ncmp.events:avc-subscription-event:v1

...

cps:org.onap.cps.ncmp.events:dmi-async-request-response-event-schema:v1

...

cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1

...

Bulk Response Event (Client)

...

#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

...

1694
)
As part of a lower priority work items (but during Montreal) fiX related events with learnings from the new batch-usecase. (task created  Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-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 Headers be described with 'schema's owned and managed by NCMP~~

~~POC to follow.~~

Jira

server	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!

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

title	LCM Event Details

Current LCM Event Object

...

M
E.g. cps:org.onap.ncmp.cmhandle.lcm-event

...

The version of the schema that this event adheres to

...

M

e.g v1.0

...

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 will 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 .~~

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.

09 May 2023 Toine Siebelink agrees to go ahead with separate schema/headers per event. There will be some duplication but it will have its advantage when versioning.

11

Is anyone using Async Request feature?

See

Jira

server	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)
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?

kieran mccarthy 07 Jun 2023 this issue is now no longer relevant as the decision was to use CNCF Cloud Events instead as per decision #14

14

Align headers with CNCF 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!

Jira

server	ONAP Jira
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1717

15

During the meeting we saw that the Header fields were prefiXed with "ce_" so we need to check if we are ok with that.

assume "ce_" can be used as all user of the CNCF lib will get this behavior, will check if it can be replaced with no prefix at all.
Sourabh Sourabh and Priyank Maheshwari concluded a cloud events specific serializer is used that add this prefix and cannot easily be changed (also that would be inconsistent use of this library)

CPS Team recommend to accept this prefix and simply document that this prefer is required when filtering on kafka headers defined by CloudEvenst standard.

07 Jun 2023 team agreed with kieran mccarthy to accept "ce_" prefix on serialzied CE defined headers.
Note. Event(s) documentation in RTD should mentioned this clearly too

16

Do will still need/ can we still use schemas for header details with CNCF library ?!

How to publish info about non-standard headers like correlationid ?

Meeting on 31 May 2023 Team agreed refer to CNFC doc. and add list of extensions in RTD documentation. (key and value constraints)

17

Inconsistent casing convention for header fields v. json data fields

Just observing. All header ion CNCF are lowercase whereas json field are camelCase. Don't want to change but want to make sure agree...

Meeting on 31 May 2023 Team agreed this is the way it is and Toine Siebelink will update to CPS Style section: Contribution and Development#CommonStyleConventions

18

Confirm 'source'. is to be added to ALL events (declared mandatory for CNFC events)

kieran mccarthy 07 Jun 2023 confirm is is compulsory and a value will need to be set for all event definition. in NCMP a default value of 'ncmp' can be used if no other source is applicable. Toine Siebelink will update this page were needed to add this field and default value

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 (Data operations)#BulkRequestMessageFlow
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 (Data operations)#BulkRequestMessageFlow

#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

Expand

title	LCM Event Details

Current LCM

...

Values that represents the state of a cmHandle

...

Type:Values

...

State of cmHandle

...

["ADVISED", "READY", "LOCKED", "DELETING", "DELETED"]

...

#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.

Expand

title	DMI Data AVC Event

AVC

Event Object

Field	Type	Description

Kafka

Header

Event

Payload

Field

	Notes

(M=Mandatory, O=Optional)

	CloudEvents Mapping
eventID	string	The unique id identifying the event

x

X

M

	Mandatory	standard (`id`)
eventCorrelationId	string	The id identifying the event

x

. In LCMEvent this is always a cmhandleId X Optional
(extension fields will be optional now) extension (correlationid)

M


eventTime	string	The timestamp when original event occurred

x

X Mandatory standard (time)

O


eventSource	string	The source of the event	X

xO Needs clarification, see issue #8

	Mandatory	standard (`source`)
eventType	string	The type of the event

x

X

Mandatory

M (e.g. cps:org.onap.cps.ncmp.events:avc-event)eventSchemastring

standard (`type`)
eventSchema	string	The schema that this event adheres to.

x

X

M (

Mandatory e.g. cps:org.onap.

cps

ncmp.

ncmp

cmhandle.

events:avc-event-schema

lcm-event:1.0.0	standard (`dataschema`)
~~eventSchemaVersion~~	~~string~~	~~The version of the schema that this event adheres to~~

x

X

M (

~~Mandatory e.g~~

.

~~v1.0~~

orv2.0)

	~~N/A included in 'dataschema'~~
event	Event	The payload of an event		X

M

Mandatory

Type: Event (

standard (`data`)
N/A	N/A	The version of CNCF Specification	X		Specified by CNCF (value hardcoded)	standard (`specversion`)

Type:Event (cps:

cps:

org.onap.

cps

ncmp.

ncmp

cmhandle.

events:avc

lcm-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

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

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

Expand

title	AVC Subscription Event

Subscription Event Object

Field Type Description
Kafka
Header
Event
Payload
Field
Notes
version
dataSyncEnabled string

The event type version

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

eventType

string

The event type

cmHandle id		X
cmHandleState	string	State of cmHandle		X	Enum:

[

"CREATE"]eventEventThe payload for an eventDefined by event object below

"ADVISED", "READY", "LOCKED", "DELETING", "DELETED"]
cmHandleProperties	object	cmHandle properties		X	List of Java <String, String> Maps

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

Before	After¹	CloudeEvent builder method	Example Value	Notes
eventId	(ce_)id	.withId()		Mandatory
eventSource	(ce_)source	.withSource()		Mandatory
N/A	(ce_)specversion (default 1.0)	.v1()	1.0	Mandatory - This is the version of the cloud events
eventType	(ce_)type	.withType()		Mandatory
eventTime	(ce_)time	.withTime()		Optional (could be Mandatory for
eventSchema	(ce_)dataschema	.withDataSchema()		Optional includes the version of the schema
	content-type²	withDataContentType()	application/json	Optional
eventCorrelationId	(ce_)correlationid	.withExtension()		Optional 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 only applies to some events.
event	(ce_)data	.withData(json TBC)		Mandatory actual event/payload now would be under "data" field.

Status Code	Status Message
0	Successfully applied changes
100	cm handle id(s) is(are) not found
101	cm handle id(s) is(are) in non ready state
102	dmi plugin service is not responding
103	dmi plugin service is not able to read resource data

X			extensions (`correlationid`)
eventTime	string	The timestamp when original event occurred


eventSchema	string	The event schema for async request response events

~~event schema version for async request response events~~	X			~~N/A included in 'dataschema'~~
eventSource

event	X			standard (`source`)
eventContent	EventContent	The payload of an event			The name of this fields is inconsistent with all other event schemas, see issue #6	standard `(data)`

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 67

New Version Current

Key

Issues & Decisions

Event Overview

#1 LCM Event (NCMP → Client Apps)

Description

Current LCM Event Object

Event Overview

#1 LCM Event (NCMP → Client Apps)

Description

Current LCM

Type:Values

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

Description

Event Object

Type:Event (cps:

org.onap.

ncmp.

cmhandle.

lcm-event

:v1)

#3 AVC Subscription Event (DME → NCMP)

Description

Type:Values

FieldTypeDescriptionKafka HeaderEvent Payload FieldNotesversiondataSyncEnabledstring

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

Type: Subscription

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

Description

AVC Event Object

Type: DataType

Type: Predicates

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

Description

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

#3 AVC Subscription Event (DME → 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

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: Event (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)

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

NcmpAsyncRequestResponse Event Object

Proposed New Schema: JiraserverONAP JiraserverId425b2b0a-557c-3c0c-b515-579789cceedbkeyCPS-1660

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

#6 Bulk Response Event (DMI → NCMP)

Description

Type: forwarded

Event (cps:org.onap.cps.ncmp.

events:

ncmp-async-

request-response-event-schema:v1)

#7 Bulk Response Event (NCMP → Client App)

Description

Proposed New Schema:

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

#6 Data Operation (response) Event (DMI → NCMP)

Description

#7 Data Operation (response) Event (NCMP → Client App)

Description

CNCF Cloud Event alignment

Introduction

Library References

Common Header Mapping

Common NCMP response staus code & message :

Field Type Description
Kafka
Header
Event
Payload
Field
Notes
version
dataSyncEnabled string

Proposed New Schema:
Jira
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-1660