Overview
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Jakarta |
| Project Lifecycle State | Incubation |
| 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)
Minimum Viable Product
N/A
Requirements
CPS-Core Requirements
NCMP Requirements
Priority legend:
| Preliminary | Fixed | In Progress | Completed | De-scoped |
| Priority | Jakarta Requirement Jira | Description | Notes | Jakarta commitment | Jira(s) | |
|---|---|---|---|---|---|---|
| 1 | Retrieve list of modules (names) for a CM handle | Used by applications to get cached information from NCMP about models | Delivered in Istanbul | CPS-485 - Getting issue details... STATUS | ||
| 2 | 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,PathsandFormatCombinationsforReadOperations | Delivered in Istanbul, just pending Demos | |||
| 3 | Separate NCMP-DMI interface from northbound facing 'client' interface |
| Committed | CPS-645 - Getting issue details... STATUS | ||
| 4 | Retrieve cm-handles that have a given list modules | Committed | CPS-644 - Getting issue details... STATUS | |||
| 5 | Allow separate registration of DMIDataPlugin and DmiModelPlugin | Committed | CPS-736 - Getting issue details... STATUS | |||
| 6 | Support 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 | CPS-636 - Getting issue details... STATUS CPS-637 - Getting issue details... STATUS CPS-638 - Getting issue details... STATUS CPS-639 - Getting issue details... STATUS CPS-640 - Getting issue details... STATUS CPS-641 - Getting issue details... STATUS CPS-782 - Getting issue details... STATUS CPS-777 - Getting issue details... STATUS CPS-822 - Getting issue details... STATUS CPS-823 - Getting issue details... STATUS CPS-824 - Getting issue details... STATUS CPS-825 - Getting issue details... STATUS | ||
| 7 | Define states and state handling for CM handle, e g state of model and data sync | CPS-799 - Getting issue details... STATUS | ||||
| 8 | NCMP 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 | Support public CM handle properties | Basic support for public properties + query capability | ||||
| 10 | Investigate Horizontal Scaling | CPS-786 - Getting issue details... STATUS | ||||
| 11 | Implement -async option for CRUD and Patch operations (for one CM-Handle) | Required for potentially long running requests Note below to be agreed.,,
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. | ||||
| 12 | Read access at datastore level | This allows applications to query top-level data nodes without explicitly addressing them. | ||||
| 13 | YANG language extension support | Investigation | CPS-735 - Getting issue details... STATUS | |||
| 14 | Send notification for updated CM handle metadata (public CM handle properties or YANG modules) | |||||
| 15 | [investigation/spec] CM data notifications from NCMP to applications including subscriptions | Includes definition of notification and payload format | ||||
| 16 | Implementation of CM data notifications forwarded by NCMP from DMI to application | |||||
| 17 | Support for HTTPS and authentication | |||||
| 18 | Access control for public interfaces (NCMP, CPS-Core, DMI?) | |||||
| 19 | Support 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 | Support 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. | ||||
| 21 | Support for list as top level data node | |||||
| 22 | Support for multiple roots from different modules in one CM handle/anchor | CPS-341 - Getting issue details... STATUS | ||||
| 23 | Explicit (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 - Getting issue details... STATUS | |||
| 24 | Support retrieval of YANG module sources for CM handle on the NCMP interface | |||||
| 25 | Update YANG schema-set for CM handle without removing and adding it | Cached data is not in scope. Need to specify orphan handling of YANG modules. | ||||
| 26 | schema-set update for CM handle with cached data present | Need 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. Possible in a generic way or it can also listen to similar events sent by SDN-R (as suggested by Ahila P) | |||
| 28 | Automatic (optional) Data Sync | Metadata (per cmHandle) controls whether this will happen or not | ||||
| 29 | Fine-grained cache configuration | |||||
| 30 | Existing CPS-path based queries across multiple CM handles for cached data | |||||
| 31 | Invoke YANG modelled action | |||||
| 32 | Invoke YANG modelled RPC |
Temporal DB Requirements
- Non planned currently
Functionalities
Stories
Improvements & Technical Debt (all components)
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 Name | Deliverable Description |
|---|---|
| Container running CPS and NCMP |
onap/cps-temporal | Container running CPS Temporal |
onap/ncmp-dmi-plugin | Container 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-plugin | ONAP DMI-Plugin Documentation for R10 (incl. offered APIs and release note) |
| docs.onap.org/projects/onap-cps-cps-temporal | CPS-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:
