docs/architecture.rst

   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
   4 .. _architecture:
   5
   6 CPS Architecture
   7 ################
   8
   9 .. warning:: draft
  10
  11 .. toctree::
  12    :maxdepth: 1
  13
  14
  15 High Level Component Definition and Architectural Relationships
  16 ===============================================================
  17
  18 The Configuration Persistence Service (CPS) provides storage for run-time configuration and operational
  19 parameters that need to be used by ONAP.
  20
  21 In this release CPS is no longer a stand alone component and is released along with Cps-Temporal and the NCMP-DMI Plugin.
  22
  23 Project page describing eventual scope and ambition is here:
  24 `Configuration Persistence Service Project <https://wiki.onap.org/display/DW/Configuration+Persistence+Service+Project>`_
  25
  26 This page reflects the state for Istanbul-R9 release.
  27
  28 .. image:: _static/cps-r8-arch-diagram.png
  29
  30 API definitions
  31 ===============
  32
  33 Configuration Persistence Service provides following interfaces.
  34
  35 .. list-table::
  36    :header-rows: 1
  37
  38    * - Interface name
  39      - Interface definition
  40      - Interface capabilities
  41      - Protocol
  42    * - CPS-E-01
  43      - Administrative Data Management
  44      - - create/delete dataspace
  45        - create/delete schema set
  46        - create/delete anchor
  47      - REST
  48    * - CPS-E-02
  49      - Generic Data Access
  50      - - create data node
  51        - read data node by xpath with or without descendants
  52        - update data node by xpath with or without descendants
  53      - REST
  54    * - CPS-E-03
  55      - Generic Data Search
  56      - - query data nodes by xpath prefix and attribute value
  57      - REST
  58    * - CPS-E-04
  59      - Change Notification
  60      - *Not available in Honolulu-R8*
  61      - *N/A*
  62    * - CPS-E-05
  63      - xNF Data Access
  64      - - read xNF data
  65        - query xNF data
  66      - REST
  67
  68 The CPS Basic Concepts are described in :doc:`modeling`.