Create primary documentation for Jakarta release

[cps.git] / docs / overview.rst

diff --git a/docs/overview.rst b/docs/overview.rst
index 776e179..cde6f6d 100644 (file)
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -1,10 +1,10 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. Copyright (C) 2021 Pantheon.tech
+.. Copyright (C) 2021 Pantheon.tech, Nordix Foundation
 .. _overview:
 
 CPS Overview
-============
+############
 
 The Configuration Persistence Service (CPS) is a platform component that is designed to serve as a
 data repository for runtime data that needs persistence.
@@ -27,12 +27,38 @@ Types of data that is stored:
   information, meaning it is information that doesn't belong in A&AI. In principle, some parameters might be both
   configuration and operational parameters depending on how they are used.
 
-CPS Project
------------
+CPS Components
+==============
+
+CPS-Core
+--------
+This is the component of CPS which encompasses the generic storage of Yang module data.
+
+**NCMP**
+
+The Network Configuration Management Proxy (NCMP) provides access to network configuration data and is a part of CPS-Core.
+NCMP accesses all network Data-Model-Inventory (DMI) information via NCMP-DMI-Plugins. The ONAP0-DMI-Plugin described in the next section is one such plugin.
+
+**Note:** This documentation will often refer to "CPS-NCMP" which is the component (container image) that contains both CPS-Core and NCMP since NCMP is not a stand-alone component
+even though CPS-Core could be deployed without the NCMP extension.
 
-Wiki: `Configuration Persistence Service Project <https://wiki.onap.org/display/DW/Configuration+Persistence+Service+Project>`_
+NCMP-DMI-Plugin
+---------------
 
-Contact Information
--------------------
+The Data-Model-Inventory (DMI) Plugin is a rest interface used to synchronize CM-Handles data between CPS and DMI through the DMI-Plugin.
+This is built previously from the CPS-NF-Proxy component.
+
+CPS-Temporal
+------------
+
+This service is responsible to provide a time oriented perspective for
+operational network data. It provides features to store and retrieve sequences
+of configurations or states along with the associated times when they occurred
+or have been observed.
+
+CPS Project
+===========
 
-onap-discuss@lists.onap.org
+* Wiki: `Configuration Persistence Service Project <https://wiki.onap.org/display/DW/Configuration+Persistence+Service+Project>`_
+* Contact Information: onap-discuss@lists.onap.org
+* Meeting details: `Join  <https://zoom.us/j/836561560?pwd=TTZNcFhXTWYxMmZ4SlgzcVZZQXluUT09>`_ & `Agenda <https://wiki.onap.org/pages/viewpage.action?pageId=111117075>`_