For R7 GuiLin release the Data Persistency Service

USE CASE KEY INFORMATION

Topic	Description	Wiki
Contacts
Requirements Tracking	Project Management requirements Jira Ticket (clone++ of REQ-1)	REQ-322 - Getting issue details... STATUS
	OOF SON PCI for NFR	REQ-345 - Getting issue details... STATUS
Architecture Sub-committee Jira tracker	Link to Architecture Jira for Architecture sub-committee w/ presentation link	ONAPARC-575 - Getting issue details... STATUS
R7 Functional Requirements Page		Guilin release - functional requirements proposed list#Configuration&PersistencyServiceProject
Base Project Page	CONFIGURATION & PERSISTENCY SERVICE R6
Meetings Register	Configuration & Persistency Service Meeting Notes & Recordings
PoC Jira REQ	Model Driven C&PS PoC	REQ-384 - Getting issue details... STATUS
High Level Design PoC	Page for the High Level Design of the Model Driven C&PS PoC (R7)	High Level Design (PoC)
High Level Design PoC	Issues decisions & assumptions for the C&PS PoC (R7)	Issues decisions and assumptions
	C&PS Portal Page	Configuration & Persistency Service Portal Page
	R7 COMPONENT DESCRIPTION	ARC Configuration & Persistency Service (CnPS) Component Description - Guilin (R7) Release

BUSINESS DRIVER

EXECUTIVE SUMMARY - The Data Persistency Service is a new platform component that is designed to serve as a data repository for Run-time data that needs to be persistent. As a stand-alone ONAP component, this project provides data layer services to other ONAP platform components and use cases that require persistent configuration or operational data. The R6 development will be enhanced as well.

BUSINESS IMPACT - The ability for service operators to visualize and manage data in a RAN network (PNFs, VNFs, and logical constructs) with ONAP is a critical business function because they are key Life Cycle Management (LCM) and OA&M operations. The project has business impacts to enhance the operation of data-handling within ONAP by providing efficient data layer services.

BUSINESS MARKETS - This project applies to any domain (wireless, transport, optical, and wireline) that ONAP may manage. It is not a market or geographical specific capability. It is expected that scaled ONAP installations such as Edge & Core ONAP deployments will also deploy the database across each installation.

FUNDING/FINANCIAL IMPACTS - This project represents a large potential Operating Expense (OPEX) savings for operators because of the ability to configure networks saving time and expenses.

ORGANIZATION MGMT, SALES STRATEGIES - There is no additional organizational management or sales strategies for this use case outside of a service providers "normal" ONAP deployment and its attendant organizational resources from a service provider.

ROADMAP

The roadmap for CPS and what will be delivered in the upcoming releases:

Updated C&PS ROADMAP 26 Jun 2020

C&PS 1.0 - This is the evolution of ConfigDB in the CC-SDK / SDN-C. this solution was initially coded in R3 for the OOF/SON/PCI Use Case and was referred to as "ConfigDB" using a MariaDB ITDM solution. Because in R7 GuiLin planning, there is some clarity needed to identify the different tracks of development, the notation is introduced here, "C&PS 1.0" to allow people to have a common "language" to refer to a body of work. This was done in the R6 time frame.

C&PS 1.1 - This is the continuation of the C&PS 1.0 solution (see above). Updates will involve schema and interface changes for additional data supported in the C&PS database. This will be introduced in the R7 Guilin time frame. Thus, when someone refers to C&PS, in the R7 time frame they are referring to the C&PS 1.1 solution. Additionally, there are two C&PS related PoC going on the Model-Driven C&PS and State Management PoC (Bell Canada) and when referring to R7 C&PS, work done in these PoC are also included.

C&PS 2.0 - C&PS 2.0 is the stand-alone project. In R8 Honolulu, the goal is to have C&PS become its own stand-alone project. Thus, a presentation to the Architecture S/C and TSC will be made again to petition for a stand-alone project.

Updated Roadmap:

RELEASE	CONTENT	WIKI
R6 Frankfurt		CONFIGURATION & PERSISTENCY SERVICE
R7 Guilin	Store Real-Time Configuration Data Update Data Access Control	Guilin release - functional requirements proposed list#RunTimeConfigurationDatabase/DataPersistencyServiceProject Management framework (not mgmt policy to run network, ONAP mgmt policy) Network Elements (config info, policy for NE, A1 for NE)
R8 Honolulu	Data Recovery Model Adaptation (Dynamic Schema)
R-Future	Data Auditing Topology Traversal Data History Roll-Back Data Syncing Performance Optimization (Scaling)

PROPOSALS

PROJECT PROPOSAL	Target for R7 Guilin
DPS Project Proposal	Configuration Persistency Service Project Proposal (Oct 25 2019)
COMPONENT DESCRIPTION	ARC RunTime DB Component Description - R6 Frankfurt
ARCHITECTURE FLOWS	ARCHCOM: InfoFlow - RunTime Config DB Information Flow
MEETINGS REGISTER	Configuration & Persistency Service Meeting Notes & Recordings

DEVELOPMENT STATUS (R6 Extension)

PROJECT	PTL	User Story / Epic	Requirement
A&AI	James Forsyth
AAF	No Active PTL
APPC	Takamune Cho
CLAMP	Gervais-Martial Ngueko
CC-SDK (incl. CDS)	Dan Timoney	Epic #1 - OOF SON PCI U/C (possible) MariaDB/Yang Model/Schema Epic #2 - E2E Network Slicing
DCAE	Vijay Kumar
DMaaP	Mandar Sawant
External API	Adrian OSullivan
MODELING	Hui Deng
Multi-VIM / Cloud	Bin Yang
OOF	Shankaranarayanan Puzhavakath Narayanan
POLICY	Pamela Dragosh
PORTAL	Manoop Talasila
SDN-C	Dan Timoney
SDC	Ofir Sonsino
SO	Seshu Kumar Mudiganti
VID	ittay
VNFRQTS	Trevor Lovett
VNF-SDK	Former user (Deleted)

DEVELOPMENT STATUS (R7 as New Project)

PROJECT	PTL	User Story / Epic	Requirement
A&AI	James Forsyth
AAF	No Active PTL
APPC	Takamune Cho
CLAMP	Gervais-Martial Ngueko
CC-SDK (incl. CDS)	Dan Timoney
DCAE	Vijay Kumar
DMaaP	Mandar Sawant
External API	Adrian OSullivan
MODELING	Hui Deng
Multi-VIM / Cloud	Bin Yang
OOF	Shankaranarayanan Puzhavakath Narayanan
POLICY	Pamela Dragosh
PORTAL	Manoop Talasila
SDN-C	Dan Timoney
SDC	Ofir Sonsino
SO	Seshu Kumar Mudiganti
VID	ittay
VNFRQTS	Trevor Lovett
VNF-SDK	Former user (Deleted)

List of PTLs:Approved Projects

*Each Requirement should be tracked by its own User Story in JIRA

Use Case Diagram

Use cases define how different users interact with a system under design. Each use case represents an action that may be performed by a user (defined in UML as an Actor with a user persona).

The R7 Model Driven C&PS PoC diagram:

Use Case Functional Definitions

Use Case Title

Configuration Persistence SERVICE

Actors (and System Components)

SDC, A&AI, C&PS, Use Cases (PCI, E2E NS, A1E, Mirror), DBMS, TSDB, xNF, DCAE, DMaaP

Description

Configuration Persistence Service is a platform component that is designed to serve as a data repository for Run time data that needs to be persistent. It is characterized by the following.

DATA REPOSITORY - The types of data that is stored in the Run-Time data storage repository for:

CONFIGURATION PARAMETERS - These are configuration parameters that are used by xNFs during PnP, installation, commissioning.
OPERATIONAL PARAMETERS - These are parameters that are derived, discovered, computed that are used by xNFs during run time AFTER the xNF becomes operational i.e. AFTER it has "booted up", been installed, configured. These operational parameters are Exo-inventory information, meaning it is information that doesn't belong in A&AI.
NETWORK ELEMENT POLICY INFORMATION - NE policy type information used by micro-service.
APPLICATION INFORMATION - Information related to operational parameter.

DATA LAKE - Architecturally, the Configuration Persistence Service is designed to be a common services data layer which can serve as a data lake to other run time entities (ONAP components or external tools).

C&PS FUNCTIONS - The Configuration Persistence Service enables functionality to be performed by other entities. It will ENABLE the capability of another components or external tools within/or external to ONAP to perform the functions.

CONFIGURATION MANAGEMENT FUNCTIONS - Enables OSS configuration, optimization, and LCM operations.
SYNCING - The Configuration Persistence Service enables the ability to sync data between initial and delta changes ONAP & the xNFs.
DATA RECOVERY - It will allow for the recovery of data once a source of truth is defined.
UPDATES - It will allow for updates, delta changes, and incremental updates to be performed.
DATA HISTORY - See a history of changes in data including versioning of the data, updates, roll back, restoration, and time series management.
AUDITING - Auditing of parameters against a "golden" template. It itself stores & provides the data for auditing. Consistency checks.
ROLL BACK - It will allow for rollback back of entire DB to "save points" or recovery points.
RESTORATION - It will allow for the recovery and restoration of data records to a fall back point.
ACCESS CONTROL - A security topic, which allows the definition of policies, of who and what they can update.
TOPOLOGY TRAVERSAL - It will enable the ability for something to traverse the relationship between data elements.
MODEL ADAPTION - Allows for the adaptation or transformation of models from other sources (e.g. ORAN or 3GPP models).

Points of Contact

Use Case Lead: Benjamin Cheung Tony Finnerty Joanne Liu Rudel

Key Use Case Members: Toine Siebelink Former user (Deleted) johnsont

Code Contributors: (same as above)

Preconditions

DEPLOYMENT - The C&PS container/project is deployed and up and running.

AUTHENTICATION - Authentication is performed by C&PS to allow access and interaction with other ONAP platform components.

Triggers / Begins when

(See "Flow Step" for Design Time Activities, and Initial Database Setup below in the Steps/flows)

Steps / Flows (success)

Steps in Basic Operation and setup of C&PS.

SETUP FLOW STEP	SETUP STEP DESCRIPTION
DESIGN TIME ACTIVITIES (SD&C) (SETUP)	(Design time), (Setup DB) Yang Model development E.g.: ORAN specification Yang Model in line with 3GPP. SQL structure.
SDC CSAR LISTENER (SETUP)	The C&PS project listens for the Service CSAR packages which contain the schemas for resources associated with those services.
INITIAL DATABASE SETUP (Run Time)	The C&PS Database is initially setup.
INITIAL A&AI GETALL (SETUP)	Initial A&AI GetAll nodes is used to setup the existing xNFs that exist in the system
RUN-TIME OPERATION	RUN-TIME DESCRIPTION
(1) STND DEFINED VES UPDATE	(1) Standard defined VES event comes in through VES event, VES listener. This is then published onto DMaaP and C&PS get for that topic, namespace 3GPP_Configuration to write updates to the C&PS Database. Information coming into the C&PS via Stnd-Defined VES need to be "mapped" to the appropriate xNF and record.
(2) A&AI SYNCHRONIZATION	(2) A&AI Updates are made in order to update the existing xNF in the system if a xNF is created or deleted the corresponding records in C&PS DB need to be created/deleted. A&AI publishes onto DMaaP when an A&AI event occurs which updates the active xNFs available to the network.
(3) MICRO-SERVICE UPDATE	(3) Micro-services can update information in C&PS DB
(4A) ONAP PLATFORM COMPONENT INTERACTIONS	(4A) Other ONAP platform components such as the controllers might read or write information into the C&PS DB.
(4B) EXTERNAL ENTITIES	(4B) External entities can interact with the C&PS DB through External API

Post-conditions

SETUP OF C&PS - C&PS database is setup with initial schema

RUN-TIME OPERATION OF C&PS - the above run-time types of actions/operations (1) - (4A/B) above in the flow steps results in updates of C&PS or the interacting entity successfully retrieving information from C&PS DB.

Alternate / Exception Paths

The following describes error cases or conditions for each of the flow steps above:

SETUP FLOW STEP	EXCEPTIONS / ALTERNATE / CORNER CASES / ERRORS
DESIGN TIME ACTIVITIES (SD&C) (SETUP)	Problems in SD&C
SDC CSAR LISTENER (SETUP)	If the SDC CSAR package is irretrievable from DMaaP. If there is an Error in the SDC CSAR package
INITIAL DATABASE SETUP (Run Time)	YANG models, schema setup problems Setting up the C&PS DB errors.
INITIAL A&AI GETALL (SETUP)	Inability to perform A&AI GetAll Errors in A&AI GetAll
RUN-TIME OPERATION	EXCEPTIONS / ALTERNATE / CORNER CASES / ERRORS
(1) STND DEFINED VES UPDATE	Inability to get VES event from namespace DMaaP Bus Errors within the Stnd-Def VES event
(2) A&AI SYNCHRONIZATION	Inability to perform A&AI Event update Errors in A&AI Event Update
(3) MICRO-SERVICE UPDATE	Inability of micro-service to update C&PS DB Errors in C&PS DB Update
(4A) ONAP PLATFORM COMPONENT	Inability of component to update C&PS DB Errors in C&PS DB Update
(4B) EXTERNAL ENTITIES	Inability of entity to update C&PS DB Errors in C&PS DB Update Errors in API/interface interaction problem.

Related Use Cases

These are associated use cases or requirements depending on C&PS

Use Case

Link or Description

OOF SON PCI Use Case

The OOF SON PCI is a 5G RAN Wireless use case spanning R3 through R7 and beyond:

R7 OOF SON Use Case

End to End Network Slicing

E2E Network slicing is a 5G RAN Wireless application

E2E Network Slicing Use Case in R7 Guilin

Assumptions

Describes any assumptions that are made for this use case

Tools / References / Artifacts

List of any tools or reference material associated with this Use Case as well as any JIRA trace-ability.

List of any associated diagrams or modelling artifacts associated with the Use Case

Configuration Persistence Service Information Element

Information Element Name
Points of Contact	Authors and maintainers of the Information Element Information Element Main Contact (typically Use Case SME) Information Modeling Contact Schema Definition Contact
Related Use Cases	Use Cases that have interactions using this Information Element. Please provide a point of contact for each related Use Case.
Participating ONAP Components	The list of ONAP Components that are stakeholders for the Information Element
Related JIRA	Please provide link to related JIRA item
Description	How to inject model at onboarding. Model-Driven Approach. What's the minimum set that ONAP needs to know about a model in order to model & catalog. Resource IM call and weekly C&PS https://lf-onap.atlassian.net/wiki/download/attachments/16432033/CPS_PoC_IM_Support.pptx?version=1&modificationDate=1594025081000&api=v2 https://lf-onap.atlassian.net/wiki/display/DW/Support+for+CPS+Model+Driven+PoC
Related Standards & Industry Activities	Please refer to any standards or industry activities that should be taken into account when defining the Information Model related to this Information Element. Please provide links to relevant material.
Attributes	Attributes: Name and describe each attribute of this Information Element. Please include the datatype of the attribute if possible. Is this attribute read-only, read-write? Are there any default values?
Relationships	Relationships: Describe how this Information Element is related to other Information Elements. Also describe nature of the relationship: association, inheritance, dependency, etc. and multiplicity.
Originator	Where does this information come from? (What component initially creates it)
Consumers	Who uses this information inside & outside of ONAP? How do they use it? Includes description of information consumed (whole class, specific attributes, etc.)
Producers	Who updates this information inside & outside of ONAP? Under what conditions do they update it? Includes description of information produced (whole class, specific attributes, etc.)
Steward	Where will this information stored and maintained in ONAP?
Impacted APIs & Schemas	Identify impacted ONAP schemas & APIs Are there existing schemas be used or extended?
Information Modeling Status	What is the status of ONAP Information Modeling activities associated with this Information Element. Please provide links to relevant wiki pages & JIRA.
Schema Definition Status	What is the status of ONAP Schema Definition activities associated with this Information Element. Please provide links to relevant wiki pages & JIRA.
ONAP Release Priority	Prioritization for ONAP Releases

Weekly Meetings - Recordings & Discussion Log

Link to the team's weekly discussion, attendees & Recordings

Configuration & Persistency Service Meeting Notes & Recordings

SUPPORTING FILES

ITEM	DESCRIPTION	FILE
Project Proposal Presentation	TSC Project presentation Present at TSC 09 Apr 2020	ConfigurationPersistencySvc_29Ap2020v5.pptx
Project Proposal Presentation	Answers discussion updates ( 15 May 2020 Version)	ConfigurationPersistencySvc_15My2020v5.pptx
C&PS Model Driven PoC (Ericsson)	PoC demonstrating Model Driven management using C&PS database	CPS POC Proposal.pptx
State DB (Bell Canada) PoC	Bell Canada Leading a PoC related to State management using the C&PS project.	state-db-swagger-overview-1.0.0.pdf StateDB at Bell.pptx
Time series database mgmt	Time series database mgmt Presented by johnsont	TimeSeriesStreamingDatabase_202006Jn18_TJ.pptx
VIRTUAL DDF Presentations	C&PS Overview Presentation 25 Jun 2020	ConfigurationPersistencySvcDDF_25Jn2020v8.pdf
VIRTUAL DDF Presentations	Model-Driven C&PS PoC Presentation 25 Jun 2020	DDF_CPS_PoC_202006Jn25.pdf
C&PS PoC Architecture Options	C&PS PoC Architecture Options	CPSPoC_ArchOptions_202007Jy03.pdf
C&PS V-DDF C&PS Overview	C&PS Overview Update	ConfigurationPersistencySvcDDF_10Jy2020v8a.pptx ConfigurationPersistencySvcDDF_10Jy2020v8a.pdf
C&PS R8 Requirements	C&PS R8 Requirements Sub-committee proposal for 17 Aug 2020	ConfigurationPersistencySvcR8_202008Ag17v9.pptx ConfigurationPersistencySvcR8_202008Ag17v9.pdf
C&PS R8 Requirements	C&PS R8 Requirements Sub-committee proposal for 17 Aug 2020 (updated 10:40 AM UTC)	ConfigurationPersistencySvcR8_202008Ag17v9.pptx ConfigurationPersistencySvcR8_202008Ag17v9a.pdf
C&PS R8 requirements presentation	C&PS R8 Requirements sub-committee presentation made 17 Aug 2020	zoom_2020Aug17ReqSCPresentation.mp4 audio_only_2020Aug17ReqSCPresentation.m4a
C&PS R8 TSC Project proposal	C&PS presentation to present at the TSC to request for a new project status	ConfigurationPersistencySvcR8TSC_202010Oc01v10.pptx ConfigurationPersistencySvcR8TSC_202010Oc01v10.pdf
TSC Presentation	C&PS presentation to present at the TSC to request for a new project status, updated after presentation 01 Oct 2020	ConfigurationPersistencySvcR8TSC_202010Oc01v11.pptx ConfigurationPersistencySvcR8TSC_202010Oc01v11.pdf

Testing

Current Status

Testing Blockers
High visibility bugs
Other issues for testing that should be seen at a summary level
Where possible, always include JIRA links

End to End flow to be Tested

**This should be a summary level Sequence diagram done in Gliffy**

Test Cases and Status

1	There should be a test case for each item in the sequence diagram	NOT YET TESTED
2	create additional requirements as needed for each discreet step	COMPLETE
3	Test cases should cover entire Use Case	PARTIALLY COMPLETE
4	Test Cases should include enough detail for testing team to implement the test	FAILED