Copyright Check Script

[cps.git] / docs / modeling.rst

diff --git a/docs/modeling.rst b/docs/modeling.rst
index 4e46e71..b750c6d 100644 (file)
--- a/docs/modeling.rst
+++ b/docs/modeling.rst
@@ -3,20 +3,24 @@
 .. Copyright (C) 2021 Pantheon.tech
 .. _modeling:
 
+.. toctree::
+   :maxdepth: 1
+
 CPS Modeling
 ############
 
-.. warning:: draft
-
-.. toctree::
-   :maxdepth: 1
+CPS-Core Modeling
+=================
 
-Basic Concepts
-==============
+Data Model
+----------
 
 .. image:: _static/cps-modeling-concepts.png
    :alt: Basic entities relationship
 
+Basic Concepts
+--------------
+
 Administrative entities
 
 - **Dataspace** is a primary logical separation of data.
@@ -30,7 +34,7 @@ Administrative entities
   and uniquely identified by its name (within its own dataspace). Same YANG resources (source files) can be
   referenced by multiple schema sets from different dataspaces.
 
-- **Anchor** identifies the unique data set (data record) within a dataspace
+- **Anchor** identifies the unique data set (data record) within a dataspace.
 
   Anchor always references a schema set within same dataspace which describes a data model of associated data.
   Multiple anchors may reference same schema set. Anchor is uniquely identified by its name (within own dataspace).
@@ -50,4 +54,40 @@ Data
 
 Querying
 
-- **CPS Path** is used to query data nodes. The CPS Path is described in detail in :doc:`cps-path`.
+- **CPS Path** is used to query data nodes.
+.. toctree::
+   :maxdepth: 1
+
+   cps-path.rst
+
+.. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning
+.. _cps_ncmp_modelling:
+
+NCMP Modeling
+=============
+
+Data Model
+----------
+
+NCMP stores DMI-Plugin and CM Handle relations using a data model described as per this Yang module.
+
+:download:`DMI Yang Module <api/yang/dmiYangResource.yang>`
+
+Basic Concepts
+--------------
+
+- **CM-Handle** represents an instance a modeled Network Function(node) in ONAP.
+
+    These are stored as Anchors within CPS-Core.
+
+- **Datastores** represent different views of the cm data.
+
+    Datastores are defined for NCMP to access the CPS running or operational datastores. Currently supported datastores are:
+
+    +--------------------------------+-------------------------------------+-------------------------+
+    | Datastore                      | Configurations                      | Data access type        |
+    +================================+=====================================+=========================+
+    | Passthrough-operational        | config-true, config-false           | read-only               |
+    +--------------------------------+-------------------------------------+-------------------------+
+    | Passthrough-running            | config-true                         | read-write              |
+    +--------------------------------+-------------------------------------+-------------------------+