summaryrefslogtreecommitdiffstats
path: root/docs/overview.rst
diff options
context:
space:
mode:
authorlukegleeson <luke.gleeson@est.tech>2021-09-29 11:43:34 +0100
committerlukegleeson <luke.gleeson@est.tech>2021-10-11 09:46:57 +0100
commit92496618169f4cac53f9808f59b77df96a88d4a1 (patch)
tree3091f7d6ec5bf773283a9314a07b5624bb983fa5 /docs/overview.rst
parent66b598a4243bb702059902af2903d1c3da01d5fa (diff)
Update Overview Section of Documentation
Added descriptions for NCMP, NCMP-DMI-Plugin and Temporal Issue-ID: CPS-690 Signed-off-by: lukegleeson <luke.gleeson@est.tech> Change-Id: I8aa15e6857250aaf49d5a14d371bc6aecf62f84c
Diffstat (limited to 'docs/overview.rst')
-rw-r--r--docs/overview.rst31
1 files changed, 29 insertions, 2 deletions
diff --git a/docs/overview.rst b/docs/overview.rst
index b1f4755b66..1333e66fc7 100644
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -6,8 +6,6 @@
CPS Overview
============
-.. warning:: draft
-
The Configuration Persistence Service (CPS) is a platform component that is designed to serve as a
data repository for runtime data that needs persistence.
@@ -29,6 +27,35 @@ 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 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 ONAP 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.
+
+ONAP NCMP-DMI-Plugin
+####################
+
+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
-----------