Versions Compared

Old Version 115

changes.mady.by.user Toine Siebelink

Saved on

compared with

New Version 116

changes.mady.by.user Toine Siebelink

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

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

Issues & Decisions

#DescriptionNotesDecision
1No 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. 

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

Sourabh Sourabh to provide Jira tickets

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCPS-1658

3Should all the events have same kafka headersHeaders

kieran mccarthy Possibly Common (base) set of headers but mandatory aspect might differ. In practice we might need a separate headers (schema?) for each event

4Clarify 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 to use semantic versioning which ORAN follows https://semver.org.

5What to do with additional event headers (from DMI Plugins)

kieran mccarthy   if DMI produce additional headers NCMP will discard those i.e. not included in forwarded events

6Event(Content) field in DMI Async Request Response Event has inconsistent name (compared with other schemas)
  1. Add V2 file
  2. Deprecate V1
  3. Support both versions for a while
  4. Delete the V1 version (after some time)

CPS Team Create a V2 of the schema and rename eventContent as event data. Do it as part of the schema addition.

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

kieran mccarthy and team agreed to:

  1. Temporary disable the legacy async request feature (task created: 
    Jira Legacy
    serverSystem Jira
    serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
    keyCPS-1694
    )
  2. 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 Legacy
    serverSystem Jira
    serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
    keyCPS-1693
    )
8Dmi 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. 

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

POC to follow. 

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCPS-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?!


 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 . 

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

 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. 

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. 

11Is anyone using Async Request feature?

See

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCPS-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!

 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

12Do 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
13AVC 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 meeting kieran mccarthy updated #3 is ON HOLD to analyse further. 

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

14Align headers with CNCF Cloud EventsUsing 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

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 Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCPS-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.


16Do 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   Team agreed refer to CNFC doc. and add list of extensions eXtensions in RTD documentation. (key and value constraints)

17Inconsistent casing convention for header fields v. json data fieldsJust 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   Team agreed this is the way it is and Toine Siebelink will update to CPS Style page

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

...

Expand
titleLCM Event Details

Current LCM Event Object

FieldTypeDescription
Kafka
Header
Event
Payload
Field
NotesCloudEvents Mapping
eventIDstringThe unique id identifying the event
x
X
Mandatorystandard (id)
eventCorrelationIdstringThe id identifying the event.  In LCMEvent this is always a cmhandleId
x
X
Optional
(
extension
eXtension fields will be optional now)
extension
eXtension (correlationid)
eventTimestringThe timestamp when original event occurred
x
X
Mandatorystandard (time)
eventSourcestringThe source of the event
x
X
Mandatorystandard (source)
eventTypestringThe type of the event
x
X
Mandatorystandard (type)
eventSchemastringThe schema that this event adheres to. 
x
X

Mandatory


E

e.g.

 

cps:org.onap.ncmp.cmhandle.lcm-event:1.0.0

standard (dataschema)
eventSchemaVersionstring

The version of the schema that this event adheres to

x
X

Mandatory

e.g v1.0

N/A included in 'dataschema'
eventEventThe payload of an event
XMandatorystandard (data)
N/AN/AThe version of CNCF SpecificationX
Specified by CNCF (value hardcoded)

standard (specversion)

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

FieldTypeDescription
Kafka
Header
Event
Payload
Field
Notes
cmHandleIdstringcmHandle id
x

X
oldValuesValues

Values that represents the state of a cmHandle

x

XDefined by values object below
newValuesValuesValues that represents the state of a cmHandle
x

XDefined by values object below

Type:Values

FieldTypeDescription
Kafka
Header
Event
Payload
Field
Notes
dataSyncEnabledstringcmHandle id
x

X
cmHandleStatestring

State of cmHandle

x

XEnum: 
["ADVISED", "READY", "LOCKED", "DELETING", "DELETED"]
cmHandlePropertiesobjectcmHandle properties
x

XList of Java <String, String> Maps


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

...

Expand
titleDMI Data AVC Event

AVC Event Object

FieldTypeDescription
Kafka
Header
Event
Payload
Field
NotesCloudEvents Mapping
eventIDstringThe unique id identifying the event
x
X
Mandatorystandard (id)
eventCorrelationIdstringThe id identifying the event
x
X
Optional
extension
eXtension(correlationid)
eventTimestringThe timestamp when original event occurred
x
X
Optionalstandard (time)
eventSourcestringThe source of the event
x
X
Optionalstandard (source)
eventTypestringThe type of the event
x
X
Mandatory

(e.g. cps:org.onap.cps.ncmp.events:avc-event)standard (type)
eventSchemastringThe schema that this event adheres to
x
X
Mandatory (e.g. cps:org.onap.cps.ncmp.events:avc-event-schema)standard (dataschema)
eventSchemaVersionstring

The version of the schema that this event adheres to

x
X
MandatoryN/A included in 'dataschema'
eventEventThe payload of an event

Mandatorystandard (data)

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

FieldTypeDescriptionKafka HeaderEvent Payload FieldNotes

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
titleAVC Subscription Event

Subscription Event Object

FieldTypeDescription
Kafka
Header
Event
Payload
Field
NotesCloudEvents Mapping
versionstringThe event type versionX
ekiemcc : What is this version?  This should be covered in the header now?included in dataschemaeventType


included in dataschema
eventTypestring

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
eventEventThe payload for an eventX
Defined by event object belowstandard (data) 

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

FieldTypeDescription
Kafka
Header
Event
Payload
Field
Notes
subscriptionSubscriptionThe subscription details
x

XDefined by subscription object below
dataTypeDataType

The datatype content

x

XDefined by dataType object below
predicatesPredicates

Additional values to be added into the subscription

x

XDefined by predicates object below

Type: Subscription

FieldTypeDescription
Kafka
Header
Event
Payload
Field
Notes
clientIDstring

The client ID

x

X
namestring

The name of the subscription

x

X
isTaggedboolean

optional parameter, default is false

x

Xdefault: false

Type: DataType

FieldTypeDescription
Kafka
Header
Event
Payload
Field
Notes
dataspacestring

The dataspace name

x

X
dataCategorystring

The category type of the data

x

X
dataProviderstring

The provider name of the data

x

X
schemaNamestring

The name of the schema

x

X
schemaVersionstring

The version of the schema

x

X

Type: Predicates

FieldTypeDescription
Kafka
Header
Event
Payload
Field
Notes
targetsarray

CM Handles to be targeted by the subscription

x

X
datastorestring

datastore which is to be used by the subscription

x

X
xpath

Xpath-filterstring

filter to be applied to the CM Handles through this event

x

X


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

...

Expand
titleDMI Async Request Response Event

DmiAsyncRequestResponse Event Object

FieldTypeDescription
Kafka
Header
Event Payload Field
Payload NotesCloudEvents Mapping
eventIDstringThe unique id identifying the event generated by DMI
x
X

standard (id) 
eventCorrelationIdstring

The request id passed by NCMP

x
X
extensions


eXtensions (correlationid)
eventTimestringThe timestamp when original event occurred
x
X

standard (time) 
eventTargetstringThe target of the event
x
X
extensions


eXtensions (target)
eventTypestringThe type of the event
x
X

standard (type) 
eventSchemastring

The event schema for async request response events

x
X

standard (dataschema) 
eventSchemaVersionstring

The event schema version for async request response events

x
X

N/A included in 'dataschema'
eventSourcestringThe source of the event
x
X

standard (source) 
eventContentEventContentThe 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)

FieldTypeDescription
Kafka
Header
Event
Payload
Field
Notes
repsonse
response-data-schemastring

The schema of response data

x

X
response-statusstring

The status of the response

x

X
response-codestring

The code of the response

x

X
response-dataobjectThe data payload
x

Xcontains payload of type object


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

...

Expand
titleNCMP Async Request Response Event

NcmpAsyncRequestResponse Event Object

FieldTypeDescription
Kafka
Header
Event
Payload
Field
NotesCloudEvents Mapping
eventIDstringThe unique id identifying the event generated by DMI
x
X

standard (id) 
eventCorrelationIdstring

The request id passed by NCMP

x
X
extensions


eXtensions (correlationid)
eventTimestringThe timestamp when original event occurred
x
X

standard (time) 
eventTargetstringThe target of the event
x
X
extensions


eXtensions (target)
eventTypestringThe type of the event
x
X

standard (type) 
eventSchemastring

The event schema for async request response events

x
X

standard (dataschema) 
eventSchemaVersionstring

The event schema version for async request response events

x
X

N/A included in 'dataschema'
eventEventThe payload of an
event
event
XDefined by event object belowstandard (
source
data) 
forwardedEventForwardedEventThe 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)

FieldTypeDescription
Kafka
Header
Event
Payload
Field
Notes
eventIDstringThe unique id identifying the event generated by DMI
x

XOnly in payload in v1 of the payload schema.  To be removed in v2 version (will be in the header only)
eventCorrelationIdstring

The request id passed by NCMP

x

Xas above
eventTimestringThe timestamp when original event occurred
x

Xas above
eventTargetstringThe target of the event
x

Xas above
eventTypestringThe type of the event
x

Xas above
eventSchemastring

The event schema for async request response events

x

Xas above
eventSourcestring

The source of the event

x

X
response-data-schemastring

The received schema of response data

x

X
response-statusstring

The received status of the response

x

X


response-codestring

The received code of the response

x

X
response-dataobject

The data payload

x

Xcontains payload of type object

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

FieldTypeDescriptionKafka HeaderEvent Payload FieldNotes
eventIDstringThe unique id identifying the event generated by DMI
?Can NCMP put these in the header and remove them from the 'forwardedEvent'
eventCorrelationIdstring

The request id passed by NCMP


?as above
eventTimestringThe timestamp when original event occurred
?as above
eventTargetstringThe target of the event
?as above
eventTypestringThe type of the event
?as above
eventSchemastring

The event schema for async request response events


?as above
eventSchemaVersionstring

The event schema version for async request response events


?as above
eventSourcestring

The source of the event


?as above
response-data-schemastring

The received schema of response data


xX
response-statusstring

The received status of the response


xX


response-codestring

The received code of the response


xX
response-dataobject

The data payload


xXcontains payload of type object

Proposed New Schema:

see

Jira Legacy
serverSystem Jira
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCPS-1660

FieldTypeDescription
Kafka
Header
Event
Payload
Field
NotesCloudEvents Mapping
eventIDstringThe unique id identifying the event generated by DMIX

standard (id)
eventCorrelationIdstring

The request id passed by NCMP

extensions
X

eXtensions(correlationid)
eventTimestringThe timestamp when original event occurredX

standard (time)
eventSourcestringThe source of the eventX
What value should contain in this? Needs clarification, see issue #8standard (source)
eventTypestringThe type of the eventX

standard (type)
eventSchemastring

The event schema for async request response events

X

standard (dataschema)
eventSchemaVersionstring

The event schema version for async request response events

X

N/A included in 'dataschema'
eventEventThe payload of an event
XDefined by event object belowstandard (data)

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

FieldTypeDescription
Kafka
Header
Event
Payload
Field
Notes
eventCorrelationIdstring

The request id passed by NCMP

X
as above @Toine asked to add this property.
responseStatusstring

The received status of the response


X


responseCodestring

The received code of the response


X
responseDataobject

The data payload


Xcontains payload of type object


#6 Batch Response Event (DMI → NCMP)

...

Expand
titleDMI Async Batch Response Event

BatchResponseEvent Object

Excerpt


FieldTypeDescription
Kafka
Header
Event
Payload
Field
NotesCloudEvents Mapping
eventIDstringThe unique id identifying the event generated by DMI
x
X

Mandatory

. Generated by DMI-Plugin

standard (time) 
eventCorrelationIdstring

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)
eventTargetstringThe destination topic of the client
x
X
Mandatory. TBC
example
Example: my-topic
extensions
eXtension (
target  TBC
destination)
sourcestringThe source of the event

Optional. Example : dmi-plugin:enm-1 (dmi service name)
eventTimestringThe 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) 
eventTypestringThe 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) 
eventSchemastring

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

The event schema version for async request response events

x
X

N/A included in 'dataschema'
eventEventThe payload of an event
x

Xjava object not yet defined by schema, see issue #2standard (data) 
specversionStringVersion of CNCF spec
x
X
hardcoded value of 1.0standard (
hardcode value
specversion)



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

FieldTypeDescriptionKafka HeaderEvent Payload FieldNotes
No Properties defined (Entire event treated as single object)


...

Expand
titleNCMP Async Batch Response Event - Client Topic

BatchResponseEvent Object

FieldTypeDescription
Kafka
Header
Event
Payload
Field
NotesCloudEvents Mapping
eventIDstringThe unique id identifying the event generated by DMI
x
X

standard (id) 
eventCorrelationIdstring

The request id passed by NCMP

x
X
extensions


eXtensions (correlationid)
eventTimestringThe timestamp when original event occurred
x
X

standard (time) 
eventTypestringThe type of the event
x
X

standard (type) 
eventSchemastring

The event schema for async request response events

x
X

standard (dataschema) 
eventSchemaVersionstring

The event schema version for async request response events

x
X

N/A included in 'dataschema'
eventEventThe payload of an event
x

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


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

FieldTypeDescriptionKafka HeaderEvent Payload FieldNotes
No Properties defined (Entire event treated as single object)


CNCF Cloud Event alignment

Introduction

CNCF CloudEvents is a specification for describing event data in common formats to provide interoperability across services, platforms and systems.

  • 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.)

...

  1. https://github.com/cloudevents/spec

  2. https://github.com/cloudevents/sdk-java
  3. https://mvnrepository.com/artifact/io.cloudevents
  4. Examples : https://github.com/cloudevents/sdk-java/tree/main/examplesExamples/kafka/src/main/java/io/cloudevents/examplesExamples/kafka

Common Header Mapping

...

Before

After

CloudeEvent builder methodExample ValueNotes 

eventId

id

.withId()
Mandatory

eventSource

source

.withSource()
Mandatory

N/A

specversion  (default 1.0)

.v1()1.0Mandatory  - 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/jsonOptional
eventCorrelationIdcorrelationid.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.

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

...