| Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 1 | .. This work is licensed under a Creative Commons Attribution 4.0 International License. |
| 2 | .. http://creativecommons.org/licenses/by/4.0 |
| shivasubedi | 44beaa3 | 2021-09-13 15:16:30 +0100 | [diff] [blame] | 3 | .. Copyright (C) 2021 Pantheon.tech, Nordix Foundation |
| Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 4 | .. _overview: |
| 5 | |
| 6 | CPS Overview |
| Bruno Sakoto | a1129b6 | 2022-03-15 08:09:07 -0400 | [diff] [blame] | 7 | ############ |
| Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 8 | |
| 9 | The Configuration Persistence Service (CPS) is a platform component that is designed to serve as a |
| 10 | data repository for runtime data that needs persistence. |
| 11 | |
| 12 | Types of data that is stored: |
| 13 | |
| 14 | - **Configuration Parameters** |
| 15 | |
| 16 | These are configuration parameters that are used by xNFs during installation & commissioning. Configuration |
| 17 | parameters are typically used before the xNF has been brought up or is operational. For example, a 5G Network |
| 18 | configuration parameter for a PNFs that sets the mechanical tilt which is a configuration setting upon |
| 19 | installation. |
| 20 | |
| 21 | - **Operational Parameters** |
| 22 | |
| 23 | This operational information could be either an actual state or configuration of a network service or device. |
| 24 | These are parameters that are derived, discovered, computed that are used by xNFs during run time AFTER the |
| 25 | xNF becomes operational i.e. AFTER it has "booted up", been installed or configured. For example, in 5G Network, |
| 26 | 5G PNFs may need to adjust a tower electrical antenna tilt. These operational parameters are Exo-inventory |
| 27 | information, meaning it is information that doesn't belong in A&AI. In principle, some parameters might be both |
| 28 | configuration and operational parameters depending on how they are used. |
| 29 | |
| lukegleeson | 9249661 | 2021-09-29 11:43:34 +0100 | [diff] [blame] | 30 | CPS Components |
| Bruno Sakoto | a1129b6 | 2022-03-15 08:09:07 -0400 | [diff] [blame] | 31 | ============== |
| lukegleeson | 9249661 | 2021-09-29 11:43:34 +0100 | [diff] [blame] | 32 | |
| 33 | CPS-Core |
| Bruno Sakoto | a1129b6 | 2022-03-15 08:09:07 -0400 | [diff] [blame] | 34 | -------- |
| lukegleeson | 9249661 | 2021-09-29 11:43:34 +0100 | [diff] [blame] | 35 | This is the component of CPS which encompasses the generic storage of Yang module data. |
| 36 | |
| 37 | **NCMP** |
| 38 | |
| 39 | The Network Configuration Management Proxy (NCMP) provides access to network configuration data and is a part of CPS-Core. |
| DylanB95EST | 3fcf869 | 2021-10-11 16:29:16 +0100 | [diff] [blame] | 40 | NCMP accesses all network Data-Model-Inventory (DMI) information via NCMP-DMI-Plugins. The ONAP0-DMI-Plugin described in the next section is one such plugin. |
| lukegleeson | 9249661 | 2021-09-29 11:43:34 +0100 | [diff] [blame] | 41 | |
| 42 | **Note:** This documentation will often refer to "CPS-NCMP" which is the component (container image) that contains both CPS-Core and NCMP since NCMP is not a stand-alone component |
| 43 | even though CPS-Core could be deployed without the NCMP extension. |
| 44 | |
| DylanB95EST | 3fcf869 | 2021-10-11 16:29:16 +0100 | [diff] [blame] | 45 | NCMP-DMI-Plugin |
| Bruno Sakoto | a1129b6 | 2022-03-15 08:09:07 -0400 | [diff] [blame] | 46 | --------------- |
| lukegleeson | 9249661 | 2021-09-29 11:43:34 +0100 | [diff] [blame] | 47 | |
| DylanB95EST | 3fcf869 | 2021-10-11 16:29:16 +0100 | [diff] [blame] | 48 | The Data-Model-Inventory (DMI) Plugin is a rest interface used to synchronize CM-Handles data between CPS and DMI through the DMI-Plugin. |
| lukegleeson | 9249661 | 2021-09-29 11:43:34 +0100 | [diff] [blame] | 49 | This is built previously from the CPS-NF-Proxy component. |
| 50 | |
| Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 51 | CPS Project |
| Bruno Sakoto | a1129b6 | 2022-03-15 08:09:07 -0400 | [diff] [blame] | 52 | =========== |
| Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 53 | |
| sourabh_sourabh | 89bfabf | 2024-10-02 16:37:47 +0100 | [diff] [blame] | 54 | * Wiki: `Configuration Persistence Service Project <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16398157/Configuration+Persistence+Service+Project>`_ |
| Bruno Sakoto | a1129b6 | 2022-03-15 08:09:07 -0400 | [diff] [blame] | 55 | * Contact Information: onap-discuss@lists.onap.org |
| sourabh_sourabh | 89bfabf | 2024-10-02 16:37:47 +0100 | [diff] [blame] | 56 | * Meeting details: `Join <https://zoom.us/j/836561560?pwd=TTZNcFhXTWYxMmZ4SlgzcVZZQXluUT09>`_ & `Agenda <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/18644995>`_ |