Overview
| Project Name | Enter the name of the project |
|---|---|
| Target Release Name | Kohn |
| 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
- 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
| Priority legend | Committent Legend | ||||||||||
| Preliminary | Fixed | In Progress | Paused | Completed | De-scoped | Delivered (on master) | Committed | Study/Investigation No delivery | Partial Delivery | De-scoped | |
ONAP Best Practices (Global Requirements)
| ONAP Requirement | Notes | CPS- Jira(s) |
|---|---|---|
REQ-443 - Getting issue details... STATUS | Aiming for gold!
| CPS-1140 - Getting issue details... STATUS |
REQ-439 - Getting issue details... STATUS | CPS-1106 - Getting issue details... STATUS |
CPS-CORE / CPS-NCMP Requirements
| Priority | Kohn Requirement Jira | Component(s) | Description | Notes | Principle Point of Contact | Jira(s) | |
|---|---|---|---|---|---|---|---|
| 1 | REQ-1281 - Getting issue details... STATUS | CPS-NCMP | NCMP should publish notifications for any newly added (once the modules are synced) or deleted cm handles. Note. This depends on persists hand handling state transitions | Includes implementation of state handling (state persistence) as far as applicable as defined by #7 above | CPS-858 - Getting issue details... STATUS CPS-872 - Getting issue details... STATUS CPS-874 - Getting issue details... STATUS CPS-875 - Getting issue details... STATUS CPS-876 - Getting issue details... STATUS CPS-877 - Getting issue details... STATUS CPS-878 - Getting issue details... STATUS CPS-909 - Getting issue details... STATUSCPS-899 - Getting issue details... STATUS CPS-898 - Getting issue details... STATUS CPS-977 - Getting issue details... STATUS CPS-1015 - Getting issue details... STATUS CPS-1034 - Getting issue details... STATUS CPS-1045 - Getting issue details... STATUS CPS-1046 - Getting issue details... STATUS CPS-1076 - Getting issue details... STATUS CPS-1100 - Getting issue details... STATUS CPS-1102 - Getting issue details... STATUS CPS-1101 - Getting issue details... STATUS CPS-1099 - Getting issue details... STATUS CPS-1120 - Getting issue details... STATUS CPS-1104 - Getting issue details... STATUS CPS-1162 - Getting issue details... STATUS CPS-1163 - Getting issue details... STATUS CPS-1165 - Getting issue details... STATUS CPS-1167 - Getting issue details... STATUS | ||
| 2 | REQ-1281 - Getting issue details... STATUS | CPS-NCMP | Support public CM handle properties | Basic support for public properties + query capability | |||
| 3 | REQ-1281 - Getting issue details... STATUS | 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.,,
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. | Sourabh Sourabh | ||
| 4 |
REQ-1281
-
Getting issue details...
STATUS
Requirement | CPS-NCMP | Support ncmp-datastores:operational for reading data (single CM handle, synchronous only) | See CPS-391 page for details about supported operations and combinations. Note 1. There can be some overlap between work items for (CPS R10 Release Planning #5, #6, #11 and #12) Note 2. This item doesn't include accessing cached data as data sync is not available yet. If no cache data forward ncmp-datastores:passthrough-operational?! | CPS-870 - Getting issue details... STATUS CPS-996 - Getting issue details... STATUS CPS-999 - Getting issue details... STATUS CPS-1014 - Getting issue details... STATUS CPS-1000 - Getting issue details... STATUS CPS-1001 - Getting issue details... STATUS CPS-1002 - Getting issue details... STATUS CPS-1003 - Getting issue details... STATUS CPS-1119 - Getting issue details... STATUS CPS-1164 - Getting issue details... STATUS | ||
| 5 | REQ-1281 - Getting issue details... STATUS | CPS-NCMP | Support retrieval of YANG module sources for CM handle on the NCMP interface | Sourabh Sourabh | CPS-1064 - Getting issue details... STATUS | ||
| 6 | REQ-1281 - Getting issue details... STATUS | CPS-NCMP | DMI Audit | CPS-1136 - Getting issue details... STATUS | |||
| 7 | REQ-1281 - Getting issue details... STATUS | CPS-NCMP | [investigation/spec] CM data notifications from NCMP to applications including subscriptions | Includes definition of notification and payload format | kieran mccarthy | CPS-1065 - Getting issue details... STATUS | |
| 8 | REQ-1281 - Getting issue details... STATUS | CPS-NCMP | Implementation of CM data notifications forwarded by NCMP from DMI to application | ||||
| 9 | REQ-1281 - Getting issue details... STATUS | CPS-NCMP | Explicit (initial) data-sync for a CM handle (extend model-sync delivered in Istanbul) Note. Requires cache configuration specification and some minimal implementation | Triggered by client using REST endpoint on NCMP. Note: This item includes extended support for datastores to access the synced data. | |||
| 10 |
REQ-1281
-
Getting issue details...
STATUS
Requirement | CPS-NCMP | Support 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 | |||
| 11 | CPS-NCMP | Registration Performance | NCMP shall register new cmhandles (to READY state) at a rate of x cmhandles/second (assumes no dmi-plugin delays, assumes 180 modules per cmhandle with 95% module overlap between cmhandles, assumes cache disabled). Treat this as a black box requirement. May mean underlying requirement to have multiple instances, memory requirement etc. Focus right now is 23.Q1 timeframe. | CPS-1172 - Getting issue details... STATUS | |||
| 12 | CPS | Data Read Performance | CPS-1126 - Getting issue details... STATUS | ||||
| 13 | CPS-NCMP | Deletion Performance | NCMP shall delete/remove cmhandles (to DELETING state) at a rate of 50 cmhandles/second with cache disabled (assumes no dmi-plugin delays, assumes 180 modules per cmhandle with 95% module overlap between cmhandles) Note: check with Gergely on priority as DELETING state will prevent user to act on cmhandle | CPS-1173 - Getting issue details... STATUS | |||
| 14 | REQ-1281 - Getting issue details... STATUS | CPS-NCMP | 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. | |||
| 15 | CPS-NCMP | Enhanced query support | Currently the passthrough has an 'option' 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), scope=ericsson-enm-comtop:ManagedElement/ericsson-enm-gnbcucp:GNBCUCPFunction/ EndpointResource/LocalSctpEndpoint/attributes(interfaceUsed==X2)) | ||||
| 16 | CPS_Core / CPS-NCMP | 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. Needed for node upgrade scenario. | ||||
| 17 | CPS-1135 - Getting issue details... STATUS | CPS-NCMP | Retrieve single module resource | /v1/ch/{cm-handle}/modules/definitions/{moduleName} | |||
| 18 | CPS-Core / CPS-NCMP | Existing CPS-path based queries across all CM handles for cached data | Look to define the interface specification for this only. (but best way is to implement for operational/cached data to determine any output formatting issues) | ||||
| 19 | CPS-Core / CPS-NCMP | Access control for public interfaces (NCMP, CPS-Core, DMI?) | |||||
| 20 | CPS-NCMP | Fine-grained cache configuration | |||||
| 21 | CPS-NCMP | Send notification for updated CM handle metadata (public CM handle properties or YANG modules) | |||||
| 22 | CPS-Core / CPS-NCMP | Support for HTTPS and authentication
| CPS-703 - Getting issue details... STATUS | ||||
| 23 | TBC | CPS-NCMP | Support 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. | |||
| 24 | TBC | CPS-Core / CPS-NCMP | Support ncmp-datastores:running for writing data (single CM handle, synchronous only) | ||||
| 25 | TBC | CPS-Core | Send notifications on write operation in ncmp-datastores:running for (single CM handle, synchronous only) | ||||
| 26 | CPS-Core / CPS-NCMP | Support for list as top level data node | |||||
| 27 | CPS-Core / CPS-NCMP | Support for multiple top-elements from different modules in one CM handle/anchor | |||||
| 28 | CPS-Core / CPS-NCMP | schema-set update for CM handle with cached data present | Need to address case with incompatible model changes. | ||||
| 29 | (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) | ||||
| 30 | CPS-NCMP | Automatic (optional) Data Sync | Metadata (per cmHandle) controls whether this will happen or not | ||||
| 31 | CPS-NCMP | Invoke YANG modelled RPC |
Spin-off user stories, yet to be prioritized
| Jira | Component(s) | Related Work Item | Description | Notes |
|---|---|---|---|---|
CPS-1103 - Getting issue details... STATUS | CPS-NCMP | 4 | ||
CPS-1127 - Getting issue details... STATUS | CPS-NCMP | 4 | ||
CPS-1132 - Getting issue details... STATUS | CPS-NCMP | 1 | ||
CPS-1174 - Getting issue details... STATUS | CPS-NCMP | 8 | ||
CPS-1183 - Getting issue details... STATUS | CPS-NCMP | Investigation on the use of Liquibase to install NCMP artifacts |
Functionalities
User Stories
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 to able to 'detect' and sync xNF in the network
- Fine-cache cache control will determine what get cache for what xNF
- NCMP will support the query capabilities as CPS-Core and be extend with options similar to RESTConf's 'fields' and 'depth'
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:
Platform Maturity
See the centralized wiki page: Kohn Release Platform Maturity
API Incoming Dependencies
No Incoming API changes required
API Outgoing Dependencies
API this project is delivering to other projects.
| API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
CPS-E-01 | CPS Model LifeCycle CPS Data Write CPS Data Read | Swagger Sources (openapi.yaml) | ||
| CPS-E-04 | Change notifications | |||
| CPS-E-05 | xNF Data Access | Swagger Sources (openapi.yaml) | ||
| CPS-E-06 | Temporal 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.
| Name | Description | CPS-Core | CPS-NCMP | CPS-Temporal |
|---|---|---|---|---|
| 3PP Version | ||||
| Docker | VM Container | 18 and above | 18 and above | 18 and above |
| ODL Yang Tools | Yang model and Data Parser | 6.0.1 | 6.0.1 | N/A |
| Postgres Docker image | VM container for Postgres | 13.2-alpine | 13.2-alpine | N/A |
| onap/integration-java11 | Java Base image | 8.0.0 | 8.0.0 | 8.0.0 |
| Swagger | OpenAPI library | 2.1.4 | 2.1.4 | springdoc-openapi-ui:1.5.9 |
| SpringFox | OpenAPI library | 3.0.0 | 3.0.0 | 3.0.0 |
| Hibernate types | Support for Postgres datatype JSONB | 2.10.0 | 2.10.0 | 2.10.0 |
| Spring Boot | Application Framework | 2.6.9 | 2.6.9 | 2.6.9 |
| Commons-lang3 | 3pp | 3.11 | 3.11 | 3.12.0 |
| Antlr4-runtime | Language parser | 4.9.2 | 4.9.2 | N/A |
| Liquibase | DB Schema (version) management | 4.4.2-nordix | 4.4.2-nordix | 4.4.2-nordix |
| Hazelcast | Distributed Cache | 4.2.5 | N/A | N/A |
Testing and Integration Plans
- CPS has high level of built jUnit test (>97 on all components) which is enforced by our maven build scripts
- CPS has built in Persistence Layer test ie. test that integrate with real DB instance covering all use cases and are part of WoW
- CIST tests are part of CPS -Repo, see https://gerrit.onap.org/r/gitweb?p=cps.git;a=tree;f=csit;h=8505b66089f62b6431c1091edf820cbdbf4363d4;hb=HEAD
And executed automatically through the cps-review-verification-maven-master CI Job - E2E Integration with ONAP components was introduced in I-release and is now included in aforementioned CIST tests
Gaps
No gaps Identified
Known Defects and Issues
See dynamic Jira filter:
Risks
Risk identified related to scope-creep, see Kohn Risk Table
Resources
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 |
|
|
|
No | No | Ericsson | GMT/UTC | IST/UTC+1 |
|
|
| |
Yes | No | Tech Mahindra | IST/UTC+5:30 | IST/UTC+5:30 |
|
| X | |
Yes | Yes | Ericsson | GMT/UTC | IST/UTC+1 |
| X |
| |
Yes | No | Ericsson | GMT/UTC | IST/UTC+1 |
| X |
| |
Yes | No | Ericsson | GMT/UTC | IST/UTC+1 | X |
|
| |
Yes | Yes | Ericsson | GMT/UTC | IST/UTC+1 |
| X (SM) |
| |
Yes | No | Ericsson | CET/UTC+1 | CEST/UTC+2 | X |
|
| |
Yes | Yes | Ericsson | GMT/UTC | IST/UTC+1 |
| X | X (SM) | |
Yes | No | Tech Mahindra | IST/UTC+5:30 | IST/UTC+5:30 |
|
| X | |
Yes | No | Tech Mahindra | IST/UTC+5:30 | IST/UTC+5:30 |
|
| X | |
Yes | No | Ericsson | GMT/UTC | IST/UTC+1 |
| X |
| |
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: Kohn 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.