...
- This page gives a description of CPS events including their fields
- Events will be split into events and Kafka headers
Event Overview
| # | Description | Source | Destination | Status | Notes | Full |
|---|
SchemaName| Schema Name |
|---|
| 1 | LCM Event | NCMP | External Client Apps | In Use | Life Cycle Management Events, when cmHandles are added or removed | cps:org.onap.ncmp.cmhandle.lcm-event:v1 |
" |
| 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 |
| 3 | AVC Subscription Create Event | External Client Apps | NCMP - Fwd to DMI | Implemented, Not in use | Create Event Only |
SubscriptionEventDmiAsyncRequestResponseEventcps:org.onap.cps.ncmp.events:dmi-async-request-response-event-schema:v1 |
| 5 | NCMP Async Request Response Event | NCMP | External Client Apps | In Use | Forward No.4 to client specified topic |
NcmpAsyncRequestResponseEventcps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1 |
| 6 | Bulk Response Event | DMI | NCMP | In Progress | Internal Kafka topic |
DmiAsyncBulkResponseEventError Message Reply to be decided | NcmpAsyncBulkResponseEvent | ...
| Forwarding the DMI responses to the client topic | cps:org.onap.cps.ncmp.event:ncmp-async-bulk-response-event-schema:v1 |
aLCM Event
Description
LCM (Life Cycle Management) Event
| Expand |
|---|
|
Current LCM Event Object| Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| eventID | string | The unique id identifying the event | x |
| M | | eventCorrelationId | string | The id identifying the event | x |
| O | | eventTime | string | The timestamp when original event occurred | x |
| M | | eventSource | string | The source of the event | x |
| O | | eventType | string | The type of the event | x |
| M | | eventSchema | string | The schema that this event adheres to | x |
| O | | eventSchemaVersion | string | The version of the schema that this event adheres to | x |
| O | | event | Event | The payload of an event |
|
| cps:org.onap.ncmp.cmhandle.lcm-event:v1
Defined by event object below
ekiemcc : Suggest to add the full schema name for the LCM event body and the eventSchemaVersion |
Type:Event| Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| 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| Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| dataSyncEnabled | string | cmHandle id |
| x |
| | cmHandleState | string | State of cmHandle |
| x | Enum: ["ADVISED", "READY", "LOCKED", "DELETING", "DELETED"] | | cmHandleProperties | object | cmHandle properties |
| x | List of Java <String, String> Maps |
|
...
| Expand |
|---|
|
AVC Event Object | Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| eventID | string | The unique id identifying the event | x |
|
| | eventCorrelationId | string | The id identifying the event | x |
|
| | eventTime | string | The timestamp when original event occurred | x |
|
| | eventSource | string | The source of the event | x |
|
| | eventType | string | The type of the event | x |
|
| | eventSchema | string | The schema that this event adheres to | x |
|
| | eventSchemaVersion | string | The version of the schema that this event adheres to | x |
|
| | event | Event | The payload of an event |
|
| cps:org.onap.cps.ncmp.events:avc-event-schema:v1 |
TODO : add table describing Type:Event |
...
| Expand |
|---|
| title | AVC Subscription Event |
|---|
|
Subscription Event Object | Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| version | string | The event type version |
|
| ekiemcc : What is this version? This should be covered in the header now? | | eventType | objectstring | The event type |
|
| ekiemcc : This is now covered by the header? Is this needed any longer in the body? Enum: ["CREATE"] | | event | objectEvent | The payload for an event |
|
| Defined by event object below |
Event Object| Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| subscription | objectSubscription | The subscription details |
|
| Defined by subscription object below | | dataType | objectDataType | The datatype content |
|
| Defined by dataType object below | | predicates | objectPredicates | Additional values to be added into the subscription |
|
| Defined by predicates object below |
Type: Subscription Object| Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| clientID | string | The client ID |
|
|
| | name | string | The name of the subscription |
|
|
| | isTagged | boolean | optional parameter, default is false |
|
| default: false |
Type: DataType Object| Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| dataspace | string | The dataspace name |
|
|
| | dataCategory | string | The category type of the data |
|
|
| | dataProvider | string | The provider name of the data |
|
|
| | schemaName | string | The name of the schema |
|
|
| | schemaVersion | string | The version of the schema |
|
|
|
Type: Predicates Object| Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| targets | array | CM Handles to be targeted by the subscription |
|
|
| | datastore | string | datastore which is to be used by the subscription |
|
|
| | xpath-filter | string | filter to be applied to the CM Handles through this event |
|
|
|
|
...
| Expand |
|---|
| title | DMI Async Request Response Event |
|---|
|
DmiAsyncRequestResponse Event Object | Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| eventID | string | The unique id identifying the event generated by DMI |
|
|
| | eventCorrelationId | string | The request id passed by NCMP |
|
|
| | eventTime | string | The timestamp when original event occurred |
|
|
| | eventTarget | string | The target of the event |
|
|
| | eventType | string | The type of the event |
|
|
| | eventSchema | string | The event schema for async request response events |
|
|
| | eventSchemaVersion | string | The event schema version for async request response events |
|
|
| | eventSource | string | The source of the event |
|
|
| | eventContent | objectEventContent | The payload of an event |
|
| cps:org.onap.cps.ncmp.events:dmi-async-request-response-event-schema:v1 Defined by eventContent object below |
Type: EventContent Object| Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| repsonse-data-schema | string | The schema of response data |
|
|
| | response-status | string | The status of the response |
|
|
| | response-code | string | The code of the response |
|
|
| | response-data | object | The data payload |
|
| contains payload of type object |
|
...
| Expand |
|---|
| title | NCMP Async Request Response Event |
|---|
|
NcmpAsyncRequestResponse Event Object | Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| eventID | string | The unique id identifying the event generated by DMI |
|
|
| | eventCorrelationId | string | The request id passed by NCMP |
|
|
| | eventTime | string | The timestamp when original event occurred |
|
|
| | eventTarget | string | The target of the event |
|
|
| | eventType | string | The type of the event |
|
|
| | eventSchema | string | The event schema for async request response events |
|
|
| | eventSchemaVersion | string | The event schema version for async request response events |
|
|
| | event | objectEvent | The payload of an event |
|
| Defined by event object below | | forwardedEvent | objectForwardedEvent | The payload of a forwarded event |
|
| Defined by forwardedEvent object below |
Type: Event | Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| eventID | string | The unique id identifying the event generated by DMI |
|
|
| | eventCorrelationId | string | The request id passed by NCMP |
|
|
| | eventTime | string | The timestamp when original event occurred |
|
|
| | eventTarget | string | The target of the event |
|
|
| | eventType | string | The type of the event |
|
|
| | eventSchema | string | The event schema for async request response events |
|
|
| | eventSource | string | The source of the event |
|
|
| | response-data-schema | string | The received schema of response data |
|
|
| | response-status | string | The received status of the response |
|
|
| | response-code | string | The received code of the response |
|
|
| | response-data | object | The data payload |
|
| contains payload of type object |
Type: forwardedEvent Object| Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| eventID | string | The unique id identifying the event generated by DMI |
|
|
| | eventCorrelationId | string | The request id passed by NCMP |
|
|
| | eventTime | string | The timestamp when original event occurred |
|
|
| | eventTarget | string | The target of the event |
|
|
| | eventType | string | The type of the event |
|
|
| | eventSchema | string | The event schema for async request response events |
|
|
| | eventSchemaVersion | string | The event schema version for async request response events |
|
|
| | eventSource | string | The source of the event |
|
|
| | response-data-schema | string | The received schema of response data |
|
|
| | response-status | string | The received status of the response |
|
|
| | response-code | string | The received code of the response |
|
|
| | response-data | object | The data payload |
|
| contains payload of type object |
|
...
