| 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 |
| 3 | .. Copyright (C) 2021 Nordix Foundation, Pantheon.tech |
| niamhcore | 541952b | 2021-02-24 14:11:56 +0000 | [diff] [blame] | 4 | .. _architecture: |
| 5 | |
| Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 6 | CPS Architecture |
| 7 | ################ |
| 8 | |
| 9 | .. toctree:: |
| 10 | :maxdepth: 1 |
| 11 | |
| 12 | |
| 13 | High Level Component Definition and Architectural Relationships |
| 14 | =============================================================== |
| 15 | |
| 16 | The Configuration Persistence Service (CPS) provides storage for run-time configuration and operational |
| 17 | parameters that need to be used by ONAP. |
| 18 | |
| ToineSiebelink | d0e4a9c | 2023-11-08 17:29:50 +0000 | [diff] [blame] | 19 | CPS is no longer a stand alone component and is released along with and the NCMP-DMI-Plugin. |
| Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 20 | |
| shivasubedi | 44beaa3 | 2021-09-13 15:16:30 +0100 | [diff] [blame] | 21 | Project page describing eventual scope and ambition is here: |
| sourabh_sourabh | 89bfabf | 2024-10-02 16:37:47 +0100 | [diff] [blame] | 22 | `Configuration Persistence Service Project <https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16398157/Configuration+Persistence+Service+Project>`_ |
| shivasubedi | 44beaa3 | 2021-09-13 15:16:30 +0100 | [diff] [blame] | 23 | |
| emaclee | 92fd1bd | 2023-03-07 09:29:11 +0000 | [diff] [blame] | 24 | This page reflects the state for the latest release. |
| Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 25 | |
| ToineSiebelink | d0e4a9c | 2023-11-08 17:29:50 +0000 | [diff] [blame] | 26 | .. image:: _static/cps-r13-arch-diagram.png |
| Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 27 | |
| 28 | API definitions |
| 29 | =============== |
| 30 | |
| lukegleeson | 107fd7a | 2021-09-27 13:59:25 +0100 | [diff] [blame] | 31 | Configuration Persistence Service provides the following interfaces. |
| Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 32 | |
| 33 | .. list-table:: |
| 34 | :header-rows: 1 |
| 35 | |
| 36 | * - Interface name |
| 37 | - Interface definition |
| 38 | - Interface capabilities |
| 39 | - Protocol |
| 40 | * - CPS-E-01 |
| 41 | - Administrative Data Management |
| lukegleeson | 107fd7a | 2021-09-27 13:59:25 +0100 | [diff] [blame] | 42 | - - create dataspace |
| Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 43 | - create/delete schema set |
| 44 | - create/delete anchor |
| 45 | - REST |
| 46 | * - CPS-E-02 |
| 47 | - Generic Data Access |
| 48 | - - create data node |
| 49 | - read data node by xpath with or without descendants |
| 50 | - update data node by xpath with or without descendants |
| 51 | - REST |
| 52 | * - CPS-E-03 |
| 53 | - Generic Data Search |
| 54 | - - query data nodes by xpath prefix and attribute value |
| 55 | - REST |
| 56 | * - CPS-E-04 |
| 57 | - Change Notification |
| lukegleeson | 107fd7a | 2021-09-27 13:59:25 +0100 | [diff] [blame] | 58 | - - Kafka is used as the event messaging system |
| efiacor | b869181 | 2022-03-15 11:26:46 +0000 | [diff] [blame] | 59 | - running instance is supplied independently from any Kafka instance deployed from ONAP |
| lukegleeson | 107fd7a | 2021-09-27 13:59:25 +0100 | [diff] [blame] | 60 | - published events contain Timestamp, Dataspace, Schema set, Anchor and JSON Data Payload |
| efiacor | b869181 | 2022-03-15 11:26:46 +0000 | [diff] [blame] | 61 | - Kafka |
| Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 62 | * - CPS-E-05 |
| 63 | - xNF Data Access |
| 64 | - - read xNF data |
| 65 | - query xNF data |
| 66 | - REST |
| lukegleeson | 107fd7a | 2021-09-27 13:59:25 +0100 | [diff] [blame] | 67 | * - CPS-E-07 |
| 68 | - Admin |
| 69 | - - logging levels and configuration |
| 70 | - monitoring |
| 71 | - health including liveliness state and readiness state |
| 72 | - metrics through Prometheus |
| 73 | - Various |
| Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 74 | |
| 75 | The CPS Basic Concepts are described in :doc:`modeling`. |