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