Page History

Create 'bulk' version for org.onap.cps.ncmp.rest.controller.NetworkCmProxyController#getResourceDataForCmHandle to support multiple cm-handles (~ multiple anchors in in CPS-Core)

Table of Contents

References

CPS-1515 - Spike: Support multiple CM-Handles for NCMP Get Operation
CPS-NCMP ↔ DMI-Plugin Interface Details Jakarta-R10

Requirements

Functional

#	Interface	Requirement	Additional Information
1	REST CPS(-NCMP)-E-05	Support batch read operation (new) using an asynchronous response on a client specified topic	payload includes list of cm handle ids
2	REST DMI-I-01	Support batch read operation (new) using an asynchronous response to an internal topic	payload includes list of (associated for this plugin) cm handles ids with their private (additional) properties

Error Handling

#	Error Scenario	Expected behavior
1	DMI Not respond to initial synchronous request with normal HTTP timeout	Special Error message (Kafka event) including affected, and reason for all the handles in the message cm handles send to client topic detailing cm-handles (per dmi plugin)
2	Topic not supplied on CPS-E-05	Return HTTP 501 (not implemented)
3	Client specided Topic is not configured	Log error message only
4	Non-existing cm-handle id	Similar message but different reason as specified #1 above

Capabilities

Excerpt

# Parameter Expectation Notes

1

Response Time 1 Batch request

<2 seconds (average)

Async response available on client topic
No delay in DMI PLugin (tested/measured using stub DMI Plugin)

2 Batch-size 200 cm handles No hardcoded limit

3 Response payload size ~2 KB per cm handles Performance test for capability should be tested with this average response size

4 Maximum registered #cm handles 20,000 This will effect the internal query time

5 Supported # DMI PLugins 10 This might effect processing times

6

Test Environment

Expand

CPS and NCMP

requests: cpu: 2000m memory: 2Gi limits: memory: 3Gi cpu: 3000m

2. Postgres

requests:
    cpu: 4000m
    memory: 1Gi
limits:
    memory: 3Gi
    cpu: 6000m

7 Concurrent request 12 12 clients requests toward 1 NCMP simultaneously

8 Request Frequency 100 request/min Should not affect performance, does not need to be tested

Out-of-scope

Support for multiple resource identifiers in one batch operation
Support cached data batch requests: only passthrough datastores will be supported (see decision #2)
NCMP does NOT keep track of request status to see if it is completed, amalgamate responses or anything like that. It wil simply forward responses from the internal topic to the client topic.
Access control

Assumptions

#	Assumption	Notes
1	Proprietary options or not in the scope of this analysis.	agreed 08 Mar 2023 with kieran mccarthy ; these are optional parameters (name-value pairs) not interpreted by NCMP but can be interpreted by proprietary plugins In the future "scope" might become standardized instead of proprietary but that wil be achieved through a separate requirement
2	same xpath (resourceIdentifierInQuery) for all cm handles or different for each cm handle	agreed 08 Mar 2023 with kieran mccarthy ; if different resources are required on the same cm-handle the client wil send another (batch) request
3	options, resourceIdentifier is optional for bulk operations. operation, datastore and cmhandleIds are mandatory fields	agreed 24 Apr 2023 with CPS team.
4	We are not merging any duplicate cm handles while sending request to dmi-plugin	agreed 24 Apr 2023
5	Get batch operation does not support includeDescendants as it is impl. for pass through datastore only ncmp-datastore:passthrough-running and ncmp-datastore:passthrough-operational	agreed on 15 May 2023

Issues & Decisions

#

Issue

Notes

Decision

1

Which operation(s) need support for multiple cm handles?

Get
Create
Update (Put)
Patch
Delete

if many what is the priority?

agreed 08 Mar 2023 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 ?
(maybe just start with that, support cached data bulk request later)

agreed 08 Mar 2023 with kieran mccarthy :

all passthrough datastores will be supported

Not implemented (yet) response, for non passthrough datastores

3

URL pattern for NCMP bulk endpoints

~~08 Mar 2023~~

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

~~-----------------------------------------------------------------------------------------------------------------------~~

~~17 Apr 2023 Meeting : kafka message schema & batch interface extension~~

~~POST http://localhost:8080/ncmp/v1/batch/data&topic=my-topic-name~~

{
operations: [
{
operation: read,
datastore: "...",
options: "...",
resourceIdentifier: "...",
cmhandleIds: [4, 6]
},
{
operation: read,
datastore: "...",
options: "...",
resourceIdentifier: "...",
cmhandleIds: [1, 2, 3]
}
]
}

~~23 May 2023~~

~~POST http://localhost:8080/ncmp/v1/data&topic=my-topic-name~~

~~agreed~~ 08 Mar 2023 ~~with kieran mccarthy : Follow the existing interfaces as much as possible for consistency and efficiency~~

------------------------------------------------------------------------------------------------------------

23 May 2023 kieran mccarthy

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)

Before	After
~~POST http://localhost:8080/ncmp/v1/batch/data&topic=my-topic-name~~	POST http://localhost:8080/ncmp/v1/data&topic=my-topic-name

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 08 Mar 2023 with kieran mccarthy : Follow the existing interfaces as much as possible for consistency and efficiency

5

support in ONAP DMI-plugin

agreed 08 Mar 2023 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 08 Mar 2023 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 08 Mar 2023 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 08 Mar 2023 with kieran mccarthy :
No response for 4b then send an error response to the topic given by client

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 08 Mar 2023 with kieran mccarthy :
NCMP can log error when forward to 'client topic' Security not in scope (yet)

10

How to handle non-existing CM-Handles (id)

Suggestions

Silently ignore
(initial) error response
1. should we combine all errors in one message?

Agreed 08 Mar 2023 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:

Jira

server	ONAP Jira
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1377

?!

08 Mar 2023 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

Jira

server	ONAP Jira
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1556

1) Agreement required on the structure of the response. Please see response structure below.
2) Does 'eventTime' field which holds the timestamp of the bulk response event, required or can it be dropped?

Code Block

title	Batch Event Headers Schema
collapse	true

{
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "$id": "urn:cps:org.onap.cps.ncmp.events.async:batch-event-headers:1.0.0",
  "$ref": "#/definitions/BatchEventHeaders",
  "definitions": {
    "BatchEventHeaders": {
      "description": "The header information of the Batch event.",
      "type": "object",
      "javaType" : "org.onap.cps.ncmp.events.async.v1.BatchEventHeaders",
      "properties": {
        "eventId": {
          "description": "The unique id for identifying the event.",
          "type": "string"
        },
        "eventCorrelationId": {
          "description": "The request id received by NCMP as an acknowledgement.",
          "type": "string"
        },
        "eventTime": {
          "description": "The time of the event. It should be in RFC format ('yyyy-MM-		     dd'T'HH:mm:ss.SSSZ').",
          "type": "string"
        },
        "eventTarget": {
          "description": "The destination topic to forward the consumed event.",
          "type": "string"
        },
        "eventSource": {
          "description": "The source of the event.",
          "type": "string"
        },
        "eventType": {
          "description": "The type of the Batch event.",
          "type": "string"
        },
        "eventSchema": {
          "description": "The schema of the Batch event payload.",
          "type": "string"
        },
        "eventSchemaVersion": {
          "description": "The schema version of the Batch event payload.",
          "type": "string"
        }
      },
      "required": [
        "eventId",
        "eventCorrelationId",
        "eventTarget",
        "eventType",
        "eventSchema",
        "eventSchemaVersion"
      ],
      "additionalProperties": false
    }
  }
}

Code Block

title	Sample Batch Event Headers
collapse	true

{
  "eventId":            "4cb32729-85e3-44d1-aa6e-c923b9b059a5",
  "eventCorrelationId": "68f15800-8ed4-4bae-9e53-27a9e03e1911",
  "eventTime":          "2023-03-28T14:29:23.876+0000",
  "eventTarget":        "client-topic"
  "eventSource":        "dmi-plugin:enm-1"(dmi service name)
  "eventType":          "org.onap.cps.ncmp.event.model.BulkResponseEvent",
  "eventSchema":        "urn:cps:org.onap.cps.ncmp.events.async:batch-event-schema:1.0.0",
  "schemaVersion":      "1.0.0",

}

Code Block

title	Batch Event Payload Schema
collapse	true

{
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "$id": "urn:cps:org.onap.cps.ncmp.events.async:batch-event-schema:1.0.0",
  "$ref": "#/definitions/BatchDataResponseEvent",
  "definitions": {
    "BatchDataResponseEvent": {
      "description": "The payload of batch event.",
      "type": "object",
      "javaType" : "org.onap.cps.ncmp.events.async.v1.BatchEvent",
      "properties": {
        "event": {
          "description": "The content of Batch event.",
          "type": "object",
          "existingJavaType": "java.lang.Object",
          "additionalProperties": false
        }
      },
      "required": [
        "event"
      ],
      "additionalProperties": false
    }
  }
}

Code Block

title	Sample Batch Event Payload
collapse	true

{     
  "event": {
     "payload": "response of batch cm handles"
  } 
}

Need to follow schema structure there in #15 under Issues & Decisions section and it is agreed on 11 May 2023

13

~~Schema for Bulk Response event forwarding to client specified topic~~

CPS-1557 - NCMP : forward bulk response messages to client topic

~~Not keeping the 'eventTarget' which comes from the (BulkResponseEvent(In progress of the structure agreement)).~~

~~Note: Will consider 'eventTarget', If it finalized the schema from~~

Jira

server	ONAP Jira
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1556

Agreed on 11 May 2023 to keep one schema for both events (DMI → NCMP) and (NCMP → ClientApps)

14

How NCMP would forward response? (Response data : ref. message flow #6)

Jira

server	ONAP Jira
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1556

1. Do we need to send only one response containing all the requested cm handles ?
2. Send single response for each cm handle?
3. Single response message per DMI plugin?

kieran mccarthy - Please share your inputs on the above listed questions.

15

Message format for the batch interface

some non-styandard headers wil need to be implemented as 'extensions' and names to be confirmed

correlationid
target

23 May 2023 kieran mccarthy

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.
More details see CPS Events Structure#CNCFCloudEventalignment

16

NCMP wil send only one request to each DMI

Code Block

language	bash
title	NCMP batch endpoint
collapse	true

curl --location 'http: //localhost:8080/ncmp/v1/data?topic=my-topic-name' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Y3BzdXNlcjpjcHNyMGNrcyE=' \
--data '{
    "operations": [
        {
            "operation": "read",
            "operationId": "12",
            "datastore": "ncmp-datastore:passthrough-operational",
            "options": "(fields=schemas/schema)",
            "resourceIdentifier": "parent/child",
            "targetIds": [
                "836bb62201f34a7aa056a47bd95a81ed",
                "202acb75b4a54e43bb1ff8c0c17a8e08"
            ]
        },
        {
            "operation": "read",
            "operationId": "14",
            "datastore": "ncmp-datastore:passthrough-running",
            "targetIds": [
                "ec2e9495679a43c58659c07d87025e72",
                "0df4d39af6514d99b816758148389cfd"
            ]
        }
    ]
}'

Code Block

language	bash
title	NCMP batch endpoint response (200->OK)
collapse	true

{
    "requestId": "4753fc1f-7de2-449a-b306-a6204b5370b3"
}

Code Block

language	bash
title	DMI service batch endpoint
collapse	true

DMI Service 1 (POST): http://172.26.202.25:8783/dmi/v1/data?topic=my-topic-name&requestId=4753fc1f-7de2-449a-b306-a6204b5370b3 -> 

[
    {
        "operationType": "read",
        "operationId": "14",
        "datastore": "ncmp-datastore:passthrough-running",
        "cmHandles": [
            {
                "id": "ec2e9495679a43c58659c07d87025e72",
                "cmHandleProperties": {
                    "neType": "RadioNode"
                }
            },
            {
                "id": "0df4d39af6514d99b816758148389cfd",
                "cmHandleProperties": {
                    "neType": "RadioNode"
                }
            }
        ]
    }
]

DMI Service 2 (POST) : http://172.26.202.26:8783/dmi/v1/data?topic=my-topic-name&requestId=4753fc1f-7de2-449a-b306-a6204b5370b3 -> 

   [
    {
        "operationType": "read",
        "operationId": "12",
        "datastore": "ncmp-datastore:passthrough-operational",
        "options": "(fields=schemas/schema)",
        "resourceIdentifier": "parent/child",
        "cmHandles": [
            {
                "id": "836bb62201f34a7aa056a47bd95a81ed",
                "cmHandleProperties": {
                    "neType": "RadioNode"
                }
            },
            {
                "id": "202acb75b4a54e43bb1ff8c0c17a8e08",
                "cmHandleProperties": {
                    "neType": "RadioNode"
                }
            }
        ]
    }
]

Agreed 11 May 2023 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

Mandatory Fileds :
- - "operation": "read"
  - "operationId": "12"
    "datastore": "ncmp-datastore:passthrough-operational"
  - "targetIds": [ "0df4d39af6514d99b816758148389cfd", "ec2e9495679a43c58659c07d87025e72" ]

Optional Fields :
- - "options": "(fields=schemas/schema)"
  - "resourceIdentifier": "parent/child"

17

Feature Name (events, URL)

event type proposal : from ~~BatchDataXXXEvent~~ to

DataOperationXXXEvent

For example : DataOperationResponseEvent

'eventType' value as below 'org.onap.cps.ncmp.events.~~Batch~~DataXXXEvent'

proposed Operation like :

'org.onap.cps.ncmp.events.DataOperationXXXEvent'

'batch' was the keyword use in the URL for this feature (now gone) but much code classes etc uses this name still...

Event Format Definitions

Event Headers

Field	Type	Description	Mandatory?	Notes
id	string	The unique id identifying the event	Mandatory	Generated by DMI-Plugin
correlationid	string	The request id passed by NCMP	Mandatory	It's requestId that NCMP sent to client as an ACK. Example : “request-1234" (UUID)
time	string	The timestamp when original event occurred	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.
target (TBC)	string	The destination topic of the client	Mandatory	Example : my-topic
source	string	The source of the event	Optional	Example : dmi-plugin:enm-1 (dmi service name)
type	string	The type of the event	Mandatory	NCMP owns eventType that would be used by dmi-plugins convention of eventType and Schema names is under discussion, see open issue #17
datacontenttype	string	The schema and version of the Batch event payload.	Mandatory	NCMP owns eventSchema that would be used by dmi-plugins convention of eventType and Schema names is under discussion, see open issue #17
`schemaVersion`	~~string~~	~~The schema version of the Batch event payload.~~	~~Mandatory~~	Included in `datacontenttype`
`specversion`	String		Mandatory	hardcoded value of 1.0

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

Mandatory

event.responses[0, 1, 2, ...]

Array

contains an array or batch response that includes both success and failure.

Mandatory

event.responses[0].operationId

String

specified to distinguish multiple operations using same cmhandleId

Mandatory

event.responses[0].ids

String

cmhandle-ids

Mandatory

Example : ["0df4d39af6514d99b816758148389cfd"]
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:

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

event.responses[0].status-message

String

Mandatory

Examples for code & message :

status-code	status-message
1	"Successfully applied changes"
101	"cmHandle(s) do not exist"

event.responses[0].data

Object

Optional

In case of success :Optional,  for write operations then no need to return configurations                    application/yang-patch+json | application/yang-data+json
In case of failure :Optional, any supplementary error data matching the error status-code

Implementation

Bulk Request Message Flow

Gliffy Diagram

macroId	5966a68a-1641-430a-8c78-27c938f06e15
displayName	Cm Handle Batch Message Flow
name	Cm Handle Batch Interface Design
pagePin	21

Message Flow details

Flow Step

Short description

Message Details

Notes

1

Bulk Get Request

Code Block

title	/v1/batch/data/ds/{datastore-name}
collapse	true

body:
["cm-1",...,"cm-n"]

Code Block

title	Example CURL cmd : curl --location --request POST
collapse	true

'http://localhost:8080/ncmp/v1/batch/data/ds/ncmp-datastore:passthrough-running?resourceIdentifier=parent/child%26options=(a=1,b=2)&topic=my-topic-name&options=(fields=schemas/schema)' \
--header 'Authorization: Basic Y3BzdXNlcjpjcHNyMGNrcyE=' \
--header 'Content-Type: application/json' \
--data '[ "40137a9771f84459affa795fa1d633ab", "f5a92ec7a7db4d6fbb0e0ce2803a86cc" ]'

Define new get operation "getResourceDataForCmHandles" into ncmp.yml

2

Ack clent Request

Code Block

title	Response 200
collapse	true

{"requestId":"123"}

3

DMI Bulk Request

Code Block

title	/v1/ch/batch/data/ds/{datastore-name}&topic=topicParamInQuery
collapse	true

body: {"Cmhandles":["cm-1",...,"cm-n"],"requestId":123}

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

Code Block

title	Response 202
collapse	true

202 is non-committal, meaning that there is no way for the HTTP to later send an asynchronous response indicating the outcome of processing the request. It is intended for cases where another process or server handles the request, or for batch processing.

5

Kafka Messages from DMI to NCMP

Code Block

title	Batch Event Headers
collapse	true

{
  "eventId":            "4cb32729-85e3-44d1-aa6e-c923b9b059a5",
  "eventCorrelationId": "68f15800-8ed4-4bae-9e53-27a9e03e1911",
  "eventTime":          "2023-03-28T14:29:23.876+0000",
  "eventTarget":        "client-topic"
  "eventSource":        "dmi-plugin:enm-1"(dmi service name)
  "eventType":          "org.onap.cps.ncmp.event.model.BulkResponseEvent",
  "eventSchema":        "urn:cps:org.onap.cps.ncmp.events.async:batch-event-schema:1.0.0",
  "schemaVersion":      "1.0.0",

}

Code Block

title	Batch Event Payload
collapse	true

{     
  "event": {
     "payload": "response of batch cm handles"
  } 
}

6

Kafka Message(s) from NCMP to Client

Code Block

title	Batch Event Headers
collapse	true

{
  "eventId":            "4cb32729-85e3-44d1-aa6e-c923b9b059a5",
  "eventCorrelationId": "68f15800-8ed4-4bae-9e53-27a9e03e1911",
  "eventTime":          "2023-03-28T14:29:23.876+0000",
  "eventSource":        "dmi-plugin:enm-1"(dmi service name)
  "eventType":          "org.onap.cps.ncmp.event.model.BulkResponseEvent",
  "eventSchema":        "urn:cps:org.onap.cps.ncmp.events.async:batch-event-schema:1.0.0",
  "schemaVersion":      "1.0.0",

}

Code Block

title	Batch Event Payload
collapse	true

{     
  "event": {
     "payload": "response of batch cm handles"
  } 
}

7

Alternative for 4/5 → Non responding DMI. NCMP will have to create error message detailing cm-handles

See decision # 8 and 9

8

Response message structure ? (Flow no. 5)

Non responding DMI-plugin

Code Block

title	Non responding DMI-plugin
collapse	true

{
  "timestamp":"2023-03-01T23:00:00.345-0400", 
  "requestId":123,
  "error": "DMI Service Unavailable, {service-name}",
  "Cmhandles":["cm-1",...,"cm-n"]
  }

9

Response message structure ? (Flow no. 5)

Non existing cm handles

Code Block

title	Non existing cm handles
collapse	true

{
	"timestamp":"2023-03-01T23:00:00.345-0400",
    "requestId":123,
	"error":"Cm-Handle not found",
	"Cmhandles":["cm-1",...,"cm-n"]
}

10

Non Ready cm handles

Code Block

title	Non READY existing cm handles
collapse	true

{
	"timestamp":"2023-03-01T23:00:00.345-0400",
    "requestId":123,
	"error":"Cm-Handle not in READY state.",
	"Cmhandles":["cm-1",...,"cm-n"]
}

11

URL pattern for DMI-Plugin bulk endpoints

Existing DMI endpoints are :

/v1/ch/{cmHandle}/data/ds/{datastore-name}

datastore-name:

ncmp-datastore:passthrough-operational
ncmp-datastore:passthrough-running

...&topic=topicParamInQuery

CPS Proposed :

/v1/ch/batch/data/ds/{datastore-name}

...&topic=topicParamInQuery

cm handle ids and requestid into body

Proposed JIRAs :

Priority

Component

Description

JIRAs

Estimate

Status

1

DMI, NCMP

Batch Response Event (DMI → NCMP) to Comply with Cloud Events

Jira

server	ONAP Jira
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1723

5 Days (M)

New Requirement.

2

NCMP

Batch Response Event (NCMP → Client App)

Jira

server	ONAP Jira
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1724

TBD

New Requirement.

3

DMI-Plugin

Accept datastore name as param into URL

Jira

server	ONAP Jira
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1550

5 Days

Done

4

NCMP

Expose REST endpoint to accept collection of cm handles for GET operation (Passthrough only)

Jira

server	ONAP Jira
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1553

15 Days

Pending Doc. only

5

DMI-Plugin

Expose endpoint for ONAP not impl. and Stub impl. for testing/demo

Jira

server	ONAP Jira
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1555

5 Days

Done

6

NCMP

NCMP: Update existing REST endpoint that accepts bulk request for GET operation

Jira

server	ONAP Jira
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1635

5 Days

new because Requirements changed
+5 days

7

DMI-Plugin

DMI-Plugin : Update endpoint to accept bulk request

Jira

server	ONAP Jira
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1636

3 Days

new because Requirements changed

8

Stubbed DMI-Plugin

Include code to send response messages to internal kafka topic with delay

Jira

server	ONAP Jira
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1556

10 Days

9

NCMP

Forward response messages to client given kafka topic

Jira

server	ONAP Jira
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1557

5 Days

delayed because Schema/Headers issue

+4 days

10

NCMP

Handle non-existing cm handles

Jira

server	ONAP Jira
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1583

5 Days

11

NCMP

Error handling for non-ready cm handle state

Jira

server	ONAP Jira
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1614

5 Days

12

NCMP

Handle non responding DMI-Plugin

Jira

server	ONAP Jira
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1558

5 Days

13

CSIT test for demo

Jira

server	ONAP Jira
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-1560

5 Days

Planning :

Allow for 2 more user stories each may take 1 weeks
Based on 2 resource working parallelly may take àpprox. 8 weeks from 29 March 2023
The estimated date for completion is 14 Jun 2023

Space shortcuts

Page tree

Versions Compared

Old Version 143

New Version 144

Key

References

Requirements

Functional

Error Handling

Capabilities

Out-of-scope

Assumptions

Issues & Decisions

Event Format Definitions

Event Headers

Event Body (data)

Implementation

Bulk Request Message Flow

Message Flow details

Proposed JIRAs :

Planning :