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 In this release CPS is no longer a stand alone component and is released along with Cps-Temporal 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 Istanbul-R9 release.
  25
  26 .. image:: _static/star.png
  27     :class: float-left
  28
  29 **Note:** SDC and AAI interfaces have not yet been implemented.
  30
  31 .. image:: _static/cps-r9-arch-diagram.png
  32
  33 API definitions
  34 ===============
  35
  36 Configuration Persistence Service provides the following interfaces.
  37
  38 .. list-table::
  39    :header-rows: 1
  40
  41    * - Interface name
  42      - Interface definition
  43      - Interface capabilities
  44      - Protocol
  45    * - CPS-E-01
  46      - Administrative Data Management
  47      - - create dataspace
  48        - create/delete schema set
  49        - create/delete anchor
  50      - REST
  51    * - CPS-E-02
  52      - Generic Data Access
  53      - - create data node
  54        - read data node by xpath with or without descendants
  55        - update data node by xpath with or without descendants
  56      - REST
  57    * - CPS-E-03
  58      - Generic Data Search
  59      - - query data nodes by xpath prefix and attribute value
  60      - REST
  61    * - CPS-E-04
  62      - Change Notification
  63      - - Kafka is used as the event messaging system
  64        - running instance is supplied independently from any Kafka instance deployed from ONAP
  65        - published events contain Timestamp, Dataspace, Schema set, Anchor and JSON Data Payload
  66      - Kafka
  67    * - CPS-E-05
  68      - xNF Data Access
  69      - - read xNF data
  70        - query xNF data
  71      - REST
  72    * - CPS-E-06
  73      - Temporal Data Access
  74      - - data storage and access
  75      - REST
  76    * - CPS-E-07
  77      - Admin
  78      - - logging levels and configuration
  79        - monitoring
  80        - health including liveliness state and readiness state
  81        - metrics through Prometheus
  82      - Various
  83
  84 The CPS Basic Concepts are described in :doc:`modeling`.