...
# | Assumption | Notes |
|---|---|---|
| 1 | Proprietary options or not in the scope of this analysis. | agreed with kieran mccarthy ; these are optional parameters (name-value pairs) not interpreted by NCMP but can be interpreted by proprietary plugins |
| 2 | same xpath (resourceIdentifierInQuery) for all cm handles or different for each cm handle | agreed with kieran mccarthy ; if different resources are required on the same cm-handle the client wil send another (batch) request |
Issues & Decisions
# | 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 | Existing : /v1/ch/{cm-handle}/data/ds/{datastore-name} CPS Proposed : /v1/batch/data/ds/{datastore-name} ( include cm handles into payload / body and leave datastore into url) | agreed with kieran mccarthy : Follow the existing interfaces as much as possible for consistency and efficiency | ||||||||
| 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 | URL pattern for DMI-Plugin bulk endpoints | Existing DMI endpoints are : /v1/ch/{cmHandle}/data/ds/{datastore-name} datastore-name:
...&topic=topicParamInQuery CPS Proposed : /v1/ch/batch/data/ds/{datastore-name} ...&topic=topicParamInQuery cm handle ids and requestid into body |
Response message structure ?
- Non responding DMI-plugin
- Non existing cm handles
- Success
- Failed
<Note. use green for closed issues, yellow for important ones if needed>
...
Flow Step | Short description | Message Details | Notes | |||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Bulk Get Request |
| Define new get operation "getResourceDataForCmHandles" into ncmp.yml | |||||||
| 2 | Ack Client Request |
| ||||||||
| 3 | DMI Bulk Request |
| The DMI PLugin should be told (included in request) the client topic so that NCMP does not have to 'remember' to relation between request id and client topic! | |||||||
| 4 | Ack Client Request |
| ||||||||
| 5 | Kafka Messages from DMI to NCMP |
| ||||||||
| 6 | Kafka Message(s) from NCMP to Client Table |
| ||||||||
| 7 | Alternative for 4/5 → Non responding DMI. NCMP will have to create error message detailing cm-handles | See decision # 8 | ||||||||
| 8 | Response message structure ? (Flow no. 5)
| TBD |
Proposed JIRAs :
| # | Component | Description | JIRAs | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | DMI-Plugin | Accept datastore name as param into URL |
| ||||||||
| 2 | NCMP | Expose REST endpoint to accept collection of cm handles for GET operation (Passthrough only) |
| ||||||||
| 3 | DMI-Plugin | Expose endpint for ONAP not impl. and Stub impl. for testing/demo |
| ||||||||
| 4 | Stubbed DMI-Plugin | Include code to send response messages to internal kafka topic with delay |
| ||||||||
| 5 | NCMP | Forward response messages to client given kafka topic |
| ||||||||
| 6 | NCMP | Handle non responding DMI-Plugin and non-existing cm handles |
| ||||||||
| 7 | CSIT test for demo |
|
...