summaryrefslogtreecommitdiffstats
path: root/docs/architecture.rst
blob: f0b8745589646eac8d8ef46b11f895afa3df28db (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright (C) 2021-2024 Nordix Foundation
.. _architecture:

DMI-Plugin Architecture
#######################

.. toctree::
   :maxdepth: 1


High Level Component Definition and Architectural Relationships
===============================================================

The DMI-Plugin provides a gateway for registration and syncing of CM Handles within CPS.

.. image:: _static/cps-r9-ncmp-dmi-plugin-interface-diagram.png

API definitions
===============

The DMI-Plugin provides following interfaces.

.. list-table::
   :header-rows: 1

   * - Interface name
     - Interface definition
     - Interface capabilities
     - Protocol
   * - CPS-E-05
     - Provides external clients with  xNF data access and module information
     - - Create data
       - Delete data
       - Update data
       - Read data
       - Query data
       - Query module references
     - REST
   * - CPS-NCMP-I-01
     - DMI-Plugin Inventory
     - - Register Plug-in CM-Handles
       - Health Check API
     - REST
   * - DMI-I-01
     - Provides NCMP with  xNF data access and module information
     - - Create data
       - Delete data
       - Update data
       - Read data
       - Query data
       - Query module references
     - REST
   * - DMI-I-02
     - Provides support for Async Data Subjobs enabling CRUDAQ requests for the paths in the request using the ID of the producer registered by DMI. This enables subnetwork-wide requests
     - - Create data based on dataProducerId
       - Read data based on dataProducerId
       - Update data based on dataProducerId
       - Delete data based on dataProducerId
       - Perform action on data based on dataProducerId
       - Query data based on dataProducerId
     - REST

More details on the CPS interface CPS-E-05 which is responsible for the DMI-Plugin can be found on the :ref:`CPS Architecture page<onap-cps:architecture>`