docs/overview.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 Pantheon.tech
   4 .. _overview:
   5
   6 CPS Overview
   7 ============
   8
   9 The Configuration Persistence Service (CPS) is a platform component that is designed to serve as a
  10 data repository for runtime data that needs persistence.
  11
  12 Types of data that is stored:
  13
  14 - **Configuration Parameters**
  15
  16   These are configuration parameters that are used by xNFs during installation & commissioning. Configuration
  17   parameters are typically used before the xNF has been brought up or is operational. For example, a 5G Network
  18   configuration parameter for a PNFs that sets the mechanical tilt which is a configuration setting upon
  19   installation.
  20
  21 - **Operational Parameters**
  22
  23   This operational information could be either an actual state or configuration of a network service or device.
  24   These are parameters that are derived, discovered, computed that are used by xNFs during run time AFTER the
  25   xNF becomes operational i.e. AFTER it has "booted up", been installed or configured. For example, in 5G Network,
  26   5G PNFs may need to adjust a tower electrical antenna tilt. These operational parameters are Exo-inventory
  27   information, meaning it is information that doesn't belong in A&AI. In principle, some parameters might be both
  28   configuration and operational parameters depending on how they are used.
  29
  30 CPS Project
  31 -----------
  32
  33 Wiki: `Configuration Persistence Service Project <https://wiki.onap.org/display/DW/Configuration+Persistence+Service+Project>`_
  34
  35 Contact Information
  36 -------------------
  37
  38 onap-discuss@lists.onap.org