...
# | Issue | Notes | Decision | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | Which operation(s) need support for multiple cm handles? |
if many what is the priority? | agreed with kieran mccarthy Only Get (read) (in future other operations might be support batch option too) | ||||||||||||||||||||||||||||||||||||||||
2 | Which datasources should be supported? | Do we need to support passthrough-only no-cached() data only ? | agreed with kieran mccarthy : all passthrough datastores will be supported Not implemented (yet) response, for non passthrough datastores | ||||||||||||||||||||||||||||||||||||||||
3 | URL pattern for NCMP bulk endpoints |
----------------------------------------------------------------------------------------------------------------------- Meeting : kafka message schema & batch interface extension
{
|
------------------------------------------------------------------------------------------------------------ We had an internal review with some of our rApp colleagues around some of the recent proposed NCMP batch interface and they came back with some valid comment. The proposal is that we should not distinguish batch from bulk or other flavours of read/write. The aim is to only have a single flavour of interface for read or write for clients. Therefore the proposal is to drop “batch” from the interface URL and just act toward “data” (reads/writes/actions)
| ||||||||||||||||||||||||||||||||||||||||
4 | keep datastore, topic and optional parameters in the URL itself instead into body.
| CPS prefers keep interface similar as single cm handle interface (consistency and cost) Existing : ...&topic=topicParamInQuery | agreed with kieran mccarthy : Follow the existing interfaces as much as possible for consistency and efficiency | ||||||||||||||||||||||||||||||||||||||||
5 | support in ONAP DMI-plugin | agreed with Toine Siebelink : ONAP plugin can respond with not implemented yet code, | |||||||||||||||||||||||||||||||||||||||||
6 | Response always Async ie. topic is compulsory ? | Assume topic is compulsory (defined in OPenApi) → Response therefore wil be 400 if not supplied | Agreed with kieran mccarthy : Topic is optional but system will respond with 'Not implemented (yet when not specified or blank | ||||||||||||||||||||||||||||||||||||||||
7 | Should NCMP Amalgamate Async responses from DMI-Plugin before forwarding ? | step 6 in flow diagram | Agreed with kieran mccarthy : NCMP wil only forward to client topic no handling tracking or any responses or status of request | ||||||||||||||||||||||||||||||||||||||||
8 | Handle non responding dmi-plugin | Agreed with kieran mccarthy : | |||||||||||||||||||||||||||||||||||||||||
9 | Should (can) NCMP check if 'MyTopic' specified by client exist | Consider Access Control too. For now NCMP can log error. Client is responsible for topic setup | Agreed with kieran mccarthy : | ||||||||||||||||||||||||||||||||||||||||
10 | How to handle non-existing CM-Handles (id) | Suggestions
| Agreed with kieran mccarthy : Additional error (messages) response with all cm-handles that cannot be resolved, also a separate error message wil be sent for each failed DMI | ||||||||||||||||||||||||||||||||||||||||
11 | Overlap/clash with Deutsche Telekom user story:
| discussed in weekly ONAP meeting the DT user story is affect CPS-Core interface (not NCMP) and the requirement is to execute a query over ALL cm-handles (cached only?!) instead of a given list of cm-handles (~anchors) | |||||||||||||||||||||||||||||||||||||||||
12 | Schema of bulk response
| 1) Agreement required on the structure of the response. Please see response structure below.
| Need to follow schema structure there in #15 under Issues & Decisions section and it is agreed on | ||||||||||||||||||||||||||||||||||||||||
13 |
CPS-1557 - NCMP : forward bulk response messages to client topic |
| Agreed on to keep one schema for both events (DMI → NCMP) and (NCMP → ClientApps) | ||||||||||||||||||||||||||||||||||||||||
14 | How NCMP would forward response? (Response data : ref. message flow #6)
| 1. Do we need to send only one response containing all the requested cm handles ? | |||||||||||||||||||||||||||||||||||||||||
15 | Message format for the batch interface | We have had some internal discussions including with some O-RAN standards representatives and one of the outcomes is that it would be good if we aligned with the some community standards for event header definitions. IT is proposed (initially from AT&T) that we should follow Cloud Native Computing Foundation (CNCF) specification as defined in their cloudevents incubator project. | |||||||||||||||||||||||||||||||||||||||||
16 | NCMP wil send only one request to each DMI |
| Agreed with Csaba Kocsis and kieran mccarthy requestId would be send as a path param from NCMP to DMI-plugin. Example NCMP batch endpoint : http://localhost:8080/ncmp/v1/data?&topic=my-topic-name DMI-Plugin batch endpoint : http://172.26.202.25:8783/dmi/v1/data?topic=my-topic-name&requestId=e6fa4d26-4dc1-4877-aa3c-45e99f840708
| ||||||||||||||||||||||||||||||||||||||||
17 | Feature Name (events, URL) | event type proposal : from DataOperationXXXEvent For example : DataOperationResponseEvent 'eventType' value as below 'org.onap.cps.ncmp.events. proposed Operation like : 'org.onap.cps.ncmp.events.DataOperationXXXEvent' 'batch' was batch' is the keyword use in the UIRL URL for this feature |
Event Event Format Definitions
Event Headers
Field | Type | Description | M=Mandatory, O=Optional Mandatory? | Notes | Decision | ||||
---|---|---|---|---|---|---|---|---|---|
eventIdid | string | The unique id identifying the event | MMandatory | Generated by DMI-Plugin | |||||
correlationid | eventCorrelationId | string | The request id passed by NCMP | MMandatory | It's requestId that NCMP sent to client as an ACK. Example : “request-1234" (UUID) | ||||
Agreed with kieran mccarthyeventTimetime | string | The timestamp when original event occurred | O | Optional | The timestamp should follow that on https://www.rfc-editor.org/rfc/rfc3339#section-5. Example of Internet date/time format. 1985-04-12T23:20:50.52Z This represents 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. Agreed with kieran mccarthy 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 Deided field name as "time" | ||||
eventTarget | string | The destination topic of the client | M | Example : my-topic | |||||
target (TBC) | string | The destination topic of the client | Mandatory | Example : my-topic | |||||
source | string | The | eventSource | string | The source of the event | OOptional | Example : dmi-plugin:enm-1 (dmi service name) | ||
eventType | string | The type of the event | M |
| kieran mccarthy confirmed : event type proposed name :
proposed DataOperationXXXEvent For example : DataOperationResponseEvent 'eventType' value as below 'org.onap.cps.ncmp.events. proposed Operation like : 'org.onap.cps.ncmp.events.DataOperationXXXEvent' Deided field name as "type" | ||||
-1 (dmi service name) | |||||||||
type | string | The type of the event | Mandatory | NCMP owns eventType | eventSchema | string | The schema of the Batch event payload. | M | NCMP would own eventSchema that would be used by dmi- pluginkieran mccarthy confirmed : 'org.onap.cps.ncmp.events: Csaba Kocsiswould update ???? Deided field name as "datacontenttype" plugins convention of eventType and Schema names is under discussion, see open issue #17 |
datacontenttype | string | The schema of the Batch event payload. | Mandatory | NCMP owns eventSchema that would be used by dmi-plugins | |||||
schemaVersion | string | The schema version of the Batch event payload. | MMandatory | For example a version might be 1.0.0 (without “v”) | On versioning O-RAN follows https://semver.org. kieran mccarthy confirmed "eventSchemaVersion" | specversion (default 1.0) | String |
...
be 1.0.0 (without “v”) | ||||
specversion (default 1.0) | String |
Event Body (data)
- The current proposal is to use the CNFC Event structure and library as detail in CPS Events Structure#CNCFCloudEventalignment
- To prevent problems with large data request a single response event will be sent for a successful read for each cm handle (id)
- Error message can contain information about multiple cm handle ids
Field | Type | Description | Mandatory? | Notes |
---|---|---|---|---|
event | Event | The payload of an event |
M
Mandatory | ||
event.responses[0, 1, 2, ...] | Array | contains an array or batch response that includes both success and failure. |
M
Agreed on with kieran mccarthy
NCMP will not amalgamate any dataMandatory | ||
event.responses[0].operationId | String | specified to distinguish multiple operations using same cmhandleId |
M
Mandatory | ||
event.responses[0].ids | String | cmhandle-ids |
Mandatory | Example : |
["0df4d39af6514d99b816758148389cfd"] |
kieran mccarthy confirmed on
Question : If read there will only be a single cmhandle in this array ??
Ans :
Note: Ids array should contain only a single element in the array in case of success messages and In case of error it can have any number of elements. | |
event.responses[0].status-code | String |
Mandatory | Common NCMP defined error codes:
|
|
event.responses[0].status-message | String |
M
Mandatory | Examples for code & message |
:
|
event.responses[0].data | Object |
Optional |
|
Implementation
Bulk Request Message Flow
...