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 | |
| 19 | In this release the CPS is a stand-alone component. Project page describing eventual scope and ambition is here: |
| 20 | `Configuration Persistence Service Project <https://wiki.onap.org/display/DW/Configuration+Persistence+Service+Project>`_ |
| 21 | |
| 22 | This page reflects the state for Honolulu-R8 release. |
| 23 | |
| 24 | .. image:: _static/cps-r8-arch-diagram.png |
| 25 | |
| 26 | API definitions |
| 27 | =============== |
| 28 | |
| 29 | Configuration Persistence Service provides following interfaces. |
| 30 | |
| 31 | .. list-table:: |
| 32 | :header-rows: 1 |
| 33 | |
| 34 | * - Interface name |
| 35 | - Interface definition |
| 36 | - Interface capabilities |
| 37 | - Protocol |
| 38 | * - CPS-E-01 |
| 39 | - Administrative Data Management |
| 40 | - - create/delete dataspace |
| 41 | - create/delete schema set |
| 42 | - create/delete anchor |
| 43 | - REST |
| 44 | * - CPS-E-02 |
| 45 | - Generic Data Access |
| 46 | - - create data node |
| 47 | - read data node by xpath with or without descendants |
| 48 | - update data node by xpath with or without descendants |
| 49 | - REST |
| 50 | * - CPS-E-03 |
| 51 | - Generic Data Search |
| 52 | - - query data nodes by xpath prefix and attribute value |
| 53 | - REST |
| 54 | * - CPS-E-04 |
| 55 | - Change Notification |
| 56 | - *Not available in Honolulu-R8* |
| 57 | - *N/A* |
| 58 | * - CPS-E-05 |
| 59 | - xNF Data Access |
| 60 | - - read xNF data |
| 61 | - query xNF data |
| 62 | - REST |
| 63 | |
| 64 | The CPS Basic Concepts are described in :doc:`modeling`. |