diff options
Diffstat (limited to 'docs/modeling.rst')
| -rw-r--r-- | docs/modeling.rst | 37 |
1 files changed, 36 insertions, 1 deletions
diff --git a/docs/modeling.rst b/docs/modeling.rst index b750c6d5b3..7cc2c4ce6a 100644 --- a/docs/modeling.rst +++ b/docs/modeling.rst @@ -1,6 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. Copyright (C) 2021 Pantheon.tech +.. Modifications Copyright (C) 2021-2022 Nordix Foundation .. _modeling: .. toctree:: @@ -71,7 +72,9 @@ 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>` +:download:`DMI Yang Module <api/yang/dmi-registry@2022-05-10.yang>` + +Note: Although additional-properties are present in the model of the dmi-registry, these are considered private metadata and as such are not queryable. Basic Concepts -------------- @@ -80,6 +83,30 @@ Basic Concepts These are stored as Anchors within CPS-Core. + - **CM-Handle States** are used to represent the potential states in which a CM-Handle can transition between. + + The 5 possible CM-Handle states are: ADVISED, READY, LOCKED, DELETING, DELETED + + **ADVISED** indicates that a CM-Handle has been registered successfully, and is waiting for the module synchronization process to sync the CM-Handle. + + **READY** indicates that the CM-Handle has been synced successfully. + + **LOCKED** indicates that the CM-Handle has not synced successfully. A retry mechanism within CPS will set the state back to ADVISED after a set time. + + **DELETING** indicates that the CM-Handle is currently being deleted. + + **DELETED** indicates that the CM-Handle has been deleted successfully. + + - **Data-sync state** is the state of the data synchronization process of the CM-Handle + + There are 3 possibles states: NONE_REQUESTED, UNSYNCHRONIZED, SYNCHRONIZED + + **NONE_REQUESTED** indicates that the data sync is not requested by the user + + **UNSYNCHRONIZED** indicates the cm-handle is waiting for the data sync watchdog operation to carry out the sync process + + **SYNCHRONIZED** indicates the watchdog process has finished the data synchronization successfully + - **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: @@ -91,3 +118,11 @@ Basic Concepts +--------------------------------+-------------------------------------+-------------------------+ | Passthrough-running | config-true | read-write | +--------------------------------+-------------------------------------+-------------------------+ + +Querying CM Handles + +- **CM Handle Searches Endpoints** are used to query CM Handles. +.. toctree:: + :maxdepth: 1 + + ncmp-cmhandle-querying.rst
\ No newline at end of file |