Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
outlinetrue

Overview

Project NameEnter the name of the project
Target Release NameIstanbul
Project Lifecycle StateIncubation
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
    serverONAP Jira
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyREQ-717
  • Jira
    serverONAP Jira
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyREQ-720
  • Jira
    serverONAP Jira
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyREQ-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
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-350

...

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-382

Jira
serverONAP Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-189

Jira
serverONAP Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-224

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-369

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-370

Jira
serverONAP Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-426

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-446


Stories

Expand
titleClosed Stories

Jira
serverONAP Jira
columns

Longer term roadmap

...

key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues20
jqlQueryproject = CPS AND type = Story AND fixVersion = "Istanbul Release" AND status in (Closed, Done) ORDER BY updated DESC
serverId425b2b0a-557c-3c0c-b515-579789cceedb


Expand
titleStories in progress or on backlog

Jira
serverONAP Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues20
jqlQueryproject = CPS AND type = Story AND fixVersion = "Istanbul Release" AND status not in (Closed, Done) ORDER BY status DESC
serverId425b2b0a-557c-3c0c-b515-579789cceedb


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 NameDeliverable Description
To fill outTo 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-temporalContainer 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

CPS is a new shared service in the ONAP Architecture:

Image Added


For more detailed component description see ARC Configuration Persistence Service (CPS) Component Description - Istanbul-R9#6.SystemDeploymentArchitecture

Platform Maturity

See Please fill out 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
API
NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
To fill outHigh level description of the APIDate for which the API is reviewed and agreedTo fill outLink toward the detailed API description
  • API Outgoing Dependencies

API this project is delivering to other projects.

Link toward the detailed API description

CPS-E-01
CPS-E-02
CPS-E-03

CPS Model LifeCycle
CPS Data Write
CPS Data Read


Swagger Sources (openapi.yaml)
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)
API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
To fill outHigh level description of the APIDate for which the API is reviewed and agreedTo fill out
  • 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.

...

NameDescriptionVersion
DockerVM Container18 and above
ODL Yang ToolsYang model and Data Parser5.0.6 
Postgres Docker imageVM container for Postgres13.2-alpine
onap/integration-java11Java Base image8.0.0
JettyApplication server9.4.41
SwaggerOpenAPI library2.1.4
SpringFoxOpenAPI library3.0.0
Hibernate typesSupport for Postgres datatype JSONB2.10.0
Spring BootApplication Framework2.5.0
cglib-nodep3pp3.1
commons-lang33pp3.11
antlr4-runtimeLanguage parser4.9.2
liquibaseDB Schema (version) management4.3.1
modelmapperModel mapper library2.3.8
MapStructModel Mapper library (alternative)1.4.2.Final



  • Gaps

No gaps Identified

  • Known Defects and Issues

See dynamic Jira filter:

Jira
serverONAP Jira
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues20
jqlQueryproject = CPS and type = bug and status = open
serverId425b2b0a-557c-3c0c-b515-579789cceedb


  • Risks

No Risks identified, see also Istanbul Risks

  • Resources

Excerpt Include
Configuration Persistence Service Developer's Landing Page
Configuration Persistence Service Developer's Landing Page

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


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

...

titleNote

...

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

...