X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fmodeling.rst;h=b750c6d5b30f4263d42b6856be51bd323b78fa51;hb=165e3b8bcc492ebe31431f30c14d5dc98bb7f18e;hp=4e46e71b7a082d8e6a7bf6318afb2a6a99a3df11;hpb=44beaa34486d0624175c42cc3899a0b53befd9a8;p=cps.git diff --git a/docs/modeling.rst b/docs/modeling.rst index 4e46e71b7..b750c6d5b 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 - -.. 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 ` + +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 | + +--------------------------------+-------------------------------------+-------------------------+