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 .. 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 CPS is no longer a stand alone component and is released along with and the NCMP-DMI-Plugin.
  20
  21 Project page describing eventual scope and ambition is here:
  22 `Configuration Persistence Service Project <https://wiki.onap.org/display/DW/Configuration+Persistence+Service+Project>`_
  23
  24 This page reflects the state for the latest release.
  25
  26 .. image:: _static/cps-r13-arch-diagram.png
  27
  28 API definitions
  29 ===============
  30
  31 Configuration Persistence Service provides the following interfaces.
  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
  42      - - create dataspace
  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
  58      - - Kafka is used as the event messaging system
  59        - running instance is supplied independently from any Kafka instance deployed from ONAP
  60        - published events contain Timestamp, Dataspace, Schema set, Anchor and JSON Data Payload
  61      - Kafka
  62    * - CPS-E-05
  63      - xNF Data Access
  64      - - read xNF data
  65        - query xNF data
  66      - REST
  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
  74
  75 The CPS Basic Concepts are described in :doc:`modeling`.