Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Overview

Project NameEnter the name of the project
Target Release NameJakarta
Project Lifecycle StateIncubation
Participating Companies Bell Canada, Ericsson, Wipro

Scope

What is this release trying to address?

...

Minimum Viable Product

N/A

Requirements

CPS-Core Requirements

NCMP Requirements

Priority legend: 

PreliminaryFixedIn ProgressCompletedDe-scoped

CPS-CORE / CPS-NCMP Requirements


CommittedCPS-638NCMPInvestigate Horizontal Scaling

Required for potentially long running requests

Note below to be agreed.,,

PriorityJakarta Requirement JiraComponent(s)DescriptionNotesJakarta commitmentJira(s)
1

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-1071

CPS-NCMPRetrieve list of modules (names) for a CM handleUsed by applications to get cached information from NCMP about modelsDelivered in Istanbul

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-485

2

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-1071

CPS-NCMPSupport ncmp-datastores:passthrough-Support ncmp-datastores:passthrough-running for read use-case (single CM handle, synchronous only)Need more details planning and prioritization for use-case not already supported list in this table : CPS-391Spike: Define and Agree NCMP REST Interface#Datastore,PathsandFormatCombinationsforReadOperationsDelivered in Istanbul, just pending Demos

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-615

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-646

3

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-1071

CPS-NCMPSeparate NCMP-DMI interface from northbound facing 'client' interfaceCommitted

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-645

4Retrieve cm-handles that have a given list modules

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPSREQ-6441071

5CPS-NCMPRetrieve cm-handles that have a given list modulesAllow separate registration of DMIDataPlugin and DmiModelPlugin
Committed

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-736

6

644

5

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-1071

CPS-NCMPAllow separate registration of DMIDataPlugin and DmiModelPluginSupport ncmp-datastores:passthrough-running for write use-case (single CM handle, synchronous only)Replace, Delete & Patch use-cases (#2, #3, #4) in :  CPS-391Spike: Define and Agree NCMP REST Interface#Datastore,PathsandFormatCombinationsforWriteOperations
Committed

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-636736

6

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-1071

CPS-637
Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySupport ncmp-datastores:passthrough-running for write use-case (single CM handle, synchronous only)Replace, Delete & Patch use-cases (#2, #3, #4) in :  CPS-391Spike: Define and Agree NCMP REST Interface#Datastore,PathsandFormatCombinationsforWriteOperationsCommitted

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-639636
Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-640637
Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-641638
Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-782639
Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-640
Jira
serverONAP Jira
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-777641

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-782
Jira
serverONAP Jira
columnIdsissuekey,summary,issuetype,created,columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-822777

Jira
serverONAP Jira
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-823822
Jira
serverONAP Jira
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-824823
Jira
serverONAP Jira
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-825

7Define states and state handling for CM handle, e g state of model and data sync

824
Jira
serverONAP Jira
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-799825

7

Jira
serverONAP Jira
serverId

8NCMP should publish notifications for any newly added (once synced) or deleted cm handles. Includes implementation of state handling (state persistence) as far as applicable as defined by #7 above9Support public CM handle propertiesBasic support for public properties + query capability

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-1071

CPS-NCMPDefine states and state handling for CM handle, e.g. state of model and data sync

677

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-817
Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-837799

8

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-1071

CPS-73110NCMPNCMP should publish notifications for any newly added (once synced) or deleted cm handles. Includes implementation of state handling (state persistence) as far as applicable as defined by #7 above

9

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-1071

CPS-78611

Implement -async option for CRUD and Patch operations (for one CM-Handle)

/ncmp/v1/data/ch/123ee5/ds/ncmp-datastore:*?topic=<topic-name> 

Accept : application/yang-data+json, application/json

Responses always published by NCMP to the client topic.

dmi-plugin may publish to NCMP on a local/private topic.  Response event payload contains the public topic name. NCMPSupport public CM handle propertiesBasic support for public properties + query capability

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-677
Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-817
Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-837
Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-731

10

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-1071

CPS-Core /
CPS-NCMPInvestigate Horizontal Scaling

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-786

11

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-1071

CPS-NCMP

Implement -async option for CRUD and Patch operations (for one CM-Handle)

Required for potentially long running requests

Note below to be agreed.,,

/ncmp/v1/data/ch/123ee5/ds/ncmp-datastore:*?topic=<topic-name> 

Accept : application/yang-data+json, application/json

Responses always published by NCMP to the client topic.

dmi-plugin may publish to NCMP on a local/private topic.  Response event payload contains the public topic name. 


Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-821

Jira
serverONAP Jira
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-828

12

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-1071

CPS-NCMPRead access at datastore level

This allows applications to query top-level data nodes without explicitly addressing them. 


Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-745

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-802

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-792

13

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-1071

CPS-821CoreYANG language extension supportInvestigation

Jira
serverONAP Jira
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolutionJira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-828

12Read access at datastore level

This allows applications to query top-level data nodes without explicitly addressing them. 

-735

14

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-1071

CPS-NCMPSend notification for updated CM handle metadata (public CM handle properties or YANG modules)


15

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-1071

CPS-NCMP[investigation/spec] CM data notifications from NCMP to applications including subscriptionsIncludes definition of notification and payload format

16
745

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-802

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-1071

CPS-792NCMPImplementation of CM data notifications forwarded by NCMP from DMI to application


1713YANG language extension supportInvestigation

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-1071

CPS-73514Send notification for updated CM handle metadata (public CM handle properties or YANG modules)15[investigation/spec] CM data notifications from NCMP to applications including subscriptionsIncludes definition of notification and payload format16Implementation of CM data notifications forwarded by NCMP from DMI to application17Core /
CPS-NCMPSupport for HTTPS and authentication


18

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-1071

CPS-Core /
CPS-NCMPAccess control for public interfaces (NCMP, CPS-Core, DMI?)


19
CPS-NCMPSupport ncmp-datastores:operational 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. Note: This item doesn't include accessing cached data as data sync is not available yet.


20
CPS-NCMPSupport ncmp-datastores:running for reading and writing 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.#12.

21
CPS-Core /
CPS-NCMP21Support for list as top level data node

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-491

Jira
serverONAP Jira
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-765
Jira
serverONAP Jira
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-766
Jira
serverONAP Jira
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-767

22
CPS-Core /
CPS-NCMPSupport for multiple roots from different modules in one CM handle/anchor



Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-341

23
CPS-NCMPExplicit (initial) data-sync for a CM handle (extend model-sync delivered in Istanbul)Triggered by client using REST endpoint on NCMP. Note: This item includes extended support for datastores to access the synced data.

Jira
serverONAP Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-507

24
CPS-NCMPSupport retrieval of YANG module sources for CM handle on the NCMP interface


25
CPS-Core /
CPS-NCMPUpdate YANG schema-set for CM handle without removing and adding itCached data is not in scope. Need to specify orphan handling of YANG modules.

26
CPS-Core /
CPS-NCMPschema-set update for CM handle with cached data presentNeed to address case with incompatible model changes.

27(ONAP) E2E Slicing Use-Case

Support dynamic inventory changes (ONAP DMI Plugin)

React to events from AAI sent over DMaaP, in turn using Inventory API for updates.
Strimzi-Kafka Bridge might be an alternative, check with Fiachra Corcoran  on the latest for this when implementing this (

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyDMAAP-1681
)

Possible in a generic way or it can also listen to similar events sent by SDN-R  (as suggested by Ahila P)


Jira
serverONAP JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-392
Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-393

28
CPS-NCMPAutomatic (optional) Data Sync Metadata (per cmHandle) controls whether this will happen or not

29
CPS-NCMPFine-grained cache configuration


30
CPS-Core /
CPS-NCMPExisting CPS-path based queries across multiple CM handles for cached data


31
CPS-NCMPInvoke YANG modelled action


32
CPS-NCMPInvoke YANG modelled RPC


Temporal DB Requirements

...

Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note, etc) of this release.

Deliverable NameDeliverable Description

onap/cps-and-ncmp

Container running CPS and NCMP
onap/cps-temporalContainer running CPS Temporal
onap/ncmp-dmi-pluginContainer running OMAP DMI Plugin
docs.onap.org/projects/onap-cps

CPS-NCMP Documentation for R10 (incl. offered APIs and release note)

docs.onap.org/projects/onap-cps-ncmp-dmi-pluginONAP DMI-Plugin Documentation for R10 (incl. offered APIs and release note)
docs.onap.org/projects/onap-cps-cps-temporalCPS-Temporal Documentation for R10 (incl. offered APIs and release note)

Sub-Components

  • CPS-Core
    • cps-service
    • cps-rest
    • cps-ri (reference implementation)
  • NCMP
    • cps-ncmp-service
    • cps-ncmp-rest
    • dmi-inventory
  • Temporal DB
  • DMI-Plugin
    • DMI Data Access
    • DMI Model Access

...

API this project is delivering to other projects.

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)

CPS-E-01
CPS-E-02
CPS-E-03

CPS Model LifeCycle
CPS Data Write
CPS Data Read


Swagger Sources (openapi.yaml)
CPS-E-04Change notifications


CPS-E-05xNF Data Access

Swagger Sources (openapi.yaml)
CPS-E-06Temporal Data Access
(no other component currently depends on this or plan to use it in Istanbul)


Swagger Sources (openapi.yml)
  • Third Party Products Dependencies

Third Party Products mean products that are mandatory to provide services for your components. 

NameDescriptionVersion
DockerVM Container18 and above
ODL Yang ToolsYang model and Data Parser6.0.1 
Postgres Docker imageVM container for Postgres13.2-alpine
onap/integration-java11Java Base image8.0.0
JettyApplication server9.4.41
SwaggerOpenAPI library2.1.4
SpringFoxOpenAPI library3.0.0
Hibernate typesSupport for Postgres datatype JSONB2.10.0
Spring BootApplication Framework2.5.5
cglib-nodep3pp3.1
commons-lang33pp3.12.0
antlr4-runtimeLanguage parser4.9.2
liquibaseDB Schema (version) management4.4.2
modelmapperModel mapper library2.3.8


...