Table of Contents | ||
---|---|---|
|
Overview
Project Name | Enter the name of the project |
---|---|
Target Release Name | Istanbul |
Project Lifecycle State | Incubation |
Participating Company | Bell Canada, Ericsson, IBM, Highstreet, Pantheon |
Scope
What is this release trying to address?
Further integrate CPS into ONAP architecture through additional components and interfaces such as
- Network CM Proxy NCMP, moving from MVP to integrated component using SDN-C, DMaap and A&AI and an agreed new REST interface
- ONAP Data Model Inventory (DMI) Plugin to register supported CM handles and delegate data acces to the xNFS using ODL interface in SDN-C
- Model and Data Sync for nodes in DMI Plugin Inventory
- Storing and querying Temporal data
Requirements
Jira Legacy server System Jira serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key REQ-717 Jira Legacy server System Jira serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key REQ-720 Jira Legacy server System Jira serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key REQ-721
Minimum Viable Product
- Ability to add xNF (initial) inventory using 'side-door' interface
- Read Operation support for both cached data in CPS and xNF data using 'datastores' concept
- Write operation support for datastore ncmp-datastores:running
- Model and Data Sync for (manually added) Simulator based xNF
- Temporal ?service is able to store basic data updated events received from Core and is also able to respond to basic query requests.
Functionalities
Epics
Jira Legacy | ||||||
---|---|---|---|---|---|---|
|
...
Jira Legacy | ||||||||
---|---|---|---|---|---|---|---|---|
|
Jira Legacy | ||||||||
---|---|---|---|---|---|---|---|---|
|
Jira Legacy | ||||||
---|---|---|---|---|---|---|
|
Jira Legacy | ||||||
---|---|---|---|---|---|---|
|
Jira Legacy | ||||||||
---|---|---|---|---|---|---|---|---|
|
Jira Legacy | ||||||
---|---|---|---|---|---|---|
|
Stories
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Longer term roadmap
...
|
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
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 same 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 |
---|---|
To fill out | To fill out |
Sub-Components
List all sub-components part of this release.
Activities related to sub-components must be in sync with the overall release.
...
onap/cps-and-ncmp | Container running CPS and NCMP |
onap/cps-temporal | Container running CPS Temporal |
docs.onap.org | Documentation for R9 (incl. offered APIs release note) One entry point for all CPS documentation available at https://docs.onap.org/projects/onap-cps/en/latest/index.html. From there, documentation for all CPS components (core, ncmp, temporal, ...) shall be available. |
Sub-Components
- CPS-Core
- cps-service
- cps-rest
- cps-ri (reference implementation)
- NCMP
- cps-ncmp-service
- cps-ncmp-rest
- Temporal DB
- DMI-Plugin
Architecture
High level architecture diagram
At that stage within the Release, the team is expected to provide more Architecture details describing how the functional modules are interacting.
Indicate where your project fit within the ONAP Architecture diagram.
Block and sequence diagrams showing relation within the project as well as relation with external components are expected.
Anyone reading this section should have a good understanding of all the interacting modules.
Platform Maturity
Please fill out CPS is a new shared service in the ONAP Architecture:
For more detailed component description see ARC Configuration Persistence Service (CPS) Component Description - Istanbul-R9#6.SystemDeploymentArchitecture
Platform Maturity
See the centralized wiki page:Frankfurt Istanbul Release Platform Maturity
API Incoming Dependencies
No Incoming API changes required
API Outgoing Dependencies
List the API this project is expecting from other projects.
Prior to Release Planning review, Team Leads must agreed on the date by which the API will be fully defined. The API Delivery date must not be later than the release API Freeze date.
Prior to the delivery date, it is a good practice to organize an API review with the API consumers.
...
delivering to other projects.
API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
---|
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) | ||||
---|---|---|---|---|---|---|---|---|
To fill out | High level description of the API | Date for which the API is reviewed and agreed | To fill out | Link toward the detailed API description CPS-E-01 | CPS Model LifeCycle CPS Data Write CPS Data Read | Swagger Sources (openapi.yaml) | ||
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. Development of new functionality in third party product may or not be expected.
List the Third Party Products (OpenStack, ODL, RabbitMQ, ElasticSearch,Crystal Reports, ...).
...
In case there are specific dependencies (Centos 7 vs Ubuntu 16. Etc.) list them as well.
Testing and Integration Plans
Provide a description of the testing activities (unit test, functional test, automation,...) that will be performed by the team within the scope of this release.
Describe the plan to integrate and test the release deliverables within the overall ONAP system.
Confirm that resources have been allocated to perform such activities.
Gaps
This section is used to document a limitation on a functionality or platform support. We are currently aware of this limitation and it will be delivered in a future Release.
List identified release gaps (if any), and its impact.
...
Known Defects and Issues
Please refer to Frankfurt Defect Status
Risks
List the risks identified for this release along with the plan to prevent the risk to occur (mitigation) and the plan of action in the case the risk would materialized (contingency).
Please update any risk on the centralized wiki page - Frankfurt Risks
Resources
Fill out the Resources Committed to the Release centralized page..
Name | Description | Version |
---|---|---|
Docker | VM Container | 18 and above |
ODL Yang Tools | Yang model and Data Parser | 5.0.6 |
Postgres Docker image | VM container for Postgres | 13.2-alpine |
onap/integration-java11 | Java Base image | 8.0.0 |
Jetty | Application server | 9.4.41 |
Swagger | OpenAPI library | 2.1.4 |
SpringFox | OpenAPI library | 3.0.0 |
Hibernate types | Support for Postgres datatype JSONB | 2.10.0 |
Spring Boot | Application Framework | 2.5.0 |
cglib-nodep | 3pp | 3.1 |
commons-lang3 | 3pp | 3.11 |
antlr4-runtime | Language parser | 4.9.2 |
liquibase | DB Schema (version) management | 4.3.1 |
modelmapper | Model mapper library | 2.3.8 |
MapStruct | Model Mapper library (alternative) | 1.4.2.Final |
Testing and Integration Plans
- CPS has high level of built jUnit test (CPS-Core+NCMP >95%, Temporal DB >80% ) which is enforced by our maven build scripts
- CPS has built in Persistence Layer test ie. test that integrate with real DB covering all use cases and are part of WoW
- CIST test 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 introduced in I-release (like SDN-C, A&AI) will be added/tracked by
Jira Legacy server System Jira serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176 key INT-1902
Gaps
No gaps Identified
Known Defects and Issues
See dynamic Jira filter:
Jira Legacy | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Risks
No Risks identified, see also Istanbul Risks
Resources
Insert excerpt | ||||
---|---|---|---|---|
|
Release Milestone
The milestones are defined at the Release LevelPlanning 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 erecommended recommended to provide these agreements and dates in this section.
It is not expected to have a detailed project plan.
...
Documentation, Training
Please update See the following centralized wiki: Frankfurt Documentation
That includes
- Team contributions to the specific document related to he project (Config guide, installation guide...).
- Team contributions to the overall Release Documentation and training asset
- High level list of documentation, training and tutorials necessary to understand the release capabilities, configuration and operation.
- Documentation includes items such as:
- Installation instructions
- Configuration instructions
- Developer guide
- End User guide
- Admin guide
- ...
...
title | Note |
---|
...
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.
...