X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Foverview.rst;h=cde6f6db626d7180e75a495352109f2fb1b76d11;hb=f16b9614298e7f0a820435f2dab2a856b487bf45;hp=b1f4755b66c2abfdcf888f51cdbf4116182d4ef6;hpb=cf2482c1fa1b7b9d9638e7c658807e8ab35069b4;p=cps.git diff --git a/docs/overview.rst b/docs/overview.rst index b1f4755b6..cde6f6db6 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -4,9 +4,7 @@ .. _overview: 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,15 +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. -Wiki: `Configuration Persistence Service Project `_ +**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. -Contact Information -------------------- +NCMP-DMI-Plugin +--------------- -onap-discuss@lists.onap.org +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 +=========== -Meeting details `Join `_ -`Agenda `_ +* Wiki: `Configuration Persistence Service Project `_ +* Contact Information: onap-discuss@lists.onap.org +* Meeting details: `Join `_ & `Agenda `_