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

Priyank Maheshwari 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 headersHeaders

kieran mccarthy 26 Apr 2023 Possibly Common (base) set of headers but mandatory aspect might differ. In practice we might need a separate headers (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 headers NCMP will discard those 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 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

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
server ONAP Jira
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key CPS-1694
)
As part of a lower priority work items (but during Montreal) fix fiX related events with learnings from the new batch-usecase. (task created
Jira
server 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 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

server	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 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 eXtend a common schema for common headers

Commonly define them and then define what are mandatory(required) or optional as per the schema extending eXtending it.

If a field is not used in the extended eXtended schema then it should be able to handle it.

Extend 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 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 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 CNCF Cloud Events

Using standard headers as defined by Cloud Events and possibly common header extension 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 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 Kafka header Header fields were prefixed prefiXed with "ce_" (or "ce0") so need to check if we are ok with that.

assume "ce_" can be used as all user of the CNCF lib will get this behavio., will check id it can be replaced with no prefix prefiX at all.

Need to check with kieran mccarthy for way forward.

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

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

...

Expand

title	LCM Event Details

Current LCM Event Object

Field	Type	Description

Kafka

Header

Event

Payload

Field

	Notes	CloudEvents Mapping
eventID	string	The unique id identifying the event

x

X		Mandatory	standard (id)
eventCorrelationId	string	The id identifying the event. In LCMEvent this is always a cmhandleId

x

X

Optional
(

extension

eXtension fields will be optional now)

extension

eXtension (correlationid)
eventTime	string	The timestamp when original event occurred

x

X		Mandatory	standard (time)
eventSource	string	The source of the event

x

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

x

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

x

X

Mandatory

E

e.g.

cps:org.onap.ncmp.cmhandle.lcm-event:1.0.0	standard (dataschema)
eventSchemaVersion	string	The version of the schema that this event adheres to

x

X

Mandatory

e.g v1.0	N/A included in 'dataschema'
event	Event	The payload of an event		X	Mandatory	standard (data)
N/A	N/A	The version of CNCF Specification	X		Specified by CNCF (value hardcoded)	standard (specversion)

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

Field	Type	Description

Kafka

Header

Event

Payload

Field

	Notes
cmHandleId	string	cmHandle id

x

	X
oldValues	Values	Values that represents the state of a cmHandle

x

	X	Defined by values object below
newValues	Values	Values that represents the state of a cmHandle

x

X

Defined by values object below

Type:Values

Field	Type	Description

Kafka

Header

Event

Payload

Field

	Notes
dataSyncEnabled	string	cmHandle id

x

	X
cmHandleState	string	State of cmHandle

x

X

Enum:

["ADVISED", "READY", "LOCKED", "DELETING", "DELETED"]
cmHandleProperties	object	cmHandle properties

x

X

List of Java <String, String> Maps

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

...

Expand

title	DMI Data AVC Event

AVC Event Object

Field	Type	Description

Kafka

Header

Event

Payload

Field

	Notes	CloudEvents Mapping
eventID	string	The unique id identifying the event

x

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

x

X

Optional

extension

eXtension(correlationid)
eventTime	string	The timestamp when original event occurred

x

X		Optional	standard (time)
eventSource	string	The source of the event

x

X		Optional	standard (source)
eventType	string	The type of the event

x

X

Mandatory

(e.g. cps:org.onap.cps.ncmp.events:avc-event)	standard (type)
eventSchema	string	The schema that this event adheres to

x

X		Mandatory (e.g. cps:org.onap.cps.ncmp.events:avc-event-schema)	standard (dataschema)
eventSchemaVersion	string	The version of the schema that this event adheres to

x

X		Mandatory	N/A included in 'dataschema'
event	Event	The payload of an event			Mandatory	standard (data)

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 Priyank Maheshwari This is how the event will look like. CPS-1065 Spike: CM data notifications from NCMP to applications including subscriptions#EventPayloadExample

...

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

...

Expand

title	AVC Subscription Event

Subscription Event Object

Field	Type	Description

Kafka

Header

Event

Payload

Field

	Notes	CloudEvents Mapping
version	string	The event type version	X

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

			included in dataschema
eventType	string	The event type	X

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

Enum:

["CREATE"]

		standard (type)
source				NEW TBC, see issue #18
event	Event	The payload for an event	X	Defined by event object below	standard (data)

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

Field	Type	Description

Kafka

Header

Event

Payload

Field

	Notes
subscription	Subscription	The subscription details

x

	X	Defined by subscription object below
dataType	DataType	The datatype content

x

	X	Defined by dataType object below
predicates	Predicates	Additional values to be added into the subscription

x

X

Defined by predicates object below

Type: Subscription

Field	Type	Description

Kafka

Header

Event

Payload

Field

	Notes
clientID	string	The client ID

x

	X
name	string	The name of the subscription

x

	X
isTagged	boolean	optional parameter, default is false

x

X

default: false

Type: DataType

Field	Type	Description

Kafka

Header

Event

Payload

Field

	Notes
dataspace	string	The dataspace name

x

	X
dataCategory	string	The category type of the data

x

	X
dataProvider	string	The provider name of the data

x

	X
schemaName	string	The name of the schema

x

	X
schemaVersion	string	The version of the schema

x

X

Type: Predicates

Field	Type	Description

Kafka

Header

Event

Payload

Field

	Notes
targets	array	CM Handles to be targeted by the subscription

x

	X
datastore	string	datastore which is to be used by the subscription

x

X

xpath


Xpath-filter	string	filter to be applied to the CM Handles through this event

x

X

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

...

Expand

title	DMI Async Request Response Event

DmiAsyncRequestResponse Event Object

Field	Type	Description

Kafka

Header

Event Payload Field

Payload	Notes	CloudEvents Mapping
eventID	string	The unique id identifying the event generated by DMI

x

X			standard (`id`)
eventCorrelationId	string	The request id passed by NCMP

x

X

extensions

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

x

X			standard (`time`)
eventTarget	string	The target of the event

x

X

extensions

		eXtensions (`target`)
eventType	string	The type of the event

x

X			standard (`type`)
eventSchema	string	The event schema for async request response events

x

X			standard (`dataschema`)
~~eventSchemaVersion~~	~~string~~	~~The event schema version for async request response events~~

x

X			~~N/A included in 'dataschema'~~
eventSource	string	The source of the event

x

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)`

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

Field	Type	Description

Kafka

Header

Event

Payload

Field

	Notes

repsonse

response-data-schema

string

The schema of response data

x

	X
response-status	string	The status of the response

x

	X
response-code	string	The code of the response

x

	X
response-data	object	The data payload

x

X

contains payload of type object

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

...

Expand

title	NCMP Async Request Response Event

NcmpAsyncRequestResponse Event Object

Field	Type	Description

Kafka

Header

Event

Payload

Field

	Notes	CloudEvents Mapping
eventID	string	The unique id identifying the event generated by DMI

x

X			standard (`id`)
eventCorrelationId	string	The request id passed by NCMP

x

X

extensions

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

x

X			standard (`time`)
eventTarget	string	The target of the event

x

X

extensions

		eXtensions (`target`)
eventType	string	The type of the event

x

X			standard (`type`)
eventSchema	string	The event schema for async request response events

x

X			standard (`dataschema`)
eventSchemaVersion	string	The event schema version for async request response events

x

X			~~N/A included in 'dataschema'~~
event	Event	The payload of an event		X	Defined by event object below	standard (

source

`data`)
forwardedEvent	ForwardedEvent	The payload of a forwarded

event

X

Relation to Event field unclear, do we need 2 events at all see issue #7

standard (data)
See new proposal 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
eventID	string	The unique id identifying the event generated by DMI

x

	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

	X	as above
eventTime	string	The timestamp when original event occurred

x

	X	as above
eventTarget	string	The target of the event

x

	X	as above
eventType	string	The type of the event

x

	X	as above
eventSchema	string	The event schema for async request response events

x

	X	as above
eventSource	string	The source of the event

x

	X
response-data-schema	string	The received schema of response data

x

	X
response-status	string	The received status of the response

x

	X
response-code	string	The received code of the response

x

	X
response-data	object	The data payload

x

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	xX
response-status	string	The received status of the response	xX
response-code	string	The received code of the response	xX
response-data	object	The data payload	xX	contains payload of type object

Proposed New Schema:

see

Jira

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

Field	Type	Description

Kafka

Header

Event

Payload

Field

	Notes	CloudEvents Mapping
eventID	string	The unique id identifying the event generated by DMI	X			standard (`id`)
eventCorrelationId	string	The request id passed by NCMP	X

extensions

		eXtensions(`correlationid`)
eventTime	string	The timestamp when original event occurred	X			standard (`time`)
eventSource	string	The source of the event	X		What value should contain in this? Needs clarification, see issue #8	standard (`source`)
eventType	string	The type of the event	X			standard (`type`)
eventSchema	string	The event schema for async request response events	X			standard (`dataschema`)
~~eventSchemaVersion~~	~~string~~	~~The event schema version for async request response events~~	X			~~N/A included in '`dataschema`'~~
event	Event	The payload of an event		X	Defined by event object below	standard (`data`)

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	X		as above @Toine asked to add this property.
responseStatus	string	The received status of the response		X
responseCode	string	The received code of the response		X
responseData	object	The data payload		X	contains payload of type object

#6 Batch Response Event (DMI → NCMP)

...

Expand

title	DMI Async Batch Response Event

BatchResponseEvent Object

Excerpt

Field	Type	Description

Kafka

Header

Event

Payload

Field

	Notes	CloudEvents Mapping
eventID	string	The unique id identifying the event generated by DMI

x

X

Mandatory

. Generated by DMI-Plugin	standard (`time`)
eventCorrelationId	string	The request id passed by NCMP

x

X

Mandatory. This is requestId that NCMP sent to client as an ACK.
Example : “request-1234" (UUID)

extensions

eXtension (`correlationid`)
eventTarget	string	The destination topic of the client

x

X

Mandatory. TBC

example

Example: my-topic

extensions

eXtension (

target TBC

`destination`)
source	string	The source of the event	Optional. Example : dmi-plugin:enm-1 (dmi service name)
eventTime	string	The timestamp when original event occurred

x

X		Optional. The timestamp should follow that on https://www.rfc-editor.org/rfc/rfc3339#section-5. This follows ISO 8601 and is what is used/referenced in 3GPP standards Example: 1985-04-12T23:20:50.52Z this represents 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.	standard (`time`)
eventType	string	The type of the event

x

X		Mandatory. NCMP owns eventType that would be used by dmi-plugins The Convention of eventType and Schema names is under discussion, see open issue #17 on CPS-1515 Spike	standard (`type`)
eventSchema	string	The event schema for async request response events

x

X		Mandatory. The Convention of eventType and Schema names is under discussion, see open issue #17 on CPS-1515 Spike	standard (`dataschema`)
~~eventSchemaVersion~~	~~string~~	~~The event schema version for async request response events~~

x

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

x

	X	java object not yet defined by schema, see issue #2	standard (`data`)
specversion	String	Version of CNCF spec

x

X

hardcoded value of 1.0

standard (

hardcode value

specversion)

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

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

...

Expand

title	NCMP Async Batch Response Event - Client Topic

BatchResponseEvent Object

Field	Type	Description

Kafka

Header

Event

Payload

Field

	Notes	CloudEvents Mapping
eventID	string	The unique id identifying the event generated by DMI

x

X			standard (`id`)
eventCorrelationId	string	The request id passed by NCMP

x

X

extensions

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

x

X			standard (`time`)
eventType	string	The type of the event

x

X			standard (`type`)
eventSchema	string	The event schema for async request response events

x

X			standard (`dataschema`)
~~eventSchemaVersion~~	~~string~~	~~The event schema version for async request response events~~

x

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

x

X Java object not yet defined by schema, see issue #2 standard (data)

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

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

...

These cloud events will be applied to all the internal and external 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 Headers or part of the actual payload (fields other than "data" are sent as kafka headers Headers)
These CNCF cloud events will be applied to all the events listed in above sections (LCM , DMI Data AVC etc.)

...

Common Header Mapping

...

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

...

Space shortcuts

Page tree

Versions Compared

Old Version 115

New Version 116

Key

Issues & Decisions

Current LCM Event Object

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

Type:Values

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

AVC Event Object

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

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)

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

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

NcmpAsyncRequestResponse Event Object

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)

Proposed New Schema:

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

#6 Batch Response Event (DMI → NCMP)

Common Header Mapping