/
CPS R10 Release Planning

CPS R10 Release Planning

Owned by Toine Siebelink
Last updated: Mar 23, 2022

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?

Further integrate CPS into ONAP architecture through additional components and interfaces such as

  • Extending xNF data write forwarding (delete, update, patch)
  • Extend Sync to include data sync and maintaining sync state
  • AAI integration
  • Read access to cached data (datastore ncmp-datastores:operational)
  • Support Delete event in CPS Temporal

Minimum Viable Product

N/A

Requirements

Priority legend
Committent Legend
PreliminaryFixedIn ProgressPausedCompletedDe-scoped
Delivered
(on master)		CommittedStudy/Investigation
No delivery		Partial Delivery

De-scoped

ONAP Best Practices (Global Requirements)

ONAP RequirementNotesCPS- Jira(s)

REQ-1072 - Standardized logging fields To Do

Only effects new code but we are adding logging during Jakarta time-frame so have to try to follow the recommended standard

Concerns about availability of all required fields 
Can fields be populated using Springboot automatically?

Robert Heinemann will organize meeting with us

CPS-869 - Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072 Closed

REQ-1073 - Using basic image from Integration To Do

Toine Siebelink  checked and all 3 CPS repos are using /onap/integration-java11:8.0.0 as their base image. So no impact for this Req.

N/A


CPS-CORE / CPS-NCMP Requirements

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

REQ-1071 - CPS Enhancements for Rel J In Progress

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

CPS-485 - Get module names and revision for a given cm handle and dataspace Closed

2

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-NCMPSupport 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

CPS-615 - Demo & CSIT Test for Model-Sync Closed

CPS-646 - Demo & CSIT Test for create (and read) with datastore passthrough-running Closed

3

REQ-1071 - CPS Enhancements for Rel J In Progress

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

CPS-645 - Separate NCMP southbound (DMI) interface from northbound facing 'client' interface Closed

4

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-NCMPRetrieve cm-handles that have a given list modules
Committed

CPS-644 - Get all cm handles that support all modules in a given list of modules Closed

5

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-NCMPAllow separate registration of DMIDataPlugin and DmiModelPlugin
Committed

CPS-736 - Allow separate registration of DMIDataPlugin and DmiModelPugin Closed

6

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-NCMPSupport 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

CPS-636 - Support Replace operation for ds Passtrough-Running in NCMP Closed CPS-637 - Support Update (Replace) operation for DS Passtrough-Running in DMI Plugin Closed CPS-638 - Support Delete operation for ds Passtrough-Running in NCMP Closed CPS-639 - Support Delete operation for ds Passtrough-Running in DMI Plugin Closed CPS-640 - Support Patch operation for ds Passtrough-Running in NCMP Closed CPS-641 - Support Patch operation for ds Passtrough-Running in DMI Plugin Closed

CPS-782 - Spike: Inventory of HTTP Response Codes for all CPS interfaces Closed CPS-777 - Ensure all DMI operations use POST method Closed

CPS-822 - Align CPS Core REST API Specification and Implementation Closed CPS-823 - Align CPS NCMP REST API Specification and Implementation Closed CPS-824 - Align DMI Plugin REST API Specification and Implementation Closed CPS-825 - Align CPS Temporal REST API Specification and Implementation Closed

7

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-NCMPDefine states and state handling for CM handle, e.g. state of model and data sync
Committed (definition only)

CPS-799 - Spike: Define states and state handling for CM handle Closed

8


CPS-NCMPNCMP 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

CPS-858 - Spike: Define NCMP notifications on CM handle Add (Ready) & Delete Closed

CPS-872 - CM Handle State: define and agree new dmi-registry yang model supporting States Closed  

CPS-874 - CM Handle State: Update Registry Schema using Liquibase Closed CPS-875 - CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles Closed CPS-876 - CM Handle State: Remove model-sync from registration process Closed CPS-877 - CM Handle State: Exclude any CM-Handles from queries/operations that are not in state 'READY' Closed CPS-878 - CM Handle State: Retry CM-Handles that are LOCKED, Failed-to-Sync Closed CPS-909 - Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state Closed
9

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-NCMPSupport public CM handle propertiesBasic support for public properties + query capability

Partial Delivery

(query part might not make Jakarta)

CPS-677 - Support 'public' Cm Handle Properties Closed CPS-817 - Create Endpoint For Get Cm Handles (incl. public properties) By Name Closed CPS-837 - Remove and Add Properties as part of CM-Handle registration update Closed CPS-731 - Query based on Public CM Properties Closed

10

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-Core /
CPS-NCMP		Investigate Horizontal Scaling
Study & Test only

CPS-786 - Spike: scale CPS-NCMP horizontal using several instances of the service Closed

11


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. 

Partial Delivery

CPS-821 - Spike: Support Async read-write operations on CPS-NCMP interface Closed CPS-828 - Async: NCMP Rest impl. including Request ID generation Closed CPS-829 - Async: Internal message topic incl. basic producer & Consumer Closed CPS-830 - DMI-NCMP Asynchronously Publish Response Event to Client Topic Closed CPS-832 - Async: E2E Integration (incl. Demo & CSIT) Closed

12

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-NCMPRead access at datastore level

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


CPS-745 - Examine current root support NCMP/DMI/SDN-C Closed

CPS-802 - Upgrade SDN-C and verify root acess Closed

CPS-792 - Use alternate SDN-C rest interface when accessing root object Closed

13

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-CoreYANG language extension supportInvestigationCommitted (investigation only)

CPS-735 - Spike: Support for Yang Language Extension Closed CPS-866 - SPIKE: Investigate YANG language extension interpretation Closed

14

REQ-1085 - E2E Network Slicing use case enhancements for Jakarta release Done

CPS-CoreE2E Slicing Impacts JakartaJ-delivery  wil just include CPS-Core output alignment. But CPS Team will continue to work on cache-related items during Jakarta to be ready for inclusion of that functionality in K to such an extend that in can be used by E2E Sling

CPS-865 - Align JSON DataNode for Get and Post/Put endpoints in CPS Core Closed CPS-819 - CPS impacts for Network slicing in Jakarta Release Closed

Temporal DB Requirements

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

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-TEMPORALAdd support for data deletion events in CPS Temporal
Committed

CPS-470 - Spike - Add support for data deletion events Closed

CPS-789 - Event Schema V2 to support delete operation Closed

CPS-790 - CPS-Temporal: Process DELETE event notification Closed

CPS-826 - Set operation field in CPS Temporal DB not null Closed

CPS-791 - CPS-Core sends DELETE notification event Closed

CPS-844 - Support operation field for CPS Temporal Query Output API Closed

CPS-847 - Update CPS Temporal CSIT tests to cover events having different operation types Closed

Functionalities


Stories

 Closed Stories

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
CPS-491 Spike to Support list top-level data node Story 02/Jul/21 6:23 AM 10/May/23 2:30 AM Former user Toine Siebelink Medium Closed Done
CPS-799 Spike: Define states and state handling for CM handle Story 07/Dec/21 7:36 AM 16/Jan/23 11:49 PM Former user Toine Siebelink Medium Closed Done
CPS-837 Remove and Add Properties as part of CM-Handle registration update Story 21/Dec/21 8:40 AM 21/Sep/22 7:34 AM Priyank Maheshwari Former user Medium Closed Done
CPS-817 Create Endpoint For Get Cm Handles (incl. public properties) By Name Story 13/Dec/21 5:16 AM 21/Sep/22 7:34 AM Former user Former user High Closed Done
CPS-872 CM Handle State: define and agree new dmi-registry yang model supporting States Story 01/Feb/22 7:49 AM 21/Sep/22 7:34 AM Former user Toine Siebelink Medium Closed Done
CPS-874 CM Handle State: Update Registry Schema using Liquibase Story 02/Feb/22 8:08 AM 21/Sep/22 7:34 AM Former user Toine Siebelink Medium Closed Done
CPS-677 Support 'public' Cm Handle Properties Story 22/Sep/21 1:28 AM 21/Sep/22 7:34 AM Former user Toine Siebelink High Closed Done
CPS-850 SPIKE: Investigate Webflux for CPS-Core DB I/O sync/access Story 10/Jan/22 4:46 AM 11/Jul/22 8:12 AM Unassigned Former user Medium Closed Won't Do
CPS-736 Allow separate registration of DMIDataPlugin and DmiModelPugin Story 14/Oct/21 4:21 AM 28/Mar/22 9:16 AM Former user Toine Siebelink Highest Closed Done
CPS-823 Align CPS NCMP REST API Specification and Implementation Story 15/Dec/21 5:23 AM 25/Mar/22 4:14 AM Former user Former user High Closed Done
CPS-789 Event Schema V2 to support delete operation Story 30/Nov/21 6:32 AM 25/Mar/22 4:14 AM Former user Former user Medium Closed Done
CPS-644 Get all cm handles that support all modules in a given list of modules Story 07/Sep/21 1:58 AM 25/Mar/22 4:14 AM Former user Former user High Closed Done
CPS-865 Align JSON DataNode for Get and Post/Put endpoints in CPS Core Story 25/Jan/22 9:15 AM 25/Mar/22 4:14 AM Former user Toine Siebelink High Closed Done
CPS-824 Align DMI Plugin REST API Specification and Implementation Story 15/Dec/21 5:24 AM 25/Mar/22 4:14 AM Former user Former user High Closed Done
CPS-645 Separate NCMP southbound (DMI) interface from northbound facing 'client' interface Story 07/Sep/21 7:44 AM 25/Mar/22 4:14 AM Unassigned Toine Siebelink High Closed Done
CPS-825 Align CPS Temporal REST API Specification and Implementation Story 15/Dec/21 5:24 AM 25/Mar/22 4:14 AM Former user Former user High Closed Done
CPS-826 Set operation field in CPS Temporal DB not null Story 15/Dec/21 6:23 AM 25/Mar/22 4:14 AM Former user Former user Medium Closed Done
CPS-791 CPS-Core sends DELETE notification event Story 30/Nov/21 6:50 AM 25/Mar/22 4:14 AM Former user Former user Medium Closed Done
CPS-790 CPS-Temporal: Process DELETE event notification Story 30/Nov/21 6:43 AM 25/Mar/22 4:14 AM Former user Former user Medium Closed Done
CPS-640 Support Patch operation for ds Passtrough-Running in NCMP Story 03/Sep/21 6:46 AM 25/Mar/22 4:14 AM Former user Toine Siebelink Highest Closed Done
Showing 20 out of 57 issues Refresh

 Improvements & Technical Debt (any release)

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
No issues found Refresh


 Stories in progress or on backlog

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
No issues found Refresh

Longer term roadmap

  • CPS-Core will have extended query capabilities based on XPath expression.
  • CPS-Core will enforce and control ownership of data it holds
  • NCMP will be able to sync CM Models and Data on any xNF in the network
  • MCMP wil support the query capabilities as CPS-Core and be extend with options similar to RESTConf's 'fields' and 'depth'
  • CPS Temporal aims to complement CPS Core by providing an historical view on CPS data.

Release Deliverables

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

Architecture

High level architecture diagram

CPS is a new shared service in the ONAP Architecture:



Platform Maturity

See the centralized wiki page: Jakarta Release Platform Maturity


  • API Incoming Dependencies

No Incoming API changes required

  • API Outgoing Dependencies

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



  • Gaps

No gaps Identified

  • Known Defects and Issues

See dynamic Jira filter:

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
No issues found Refresh

  • Risks

No Risks identified, see also Jakarta Risk Table 

  • Resources

Configuration Persistence Service Developer's Landing Page

Name

Code Contributor

Committer

Organization

Time Zones

CPS Daily Scrums*

Winter

Summer (DST)

Focus Team 1

Focus Team 2

DT Sub Team

Toine Siebelink (PTL)

Yes

Yes

Ericsson

GMT/UTC

IST/UTC+1

X (SM)

kieran mccarthy(stakeholder)

No

No

Ericsson

CET/UTC+1

CEST/UTC+2

Peter Turcsanyi (stakeholder)

No

No

Ericsson

CET/UTC+1

CEST/UTC+2

Csaba Kocsis (stakeholder)

No

No

Ericsson

CET/UTC+1

CEST/UTC+2

Tony Finnerty (architect)

No

No

Ericsson

GMT/UTC

IST/UTC+1

Kolawole Adebisi-Adeolokun(PO)

No

No

Ericsson

GMT/UTC

IST/UTC+1

Arpit Singh 

Yes

No

Tech Mahindra

IST/UTC+5:30

IST/UTC+5:30

X

Daniel Hanrahan

Yes

Yes

Ericsson

GMT/UTC

IST/UTC+1

X

Gerard Nugent 

Yes

No

Ericsson

GMT/UTC

IST/UTC+1

X

Halil Cakal 

Yes

No

Ericsson

GMT/UTC

IST/UTC+1

X

Lee Anjella Macabuhay

Yes

Yes

Ericsson

GMT/UTC

IST/UTC+1

X (SM)

Levente Csanyi 

Yes

No

Ericsson

CET/UTC+1

CEST/UTC+2

X

Priyank Maheshwari 

Yes

Yes

Ericsson

GMT/UTC

IST/UTC+1

X

X (SM)

Rajesh Kumar 

Yes

No

Tech Mahindra

IST/UTC+5:30

IST/UTC+5:30

X

Rudrangi Anupriya 

Yes

No

Tech Mahindra

IST/UTC+5:30

IST/UTC+5:30

X

Seán Beirne 

Yes

No

Ericsson

GMT/UTC

IST/UTC+1

X

Sourabh Sourabh 

Yes

Yes

Ericsson

GMT/UTC

IST/UTC+1

X

*The scrum attendance for each member is the current 'typical' attendance. Each team member can potentially attend any Scrum as needed

  • Release Milestone

The milestones are defined at the Release Planning and all the supporting project agreed to comply with these dates.

  • Team Internal Milestone

This section is optional and may be used to document internal milestones within a project team or multiple project teams. For instance, in the case the team has made agreement with other team to deliver some artifacts on a certain date that are not in the release milestone, it is recommended to provide these agreements and dates in this section.

  • Documentation, Training

See the following centralized wiki: Jakarta Documentation

Other Information

  • Vendor Neutral

If this project is coming from an existing proprietary codebase, ensure that all proprietary trademarks, logos, product names, etc. have been removed. All ONAP deliverables must comply with this rule and be agnostic of any proprietary symbols.

  • Free and Open Source Software

FOSS activities are critical to the delivery of the whole ONAP initiative. The information may not be fully available at Release Planning, however to avoid late refactoring, it is critical to accomplish this task as early as possible.
List all third party Free and Open Source Software used within the release and provide License type (BSD, MIT, Apache, GNU GPL,... ).
In the case non Apache License are found inform immediately the TSC and the Release Manager and document your reasoning on why you believe we can use a non Apache version 2 license.

Each project must edit its project table available at Project FOSS.


Charter Compliance

The project team comply with the ONAP Charter.

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?

Further integrate CPS into ONAP architecture through additional components and interfaces such as

  • Extending xNF data write forwarding (delete, update, patch)
  • Extend Sync to include data sync and maintaining sync state
  • AAI integration
  • Read access to cached data (datastore ncmp-datastores:operational)
  • Support Delete event in CPS Temporal

Minimum Viable Product

N/A

Requirements

Priority legend
Committent Legend
PreliminaryFixedIn ProgressPausedCompletedDe-scoped
Delivered
(on master)		CommittedStudy/Investigation
No delivery		Partial Delivery

De-scoped

ONAP Best Practices (Global Requirements)

ONAP RequirementNotesCPS- Jira(s)

REQ-1072 - Standardized logging fields To Do

Only effects new code but we are adding logging during Jakarta time-frame so have to try to follow the recommended standard

Concerns about availability of all required fields 
Can fields be populated using Springboot automatically?

Robert Heinemann will organize meeting with us

CPS-869 - Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072 Closed

REQ-1073 - Using basic image from Integration To Do

Toine Siebelink  checked and all 3 CPS repos are using /onap/integration-java11:8.0.0 as their base image. So no impact for this Req.

N/A


CPS-CORE / CPS-NCMP Requirements

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

REQ-1071 - CPS Enhancements for Rel J In Progress

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

CPS-485 - Get module names and revision for a given cm handle and dataspace Closed

2

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-NCMPSupport 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

CPS-615 - Demo & CSIT Test for Model-Sync Closed

CPS-646 - Demo & CSIT Test for create (and read) with datastore passthrough-running Closed

3

REQ-1071 - CPS Enhancements for Rel J In Progress

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

CPS-645 - Separate NCMP southbound (DMI) interface from northbound facing 'client' interface Closed

4

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-NCMPRetrieve cm-handles that have a given list modules
Committed

CPS-644 - Get all cm handles that support all modules in a given list of modules Closed

5

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-NCMPAllow separate registration of DMIDataPlugin and DmiModelPlugin
Committed

CPS-736 - Allow separate registration of DMIDataPlugin and DmiModelPugin Closed

6

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-NCMPSupport 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

CPS-636 - Support Replace operation for ds Passtrough-Running in NCMP Closed CPS-637 - Support Update (Replace) operation for DS Passtrough-Running in DMI Plugin Closed CPS-638 - Support Delete operation for ds Passtrough-Running in NCMP Closed CPS-639 - Support Delete operation for ds Passtrough-Running in DMI Plugin Closed CPS-640 - Support Patch operation for ds Passtrough-Running in NCMP Closed CPS-641 - Support Patch operation for ds Passtrough-Running in DMI Plugin Closed

CPS-782 - Spike: Inventory of HTTP Response Codes for all CPS interfaces Closed CPS-777 - Ensure all DMI operations use POST method Closed

CPS-822 - Align CPS Core REST API Specification and Implementation Closed CPS-823 - Align CPS NCMP REST API Specification and Implementation Closed CPS-824 - Align DMI Plugin REST API Specification and Implementation Closed CPS-825 - Align CPS Temporal REST API Specification and Implementation Closed

7

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-NCMPDefine states and state handling for CM handle, e.g. state of model and data sync
Committed (definition only)

CPS-799 - Spike: Define states and state handling for CM handle Closed

8


CPS-NCMPNCMP 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

CPS-858 - Spike: Define NCMP notifications on CM handle Add (Ready) & Delete Closed

CPS-872 - CM Handle State: define and agree new dmi-registry yang model supporting States Closed  

CPS-874 - CM Handle State: Update Registry Schema using Liquibase Closed CPS-875 - CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles Closed CPS-876 - CM Handle State: Remove model-sync from registration process Closed CPS-877 - CM Handle State: Exclude any CM-Handles from queries/operations that are not in state 'READY' Closed CPS-878 - CM Handle State: Retry CM-Handles that are LOCKED, Failed-to-Sync Closed CPS-909 - Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state Closed
9
Partial

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-NCMPSupport public CM handle propertiesBasic support for public properties + query capability

Partial Delivery

(query part might not make Jakarta)

CPS-677 - Support 'public' Cm Handle Properties Closed CPS-817 - Create Endpoint For Get Cm Handles (incl. public properties) By Name Closed CPS-837 - Remove and Add Properties as part of CM-Handle registration update Closed CPS-731 - Query based on Public CM Properties Closed

10

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-Core /
CPS-NCMP		Investigate Horizontal Scaling
Study & Test only

CPS-786 - Spike: scale CPS-NCMP horizontal using several instances of the service Closed

11


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. 

Partial Delivery

CPS-821 - Spike: Support Async read-write operations on CPS-NCMP interface Closed CPS-828 - Async: NCMP Rest impl. including Request ID generation Closed CPS-829 - Async: Internal message topic incl. basic producer & Consumer Closed CPS-830 - DMI-NCMP Asynchronously Publish Response Event to Client Topic Closed CPS-832 - Async: E2E Integration (incl. Demo & CSIT) Closed

12

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-NCMPRead access at datastore level

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


CPS-745 - Examine current root support NCMP/DMI/SDN-C Closed

CPS-802 - Upgrade SDN-C and verify root acess Closed

CPS-792 - Use alternate SDN-C rest interface when accessing root object Closed

13

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-CoreYANG language extension supportInvestigationCommitted (investigation only)

CPS-735 - Spike: Support for Yang Language Extension Closed CPS-866 - SPIKE: Investigate YANG language extension interpretation Closed

14

REQ-1085 - E2E Network Slicing use case enhancements for Jakarta release Done

CPS-CoreE2E Slicing Impacts JakartaJ-delivery  wil just include CPS-Core output alignment. But CPS Team will continue to work on cache-related items during Jakarta to be ready for inclusion of that functionality in K to such an extend that in can be used by E2E Sling

CPS-865 - Align JSON DataNode for Get and Post/Put endpoints in CPS Core Closed CPS-819 - CPS impacts for Network slicing in Jakarta Release Closed

15

 Move to Kohn

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.

CPS-870 - Align CPS-Core output with SDN-C output (add module name) Closed

16

 Move to Kohn

CPS-NCMPSupport update of cached data through a message driven solution
E.g. TBDMT/SND-R will write to device and can send message on NCMP provide message topic to keep cache up to date		Need to investigate if DMaap or new Kafka/Strimzi message bus should be used

17

Move to Kohn

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.

CPS-507 - (Trigger) Initial Data-Sync Closed

18

Move to Kohn

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


19

Move to Kohn

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

20

Move to Kohn

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


21

Move to Kohn

CPS-Core /
CPS-NCMP		Support for HTTPS and authentication


22

Move to Kohn

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


23
TBCDell, support of XML PayloadDell has decided not to pursue this for now

24

TBC

CPS-NCMPSupport 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.

25TBCCPS-Core /
CPS-NCMP		Support ncmp-datastores:running for writing data (single CM handle, synchronous only)


26TBCCPS-CoreSend notifications hon write operation in ncmp-datastores:running for (single CM handle, synchronous only)


27
CPS-Core /
CPS-NCMP		Support for list as top level data node

CPS-491 - Spike to Support list top-level data node Closed

CPS-765 - Post List Element to allow top level list element Closed CPS-766 - Get Nodes Endpoint (support multipel to-level nodes) Closed CPS-767 - Spike Investigate update of list elements queried independently from parent node Closed

28
CPS-Core /
CPS-NCMP		Support for multiple roots from different modules in one CM handle/anchor



CPS-341 - Spike: Support multiple data tree instances under 1 anchor Closed

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


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

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

32(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 ( DMAAP-1681 - [STRIMZI-KAFKA] PoC to move cps to use Strimzi KafkaUser and Topic Closed )

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


CPS-392 - Spike: A&AI Inventory List Closed CPS-393 - Spike: DMaaP Event subscription and Filtering of A&AI Closed

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

34
CPS-NCMPFine-grained cache configuration


35
CPS-Core /
CPS-NCMP		Existing CPS-path based queries across multiple CM handles for cached data


36
CPS-NCMPInvoke YANG modelled action


37
CPS-NCMPInvoke YANG modelled RPC


Temporal DB Requirements

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

REQ-1071 - CPS Enhancements for Rel J In Progress

CPS-TEMPORALAdd support for data deletion events in CPS Temporal
Committed

CPS-470 - Spike - Add support for data deletion events Closed

CPS-789 - Event Schema V2 to support delete operation Closed

CPS-790 - CPS-Temporal: Process DELETE event notification Closed

CPS-826 - Set operation field in CPS Temporal DB not null Closed

CPS-791 - CPS-Core sends DELETE notification event Closed

CPS-844 - Support operation field for CPS Temporal Query Output API Closed

CPS-847 - Update CPS Temporal CSIT tests to cover events having different operation types Closed

Functionalities


Stories

 Closed Stories

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
CPS-491 Spike to Support list top-level data node Story 02/Jul/21 6:23 AM 10/May/23 2:30 AM Former user Toine Siebelink Medium Closed Done
CPS-799 Spike: Define states and state handling for CM handle Story 07/Dec/21 7:36 AM 16/Jan/23 11:49 PM Former user Toine Siebelink Medium Closed Done
CPS-837 Remove and Add Properties as part of CM-Handle registration update Story 21/Dec/21 8:40 AM 21/Sep/22 7:34 AM Priyank Maheshwari Former user Medium Closed Done
CPS-817 Create Endpoint For Get Cm Handles (incl. public properties) By Name Story 13/Dec/21 5:16 AM 21/Sep/22 7:34 AM Former user Former user High Closed Done
CPS-872 CM Handle State: define and agree new dmi-registry yang model supporting States Story 01/Feb/22 7:49 AM 21/Sep/22 7:34 AM Former user Toine Siebelink Medium Closed Done
CPS-874 CM Handle State: Update Registry Schema using Liquibase Story 02/Feb/22 8:08 AM 21/Sep/22 7:34 AM Former user Toine Siebelink Medium Closed Done
CPS-677 Support 'public' Cm Handle Properties Story 22/Sep/21 1:28 AM 21/Sep/22 7:34 AM Former user Toine Siebelink High Closed Done
CPS-850 SPIKE: Investigate Webflux for CPS-Core DB I/O sync/access Story 10/Jan/22 4:46 AM 11/Jul/22 8:12 AM Unassigned Former user Medium Closed Won't Do
CPS-736 Allow separate registration of DMIDataPlugin and DmiModelPugin Story 14/Oct/21 4:21 AM 28/Mar/22 9:16 AM Former user Toine Siebelink Highest Closed Done
CPS-823 Align CPS NCMP REST API Specification and Implementation Story 15/Dec/21 5:23 AM 25/Mar/22 4:14 AM Former user Former user High Closed Done
CPS-789 Event Schema V2 to support delete operation Story 30/Nov/21 6:32 AM 25/Mar/22 4:14 AM Former user Former user Medium Closed Done
CPS-644 Get all cm handles that support all modules in a given list of modules Story 07/Sep/21 1:58 AM 25/Mar/22 4:14 AM Former user Former user High Closed Done
CPS-865 Align JSON DataNode for Get and Post/Put endpoints in CPS Core Story 25/Jan/22 9:15 AM 25/Mar/22 4:14 AM Former user Toine Siebelink High Closed Done
CPS-824 Align DMI Plugin REST API Specification and Implementation Story 15/Dec/21 5:24 AM 25/Mar/22 4:14 AM Former user Former user High Closed Done
CPS-645 Separate NCMP southbound (DMI) interface from northbound facing 'client' interface Story 07/Sep/21 7:44 AM 25/Mar/22 4:14 AM Unassigned Toine Siebelink High Closed Done
CPS-825 Align CPS Temporal REST API Specification and Implementation Story 15/Dec/21 5:24 AM 25/Mar/22 4:14 AM Former user Former user High Closed Done
CPS-826 Set operation field in CPS Temporal DB not null Story 15/Dec/21 6:23 AM 25/Mar/22 4:14 AM Former user Former user Medium Closed Done
CPS-791 CPS-Core sends DELETE notification event Story 30/Nov/21 6:50 AM 25/Mar/22 4:14 AM Former user Former user Medium Closed Done
CPS-790 CPS-Temporal: Process DELETE event notification Story 30/Nov/21 6:43 AM 25/Mar/22 4:14 AM Former user Former user Medium Closed Done
CPS-640 Support Patch operation for ds Passtrough-Running in NCMP Story 03/Sep/21 6:46 AM 25/Mar/22 4:14 AM Former user Toine Siebelink Highest Closed Done
Showing 20 out of 57 issues Refresh

 Improvements & Technical Debt (any release)

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
No issues found Refresh


 Stories in progress or on backlog

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
No issues found Refresh

Longer term roadmap

  • CPS-Core will have extended query capabilities based on XPath expression.
  • CPS-Core will enforce and control ownership of data it holds
  • NCMP will be able to sync CM Models and Data on any xNF in the network
  • MCMP wil support the query capabilities as CPS-Core and be extend with options similar to RESTConf's 'fields' and 'depth'
  • CPS Temporal aims to complement CPS Core by providing an historical view on CPS data.

Release Deliverables

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

Architecture

High level architecture diagram

CPS is a new shared service in the ONAP Architecture:



Platform Maturity

See the centralized wiki page: Istanbul Release Platform Maturity


  • API Incoming Dependencies

No Incoming API changes required

  • API Outgoing Dependencies

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



  • Gaps

No gaps Identified

  • Known Defects and Issues

See dynamic Jira filter:

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
No issues found Refresh

  • Risks

No Risks identified, see also Jakarta Risk Table 

  • Resources

Configuration Persistence Service Developer's Landing Page

Name

Code Contributor

Committer

Organization

Time Zones

CPS Daily Scrums*

Winter

Summer (DST)

Focus Team 1

Focus Team 2

DT Sub Team

Toine Siebelink (PTL)

Yes

Yes

Ericsson

GMT/UTC

IST/UTC+1

X (SM)

kieran mccarthy(stakeholder)

No

No

Ericsson

CET/UTC+1

CEST/UTC+2

Peter Turcsanyi (stakeholder)

No

No

Ericsson

CET/UTC+1

CEST/UTC+2

Csaba Kocsis (stakeholder)

No

No

Ericsson

CET/UTC+1

CEST/UTC+2

Tony Finnerty (architect)

No

No

Ericsson

GMT/UTC

IST/UTC+1

Kolawole Adebisi-Adeolokun(PO)

No

No

Ericsson

GMT/UTC

IST/UTC+1

Arpit Singh 

Yes

No

Tech Mahindra

IST/UTC+5:30

IST/UTC+5:30

X

Daniel Hanrahan

Yes

Yes

Ericsson

GMT/UTC

IST/UTC+1

X

Gerard Nugent 

Yes

No

Ericsson

GMT/UTC

IST/UTC+1

X

Halil Cakal 

Yes

No

Ericsson

GMT/UTC

IST/UTC+1

X

Lee Anjella Macabuhay

Yes

Yes

Ericsson

GMT/UTC

IST/UTC+1

X (SM)

Levente Csanyi 

Yes

No

Ericsson

CET/UTC+1

CEST/UTC+2

X

Priyank Maheshwari 

Yes

Yes

Ericsson

GMT/UTC

IST/UTC+1

X

X (SM)

Rajesh Kumar 

Yes

No

Tech Mahindra

IST/UTC+5:30

IST/UTC+5:30

X

Rudrangi Anupriya 

Yes

No

Tech Mahindra

IST/UTC+5:30

IST/UTC+5:30

X

Seán Beirne 

Yes

No

Ericsson

GMT/UTC

IST/UTC+1

X

Sourabh Sourabh 

Yes

Yes

Ericsson

GMT/UTC

IST/UTC+1

X

*The scrum attendance for each member is the current 'typical' attendance. Each team member can potentially attend any Scrum as needed

  • Release Milestone

The milestones are defined at the Release Planning and all the supporting project agreed to comply with these dates.

  • Team Internal Milestone

This section is optional and may be used to document internal milestones within a project team or multiple project teams. For instance, in the case the team has made agreement with other team to deliver some artifacts on a certain date that are not in the release milestone, it is recommended to provide these agreements and dates in this section.

  • Documentation, Training

See the following centralized wiki: Jakarta Documentation

Other Information

  • Vendor Neutral

If this project is coming from an existing proprietary codebase, ensure that all proprietary trademarks, logos, product names, etc. have been removed. All ONAP deliverables must comply with this rule and be agnostic of any proprietary symbols.

  • Free and Open Source Software

FOSS activities are critical to the delivery of the whole ONAP initiative. The information may not be fully available at Release Planning, however to avoid late refactoring, it is critical to accomplish this task as early as possible.
List all third party Free and Open Source Software used within the release and provide License type (BSD, MIT, Apache, GNU GPL,... ).
In the case non Apache License are found inform immediately the TSC and the Release Manager and document your reasoning on why you believe we can use a non Apache version 2 license.

Each project must edit its project table available at Project FOSS.


Charter Compliance

The project team comply with the ONAP Charter.