Versions Compared

Old Version 125

changes.mady.by.user Toine Siebelink

Saved on

compared with

New Version Current

changes.mady.by.user Sourabh Sourabh

Saved on

Key

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

...

#Short NameSourceDestinationImpl. StatusNotesFull Schema NameDiagram Ref.
1LCM EventNCMPClient AppsIn UseLife Cycle Management Events, when cmHandles are added or removedcps:org.onap.ncmp.cmhandle.lcm-event:v1CM-Handle State Changes and Notifications Overview#Notificationhandlingincode
2DMI Data AVC EventDMINCMPImplemented, Not in useAttribute Value Change in configuration management (CM) data.cps:org.onap.cps.ncmp.events:avc-event-schema:v15 in CPS Data Notifications Overview#ComponentDiagram
3AVC Subscription Create EventClient NCMP & DMIsImplemented, Not in useCreate Event Only

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

7 in CPS Data Notifications Overview#ComponentDiagram
4DMI Async Request Response EventDMINCMPIn UseDMI 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
5NCMP Async Request Response EventNCMPClient AppsIn UseForward 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
6Bulk Response Event (Internal)DMINCMPIn ProgressInternal Kafka topiccps:org.onap.cps.ncmp.event:dmi-async-bulk-response-event-schema:v15 in CPS-1515: Spike: Support Multiple CM-Handles for NCMP Get Operation (batch Data operations)#BulkRequestMessageFlow
7

Bulk Response Event (Client)

NCMP Client AppsIn ProgressForwarding the DMI responses to the client topiccps:org.onap.cps.ncmp.event:ncmp-async-bulk-response-event-schema:v16 in CPS-1515: Spike: Support Multiple CM-Handles for NCMP Get Operation (batch Data operations)#BulkRequestMessageFlow

#1 LCM Event (NCMP → Client Apps)

...

Expand
titleDMI Async Batch Response Event

DmiDataOperationEvent Object

Excerpt


FieldTypeDescriptionHeaderPayloadNotesCloudEvents Mapping
eventIDstringThe unique id identifying the event generated by DMIX

Mandatory. Generated by DMI-Plugin

standard (id) 
eventCorrelationIdstring

The request id passed by NCMP

X
Mandatory. This is requestId that NCMP sent to client as an ACK.
example : “request-1234" (UUID)		extension (correlationid)
eventTargetstringThe destination topic of the clientX
Mandatory. TBC example: my-topicextension (destination)
sourcestringThe source of the event

Mandatory. example : dmi-plugin:enm-1 (dmi service name)standard (source) 
eventTimestringThe timestamp when original event occurredX

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

N/A included in 'dataschema'
eventEventThe payload of an event
Xjava object not yet defined by schema, see issue #2standard (data) 
specversionStringVersion of CNCF specX
hardcoded value of 1.0standard (specversion)



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

FieldTypeDescriptionHeaderPayloadNotes
No Properties defined (Entire event treated as single object)


...

  • Note 1 all cloud-event headers will be prefixed during serialization with 'ce_'  (this means when filtering on serialized Kafka-headers this prefix need to be applied)
  • Note 2 content-type is a a 'default' header name no 'wrapped' by CloudEvents and hence the inconsistency in names and that is does NOT have the 'ce_' prefix.

Common NCMP response staus code & message :

  • Status-code 0-99 is reserved for any success response
  • Status-code from 100 to 199 is reserved for any failed response. 

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