summaryrefslogtreecommitdiffstats
path: root/docs/modeling.rst
diff options
context:
space:
mode:
authorToine Siebelink <toine.siebelink@est.tech>2021-10-11 09:44:11 +0000
committerGerrit Code Review <gerrit@onap.org>2021-10-11 09:44:11 +0000
commit915960f4372a433ed2aea792b2a09c3f2831b9d0 (patch)
tree66dd822846af9b967bc3a4dc2812662ef863fb7b /docs/modeling.rst
parent66b598a4243bb702059902af2903d1c3da01d5fa (diff)
parente1308ace3df3de1efc204db1e9eac05a72b75c22 (diff)
Merge "Update Design & Modeling Sections"
Diffstat (limited to 'docs/modeling.rst')
-rw-r--r--docs/modeling.rst50
1 files changed, 37 insertions, 13 deletions
diff --git a/docs/modeling.rst b/docs/modeling.rst
index 22c4b0ba3..863e93263 100644
--- 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
+CPS-Core Modeling
+=================
-.. toctree::
- :maxdepth: 1
-
-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,13 +54,33 @@ Data
Querying
-- **CPS Path** is used to query data nodes. The CPS Path is described in detail in the :doc:`cps-path` sub-page.
+- **CPS Path** is used to query data nodes. The CPS Path is described in detail in :doc:`cps-path`.
-CPS Path
-========
+NCMP Modeling
+=============
-.. toctree::
- :maxdepth: 1
+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.
- cps-path.rst
+ 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 |
+ +--------------------------------+-------------------------------------+-------------------------+ \ No newline at end of file