Skip to end of metadata
Go to start of metadata

Overview

Project NameEnter the name of the project
Target Release NameKohn
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

  • 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
PreliminaryFixedIn ProgressPausedCompletedDe-scoped
Delivered
(on master)
CommittedStudy/Investigation
No delivery
Partial Delivery

De-scoped

ONAP Best Practices (Global Requirements)

ONAP RequirementNotesCPS- Jira(s)

REQ-443 - Getting issue details... STATUS

Aiming for gold!
  1. Need to complete Survey
  2. Dependency on ONAP Infrastructure Tickets

CPS-1140 - Getting issue details... STATUS

REQ-439 - Getting issue details... STATUS


CPS-1106 - Getting issue details... STATUS

CPS-CORE / CPS-NCMP Requirements

PriorityKohn
Requirement Jira
Component(s)DescriptionNotesPrinciple Point of ContactJira(s)
1

REQ-1281 - Getting issue details... STATUS

CPS-NCMPNCMP 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... STATUS
CPS-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-NCMPSupport public CM handle propertiesBasic support for public properties + query capability

CPS-677 - Getting issue details... STATUS CPS-817 - Getting issue details... STATUS CPS-837 - Getting issue details... STATUS CPS-731 - Getting issue details... STATUS

CPS-1016 - Getting issue details... STATUS

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

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

Sourabh Sourabh 

CPS-821 - Getting issue details... STATUS CPS-828 - Getting issue details... STATUS CPS-829 - Getting issue details... STATUS CPS-830 - Getting issue details... STATUS CPS-832 - Getting issue details... STATUS

4

REQ-1281 - Getting issue details... STATUS Requirement 
E2E Slicing for next release!

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

CPS-1236 - Getting issue details... STATUS
CPS-1362 - Getting issue details... STATUS
7

REQ-1281 - Getting issue details... STATUS

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

CPS-1065 - Getting issue details... STATUS CPS-1259 - Getting issue details... STATUS

8

REQ-1281 - Getting issue details... STATUS

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

CPS-1145 - Getting issue details... STATUS CPS-1166 - Getting issue details... STATUS


9

REQ-1281 - Getting issue details... STATUS

CPS-NCMPExplicit (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.

CPS-1133 - Getting issue details... STATUS CPS-1168 - Getting issue details... STATUS


10

REQ-1281 - Getting issue details... STATUS Requirement 
E2E Slicing for next release!

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

11
CPS-NCMPRegistration Performance

NCMP shall register new cmhandles (to READY state) at a rate of 11 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

CPS-1126 - Getting issue details... STATUS CPS-1275 - Getting issue details... STATUS CPS-1267 - Getting issue details... STATUS
12
CPSData Read Performance

CPS-1171 - Getting issue details... STATUS

CPS-1222 - Getting issue details... STATUS

13
CPS-NCMPDeletion PerformanceNCMP 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-NCMPInvoke 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-NCMPEnhanced query supportCurrently 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-NCMPUpdate 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-NCMPRetrieve single module resource/v1/ch/{cm-handle}/modules/definitions/{moduleName}

18
CPS-Core / CPS-NCMPExisting 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-NCMPFine-grained cache configuration


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


22
CPS-Core /
CPS-NCMP

Support for HTTPS and authentication

  • Use Service-Mesh? Both ONAP and Ericsson (applied ISTIO using Envoy Proxy side-car) are working towards this. Check with Gareth Roper 


CPS-703 - Getting issue details... STATUS

23

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.

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


25TBCCPS-CoreSend 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

CPS-491 - Getting issue details... STATUS

CPS-765 - Getting issue details... STATUS CPS-766 - Getting issue details... STATUS CPS-767 - Getting issue details... STATUS

27
CPS-Core /
CPS-NCMP
Support for multiple top-elements from different modules in one CM handle/anchor



CPS-1051 - Getting issue details... STATUS

CPS-341 - Getting issue details... STATUS

28
CPS-Core /
CPS-NCMP
schema-set update for CM handle with cached data presentNeed 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.
Strimzi-Kafka Bridge might be an alternative, check with Fiachra Corcoran  on the latest for this when implementing this ( DMAAP-1681 - Getting issue details... STATUS )

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


CPS-392 - Getting issue details... STATUS CPS-393 - Getting issue details... STATUS

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

31
CPS-NCMPInvoke YANG modelled RPC


Spin-off user stories, yet to be prioritized

 JiraComponent(s)Related Work ItemDescriptionNotes

CPS-1103 - Getting issue details... STATUS

CPS-NCMP4

CPS-1127 - Getting issue details... STATUS

CPS-NCMP4

CPS-1132 - Getting issue details... STATUS

CPS-NCMP1

CPS-1174 - Getting issue details... STATUS

CPS-NCMP8

CPS-1183 - Getting issue details... STATUS

CPS-NCMP
Investigation on the use of Liquibase to install NCMP artifacts

Functionalities

User Stories

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
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 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 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: Kohn 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. 

NameDescriptionCPS-Core CPS-NCMPCPS-Temporal 
3PP Version
DockerVM Container18 and above18 and above18 and above
ODL Yang ToolsYang model and Data Parser6.0.1 6.0.1 N/A 
Postgres Docker imageVM container for Postgres13.2-alpine13.2-alpineN/A
onap/integration-java11Java Base image8.0.08.0.08.0.0
SwaggerOpenAPI library2.1.42.1.4

springdoc-openapi-ui:1.5.9

SpringFoxOpenAPI library3.0.03.0.03.0.0
Hibernate typesSupport for Postgres datatype JSONB2.10.02.10.02.10.0
Spring BootApplication Framework2.6.92.6.92.6.9
Commons-lang33pp3.113.113.12.0
Antlr4-runtimeLanguage parser4.9.24.9.2N/A
LiquibaseDB Schema (version) management4.4.2-nordix4.4.2-nordix4.4.2-nordix
HazelcastDistributed Cache4.2.5N/AN/A



  • Gaps

No gaps Identified

  • Known Defects and Issues

See dynamic Jira filter:

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Loading...
Refresh

  • Risks

Risk identified related to scope-creep, see Kohn Risk Table 

  • Resources

Configuration Persistence Service Developer's Landing Page

NameCode ContributorCurrently ActiveCommitter

Organization

Time ZonesCPS Daily Scrums*
WinterSummer (DST)Focus Team 1Focus Team 2DT Sub Team
YesYesYesEricssonGMT/UTCIST/UTC+1X (SM)

kieran mccarthy(stakeholder)

NoYesNoEriccsonCET/UTC+1CEST/UTC+2


Tony Finnerty (architect)

NoYesNoEricssonGMT/UTCIST/UTC+1


NoYesNoEricssonGMT/UTCIST/UTC+1


YesYesNoTech MahindraIST/UTC+5:30IST/UTC+5:30

X
YesYesNoEricssonGMT/UTCIST/UTC+1X

Halil Cakal YesYesNoEricssonGMT/UTCIST/UTC+1
X
YesYesNoEricssonGMT/UTCIST/UTC+1
XX (SM)
YesYesNoEricssonCET/UTC+1CEST/UTC+2X

YesYesYesEricssonGMT/UTCIST/UTC+1
X (SM)
YesYesYesEricssonGMT/UTCIST/UTC+1
X
YesYesNoEricssonGMT/UTCIST/UTC+1X

YesYesNoTech MahindraIST/UTC+5:30IST/UTC+5:30

X
YesYesNoTech MahindraIST/UTC+5:30IST/UTC+5:30

X
YesYesNoEricssonGMT/UTCIST/UTC+1
X
YesYesYesEricssonGMT/UTCIST/UTC+1X

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

  • No labels