Page Status:
...
Update in progress 01/12/2021
Component Status: Pending PTL updates and ArchCom Review
...
The Configuration Persistence Service (CPS) 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 CPS will be is a stand-alone component. Project page is here: Configuration Persistence Service Project
| draw.io Diagram | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
2. API definitions
Configuration & Pesistency Persistence Service provides the following interfaces:
...
| Interface Name | Interface Definition | Interface Capabilities | Protocol | Honolulu Status | Consumed Models | API Spec (Swagger) | CPSE-1 | Configuration 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 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CPS-E-01 | Provides remote clients with model LCM | Add model (to dataspace) Remove model (from dataspace) | REST | Available | Any model defined by YANG language | Gerrit link | ||||||||||||
| CPS-E-02 | Generic data mutation interface | Create an anchor Delete an anchor Create data Delete data Update data | REST | Available | NA | Gerrit link | ||||||||||||
| CPS-E-03 | Generic read/query interface | Read data Query data | REST | Available | NA | Gerrit link | ||||||||||||
| CPS-E-04 | Change notifications | Subscribe to DMaaP for changes to data | DMaaP | Not available | TBD | |||||||||||||
| CPS-E-05 | xNF data access | Create data Delete data Update data Read data Query data | REST | In scope | NA | TBD | ||||||||||||
| CPS-E-06 | Temporal data access | Read data Query data | REST | In scope | NA | TBD | ||||||||||||
| CPS-E-07 | Administration interface | Low level DB access for administration and troubleshooting | Various | Not available | NA | TBD | CPSE-4 | Configuration 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. |
Note: xxxI interface is a Component internal interface. xxxxE interface is a component external interface
...
| Interface Name | Purpose Reason For Use | API Spec (Swagger) | Honolulu status |
|---|---|---|---|
| SDCE-76 | 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 CPS - S/W to setup the CPS using the content of the CSAR package consumes the SDC CSAR Package. | Not used. xNF model will be fixed (local files) in the Honolulu time-frame | |
| AAIE-1 | This interface is used to automatically add/remove xNF data from CPS in line with xNF presence in AAI | Not used. xNF presence will be fixed (local files) | |
| CONE-7 | This interface is used to read and update data on the xNF | Reading will not be used. Initial state will be fixed (local files) in Honolulu. Writing will be used. |
3. Configuration Persistence Service Component Description:
...
- In R6 Frankfurt.
8. References
- In R7 this will be PoC which is described here: High Level Design (PoC)