Page Status: Copied from Guilin-R7 - Aug-24-2020
Component Status: Pending PTL updates and ArchCom Review
Last Reviewed on:
Certified by:
1. High Level Component Definition and Architectural Relationships
The Configuration & Persistency Persistence Service (C&PSCPS) provides storage for real-time run-time configuration and operational parameters that need to be used by ONAP.
In R7 this will be PoC which is described here: High Level Design (PoC)
In R8, Honolulu, the C&PS CPS will be a stand-alone component. Project page is here: Configuration Persistence Service Project
| draw.io Diagram | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
2. API definitions
Configuration & Pesistency provides the following interfaces:
...
| Interface Name | Interface Definition | Interface Capabilities | Protocol | Status | Consumed Models | API Spec (Swagger) |
|---|---|---|---|---|---|---|
| CPSE-1 | Configuration & Persistency Persistence Service (CPS) DB Model Interface. | Model life cycle (add and remove models) | REST | |||
| CPSE-2 | Access | Data access interface (CRUD) | REST | |||
| CPSE-3 | Update | Notification of data change (configured by model) | DMaaP | |||
| CPSE-4 | Configuration & Persistency Service DB Persistence Service (CPS) DB Graphical User Interfaces (GUI) | Provides the capability to view and edit the data currently in the C&PS DB. This GUI is meant to allow an operations user of ONAP to view the data stored in the RunTime DB during Run Time operation. |
...
The current API documents can be found at:
RTDB CPS consumes the following Interfaces:
| Interface Name | Purpose Reason For Use | API Spec (Swagger) |
|---|---|---|
| SDCE-7 | This interface is used to receive the service and resource artifacts (CSAR Package) from SDC. This allows the C&PS DB to process the design-time Yang model artifacts onboarded. STEPS: (1) ONBOARDING - A vendor onboards artifacts describing the parameters supported for their PNFs and VNFs in xNF Package. (2) SDC CATALOG - The onboarded artifacts are stored in the SDC Catalog after onboarding and validated (VNF-SDK). (3) CSAR DISTRIBUTION - The contents of the artifacts are distributed by SDC in a CSAR package onto the DMaaP bus. (4) SETTING UP RUNTIME DBCPS - S/W to setup the RunTime DB CPS using the content of the CSAR package consumes the SDC CSAR Package. |
3. Configuration
...
Persistence Service Component Description:
A more detailed figure and description of the component.
...
- INDEXING - Data Records will be indexed by xNF (VNF, PNF, ANF).
- RETRIEVAL - How are data records retrieved efficiently. This relates how the records are indexed.
4. Known system limitations
5. Used Models
RunTime DB uses the following models:
- Inventory Model (Run time platform data model)
6. System Deployment Architecture
7. New Capabilities in this Release
This release, RunTime DB adds the following Capabilities:
- In R6 Frankfurt.