Table of Contents |
---|
For R7 GuiLin release the Data Persistency Service
...
Topic | Description | Wiki | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
Contacts | ||||||||||
Requirements Tracking | Project Management requirements Jira Ticket (clone++ of REQ-1) |
| ||||||||
OOF SON PCI for NFR |
| |||||||||
Architecture Sub-committee Jira tracker | Link to Architecture Jira for Architecture sub-committee w/ presentation link |
| ||||||||
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 |
| ||||||||
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.
...
The roadmap for CPS and what will be delivered in the upcoming releases:
Updated C&PS ROADMAP
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 | 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) |
...
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)
...
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 | Title of the Use CaseConfiguration 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 list of Actors and System Components that participate in the Use Case | ||||||||||||||||||||||||
Description | Short overview of the Use Case | ||||||||||||||||||||||||
Points of Contact | Authors and maintainers of the Use Case. Use Case Lead, Key Use Case members and code contributors. | ||||||||||||||||||||||||
Preconditions | A list of conditions that are assumed to be true before the Use Case is invoked Includes description of Information Consumed | ||||||||||||||||||||||||
Triggers / Begins when | Describes the trigger for beginning the Use Case | ||||||||||||||||||||||||
Steps / Flows (success) | Describes the sequence of steps and interactions that occur during the Use Case (may include: description, data exchanges, functionality, state changes) Interaction diagrams may be included or referenced | ||||||||||||||||||||||||
Post-conditions | The expected results of the execution of the Use Case Includes description of Information Produced | ||||||||||||||||||||||||
Alternate / Exception Paths | Description of any exceptions or special process that could occur during Use Case | ||||||||||||||||||||||||
types of data that is stored in the Run-Time data storage repository for:
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.
| |||||||||||||||||||||||||
Points of Contact | Use Case Lead: Benjamin Cheung Tony Finnerty Joanne Liu Rudel Key Use Case Members: Toine Siebelink user-4e793 theodore johnson 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.
| ||||||||||||||||||||||||
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:
| ||||||||||||||||||||||||
Related Use Cases | These are associated use cases or requirements depending on C&PS
| Related Use Cases | List of the Use Cases referenced by this Use Case | ||||||||||||||||||||||
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
|
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 | |
Project Proposal Presentation | Answers discussion updates ( Version) | |
C&PS Model Driven PoC (Ericsson) | PoC demonstrating Model Driven management using C&PS database | |
State DB (Bell Canada) PoC | Bell Canada Leading a PoC related to State management using the C&PS project. | |
Time series database mgmt | Time series database mgmt Presented by theodore johnson | |
VIRTUAL DDF Presentations | C&PS Overview Presentation | |
VIRTUAL DDF Presentations | Model-Driven C&PS PoC Presentation | |
C&PS PoC Architecture Options | C&PS PoC Architecture Options | |
C&PS V-DDF C&PS Overview | C&PS Overview Update | |
C&PS R8 Requirements | C&PS R8 Requirements Sub-committee proposal for | |
C&PS R8 Requirements | C&PS R8 Requirements Sub-committee proposal for (updated 10:40 AM UTC) | |
C&PS R8 requirements presentation | C&PS R8 Requirements sub-committee presentation made | |
C&PS R8 TSC Project proposal | C&PS presentation to present at the TSC to request for a new project status | |
TSC Presentation | C&PS presentation to present at the TSC to request for a new project status, updated after presentation | |
Testing
Current Status
...