Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 1 | .. This work is licensed under a Creative Commons Attribution 4.0 International License. |
| 2 | .. http://creativecommons.org/licenses/by/4.0 |
| 3 | .. Copyright (C) 2021 Pantheon.tech |
lukegleeson | de29474 | 2022-07-25 11:00:11 +0100 | [diff] [blame] | 4 | .. Modifications Copyright (C) 2021-2022 Nordix Foundation |
Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 5 | .. _modeling: |
| 6 | |
Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 7 | .. toctree:: |
| 8 | :maxdepth: 1 |
| 9 | |
lukegleeson | e1308ac | 2021-09-30 13:36:37 +0100 | [diff] [blame] | 10 | CPS Modeling |
| 11 | ############ |
| 12 | |
| 13 | CPS-Core Modeling |
| 14 | ================= |
| 15 | |
| 16 | Data Model |
| 17 | ---------- |
Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 18 | |
| 19 | .. image:: _static/cps-modeling-concepts.png |
| 20 | :alt: Basic entities relationship |
| 21 | |
lukegleeson | e1308ac | 2021-09-30 13:36:37 +0100 | [diff] [blame] | 22 | Basic Concepts |
| 23 | -------------- |
| 24 | |
Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 25 | Administrative entities |
| 26 | |
| 27 | - **Dataspace** is a primary logical separation of data. |
| 28 | |
| 29 | Any application can define its own dataspace to store the model(s) and data it owns. |
| 30 | Dataspace is uniquely identified by it's name. |
| 31 | |
| 32 | - **Schema Set** describes a data model(s). |
| 33 | |
| 34 | Schema Set holds reference(s) to single or multiple YANG modules. Schema Set belongs to dataspace |
| 35 | and uniquely identified by its name (within its own dataspace). Same YANG resources (source files) can be |
| 36 | referenced by multiple schema sets from different dataspaces. |
| 37 | |
lukegleeson | e1308ac | 2021-09-30 13:36:37 +0100 | [diff] [blame] | 38 | - **Anchor** identifies the unique data set (data record) within a dataspace. |
Ruslan Kashapov | 55dc654 | 2021-03-02 16:48:41 +0200 | [diff] [blame] | 39 | |
| 40 | Anchor always references a schema set within same dataspace which describes a data model of associated data. |
| 41 | Multiple anchors may reference same schema set. Anchor is uniquely identified by its name (within own dataspace). |
| 42 | |
| 43 | Data |
| 44 | |
| 45 | - **Data Node** represents a data fragment. |
| 46 | |
| 47 | Each data node can have zero or more descendants and together they form a data instance tree. |
| 48 | The data node tree belongs to an anchor. |
| 49 | |
| 50 | Data node is representing a data fragment described in a YANG model as a *container* and/or a *list*. |
| 51 | The data described as a *leaf* and/or a *leaf-list* are stored within a parent data node. |
| 52 | |
| 53 | The data node position within a tree is uniquely identified by the node's unique **xpath** which can be used |
| 54 | for partial data query. |
ToineSiebelink | 98c0787 | 2021-04-20 17:33:09 +0100 | [diff] [blame] | 55 | |
| 56 | Querying |
| 57 | |
lukegleeson | f027cfb | 2021-11-08 15:53:12 +0000 | [diff] [blame] | 58 | - **CPS Path** is used to query data nodes. |
| 59 | .. toctree:: |
| 60 | :maxdepth: 1 |
| 61 | |
| 62 | cps-path.rst |
lukegleeson | 209c385 | 2021-09-28 16:07:25 +0100 | [diff] [blame] | 63 | |
ToineSiebelink | 980089c | 2021-10-21 13:35:34 +0100 | [diff] [blame] | 64 | .. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning |
| 65 | .. _cps_ncmp_modelling: |
| 66 | |
lukegleeson | e1308ac | 2021-09-30 13:36:37 +0100 | [diff] [blame] | 67 | NCMP Modeling |
| 68 | ============= |
lukegleeson | 209c385 | 2021-09-28 16:07:25 +0100 | [diff] [blame] | 69 | |
lukegleeson | e1308ac | 2021-09-30 13:36:37 +0100 | [diff] [blame] | 70 | Data Model |
| 71 | ---------- |
lukegleeson | 209c385 | 2021-09-28 16:07:25 +0100 | [diff] [blame] | 72 | |
DylanB95EST | 3fcf869 | 2021-10-11 16:29:16 +0100 | [diff] [blame] | 73 | NCMP stores DMI-Plugin and CM Handle relations using a data model described as per this Yang module. |
lukegleeson | 209c385 | 2021-09-28 16:07:25 +0100 | [diff] [blame] | 74 | |
lukegleeson | de29474 | 2022-07-25 11:00:11 +0100 | [diff] [blame] | 75 | :download:`DMI Yang Module <api/yang/dmi-registry@2022-05-10.yang>` |
| 76 | |
| 77 | Note: Although additional-properties are present in the model of the dmi-registry, these are considered private metadata and as such are not queryable. |
lukegleeson | e1308ac | 2021-09-30 13:36:37 +0100 | [diff] [blame] | 78 | |
| 79 | Basic Concepts |
| 80 | -------------- |
| 81 | |
| 82 | - **CM-Handle** represents an instance a modeled Network Function(node) in ONAP. |
| 83 | |
| 84 | These are stored as Anchors within CPS-Core. |
| 85 | |
DylanB95EST | 5202945 | 2022-08-04 14:16:33 +0100 | [diff] [blame^] | 86 | - **CM-Handle States** are used to represent the potential states in which a CM-Handle can transition between. |
| 87 | |
| 88 | The 5 possible CM-Handle states are: ADVISED, READY, LOCKED, DELETING, DELETED |
| 89 | |
| 90 | **ADVISED** indicates that a CM-Handle has been registered successfully, and is waiting for the module synchronization process to sync the CM-Handle. |
| 91 | |
| 92 | **READY** indicates that the CM-Handle has been synced successfully. |
| 93 | |
| 94 | **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. |
| 95 | |
| 96 | **DELETING** indicates that the CM-Handle is currently being deleted. |
| 97 | |
| 98 | **DELETED** indicates that the CM-Handle has been deleted successfully. |
| 99 | |
bmiklos | e757875 | 2022-08-04 15:36:11 +0200 | [diff] [blame] | 100 | - **Data-sync state** is the state of the data synchronization process of the CM-Handle |
| 101 | |
| 102 | There are 3 possibles states: NONE_REQUESTED, UNSYNCHRONIZED, SYNCHRONIZED |
| 103 | |
| 104 | **NONE_REQUESTED** indicates that the data sync is not requested by the user |
| 105 | |
| 106 | **UNSYNCHRONIZED** indicates the cm-handle is waiting for the data sync watchdog operation to carry out the sync process |
| 107 | |
| 108 | **SYNCHRONIZED** indicates the watchdog process has finished the data synchronization successfully |
| 109 | |
lukegleeson | e1308ac | 2021-09-30 13:36:37 +0100 | [diff] [blame] | 110 | - **Datastores** represent different views of the cm data. |
| 111 | |
| 112 | Datastores are defined for NCMP to access the CPS running or operational datastores. Currently supported datastores are: |
| 113 | |
| 114 | +--------------------------------+-------------------------------------+-------------------------+ |
| 115 | | Datastore | Configurations | Data access type | |
| 116 | +================================+=====================================+=========================+ |
| 117 | | Passthrough-operational | config-true, config-false | read-only | |
| 118 | +--------------------------------+-------------------------------------+-------------------------+ |
| 119 | | Passthrough-running | config-true | read-write | |
ToineSiebelink | 980089c | 2021-10-21 13:35:34 +0100 | [diff] [blame] | 120 | +--------------------------------+-------------------------------------+-------------------------+ |
lukegleeson | de29474 | 2022-07-25 11:00:11 +0100 | [diff] [blame] | 121 | |
| 122 | Querying CM Handles |
| 123 | |
| 124 | - **CM Handle Searches Endpoints** are used to query CM Handles. |
| 125 | .. toctree:: |
| 126 | :maxdepth: 1 |
| 127 | |
| 128 | ncmp-cmhandle-querying.rst |