Requirements

ONAP Best Practices (Global Requirements) and similar

CPS-CORE / CPS-NCMP Requirements

Jira Legacy
server System Jira jqlQuery "Epic Link" = CPS-1615 count true serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176

Subscriptions

Jira Legacy
"Epic Link" = server System Jira columnIds issuekey,summary,assignee,status columns key,summary,assignee,status maximumIssues 20 jqlQuery jqlQuery "Epic Link" = CPS-1616 count true serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176

3Support update of cached data through a message driven solution.
Respond to  VES Events from Devices in ONAPReceive VES Event and transform it into a 'standard DMI→NCMP events (schema owned by NCMP)4Batch (bulk) Operations (Get, Query)5CM Handle Connectivity Freshness/Staleness6Update YANG schema-set for CM handle using ModuleSetTag

1. Update YANG schema-set for CM handle without removing and adding it
2. Cached data is not in scope.
3. Need to specify orphan handling of YANG modules (already built in ?)
4. Introduce concept of ModuleSetTag to prevent unnecessary trips to nodes to get al Modules
5. will require NCMP module loader (for upgrade of Inventory model) instead of Liquibase steps!

7Merge CM data subscriptions in NCMP when forwarding it to DMI Jira LegacyserverImplementing Data Notifications & Subscription Notifications on a US by US basis

Scope add: What kind of access controls are required on topics? Spike is required for this.  Work Item created (23/05).8This epic was created to take on additional scope which got added to CPS-1616

CM data subscriptions from application to DMI [Part 2].

It includes creating subscription with wildcard cmhandles. 

Access Control for resources to ensure that operators can restrict access control to only those users (human/machines) that are authorized to execute CRUD operations on those resources. 

9TBC

CPS-NMCP

TBC

TBC

Event DigestAdditional field to help clients filter CM AVC Events
(S)10

• TBC
• CPS-NMCP
• TBC
• TBC

AVC Subscription, advance filterFilter on 'Type' instead of list of CM Handle IDs → 'Type' could be defined as the yang module set containing a specific module (name and version)
(S)11

CM data subscriptions from application to DMI [Part 2].

It includes creating subscription with wildcard cmhandles. 

This epic was created to take on additional scope which got added to CPS-1616. 10

• TBC
• CPS-NMCP
• TBC
• TBC

Event DigestAdditional field to help clients filter CM AVC Events
(S)11

• TBC
• CPS-NMCP
• TBC
• TBC

AVC Subscription, advance filterFilter on 'Type' instead of list of CM Handle IDs → 'Type' could be defined as the yang module set containing a specific module (name and version)

(S)
12Support for list as top level data node
13Support for list as top level data nodeCPS & NCMP Feature Enhancement for M Release1214CPS & NCMP Feature Enhancement for M ReleaseYet to agree priorityA decision was made to abandon json+problem format1315

Spike for documenting Kafka interfaces using AsyncAPI

- Documentation Generation
- Interface Naming
- Cloud Events specifics asyncapi-cloud-events- Roll out for legacy events

- Code Generation (contract first, stubs)

14
16Refactor legacy NCMP ASync Response Events to use Cloud Events format(M)1517Support NCMP-CPS upgrade

Currently only custom upgrade is supported. (upon request)

Requirement: It shall be possible to upgrade NCMP-CPS from release N-1 to N (without requiring manual intervention/workarounds). N is defined as any release requested by ESH

• Note. Need to agree version strategy: use current ONAP x.y.z. numbering. Ericsson to communicate when a version is to be 'delivered' and 'y' increased

Technical Debt to be addressed: Liquibase is used in CPS to manage data(upgrades) in CPS

Study: Resolve technical debt (mixed data). NCMP Data upgrade. CPS Core need to support model upgrade so that NCMP can use it,

(XL) - Scope needs to be defined. Risk is scope not identified, efforts might increase.

1618Support multiple identifiers (alternatives for CM Handle ID)

(M) - Not sure. Scope not known yet. 

1719
Access control for topics which are created by NCMP .Spike needs to be conducted. 18
20
Invoke YANG modelled action

Always on operational datastore.  Supported for nmcp:passthrough-operational and if executed against ncmp:operational then it is always forwarded to dmi plugin.  Is there another story for forwarding to be included as a dependency? Always run as async request.  Is this dependent on CPS-1127  - see spin-off user stories table below this on.

KMC : Can we deprioritize - this can be run against passthrough-operational for now.  Just have to agree on the API / URL for the action to progress at this stage so that the passthrough-operational form is aligned with final operational form.

(S) - for passthrough. 

*Spec out before Sept'23. No implementation. 

19
21
Enhanced query support (fields)

Currently the passthrough has an 'fields' parameter to do a scoped query.  Propose to support this in non-passthrough so it is promoted to a fully supported option, e.g. {ncmp-root}/ncmp/v1/ch/335ff/data/ds/ncmp-datastore:passthrough-operational?
              resourceIdentifier=/&options=(fields=ericsson-enm-comtop:ManagedElement/ericsson-enm-
              gnbcucp:GNBCUCPFunction/EndpointResource/LocalSctpEndpoint/attributes(sctpEndpointRef),
         

KMC : Do we support restconf like queries or xpath only?

(L) .

*Spec out before Sept'23. No implementation. 

2022
Enhanced query support (scope)

Currently the passthrough has an 'fields' parameter to do a scoped query.  
              scope=ericsson-enm-comtop:ManagedElement/ericsson-enm-gnbcucp:GNBCUCPFunction/
               EndpointResource/LocalSctpEndpoint/attributes(interfaceUsed==X2))

KMC : Do we support restconf like queries or xpath only?

(L)

*Spec out before Sept'23. No implementation. 

2123Support ncmp-datastores:running for reading data (single CM handle, synchronous only)See CPS-391 page for details about supported operations and combinations. Note: There can be some overlap between work items for #5, #6, #11 and #12.

Read from operations.

(S) - Forward only.  No validation or data enhancements (add prefixis)
2224TBCSupport ncmp-datastores:running for writing data (single CM handle, synchronous only)(S)  As per #18
2325Support relationships for 'Instance Identifier'Should be possible to identify a cmhandle using multiple instance identifiers.
(M) - Not sure. Scope not known yet. 

2426Retrieve single module resource/v1/ch/{cm-handle}/modules/definitions/{moduleName}

(S)
2527
Access control for public interfaces (NCMP, CPS-Core, DMI?)KMC : What level of access control is there today - both on CPS and NCMP interfaces?


2628
Fine-grained cache configuration

2729
Validation required whether this is still needed. 2830TBCSend notifications on write operation in ncmp-datastores:running for (single CM handle, synchronous only)

2931
schema-set update for CM handle with cached data presentNeed to address case with incompatible model changes.
Scope: Upgrade of model that is cached?  Lee Anjella to confirm. 


3032
Invoke YANG modelled RPCSpecification required. Rebbot/Reset type of actions on node. 
3133DMI Audit for DMI restarts
3234Fetch a list of cmhandles along with their private properties as response from NCMP.