diff options
| author |   shivasubedi <shiva.subedi@est.tech> | 2021-09-13 16:43:20 +0100 |
|---|---|---|
| committer | shivasubedi <shiva.subedi@est.tech> | 2021-09-14 13:00:15 +0100 |
| commit | 3d1579cb8cfe7fe924181bc3e02c570dca6ae081 (patch) | |
| tree | 83c6113b7a180c1376174ec3fae4b90b7619d2a6 /docs/architecture.rst | |
| parent | f5de1ae2fe4b092d76c39a995d187cc509722c12 (diff) | |
Create preliminary documentation for ONAP DMI-Plugin
Create Preliminary documentation for Istanbul release
of the DMI Plugin.
Added new plugins in POM to generate swagger doc for design page.
Added icons from Cps-Core, along with latest conf.py file from
http://gerrit.onap.org/r/doc
Issue-ID: CPS-625
Change-Id: I30582de9b07e93c1c2ecc18003ee6882994690d8
Signed-off-by: DylanB95EST <dylan.byrne@est.tech>
Signed-off-by: shivasubedi <shiva.subedi@est.tech>
Diffstat (limited to 'docs/architecture.rst')
| -rw-r--r-- | docs/architecture.rst | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst new file mode 100644 index 00000000..65125764 --- /dev/null +++ b/docs/architecture.rst @@ -0,0 +1,40 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2021 Nordix Foundation +.. _architecture: + +DMI Plugin Architecture +####################### + +.. warning:: draft + +.. toctree:: + :maxdepth: 1 + + +High Level Component Definition and Architectural Relationships +=============================================================== + +The DMI plugin provides a gateway for registration of CM Handles within CPS + +Project implementation proposal page describing scope is here: +`CPS-390 Spike: Define and Agree DMI Plugin REST Interface <https://wiki.onap.org/display/DW/CPS-390+Spike%3A+Define+and+Agree+DMI+Plugin+REST+Interface>`_ + +This page reflects the state for Istanbul-R9 release. + +.. image:: _static/dmi-plugin-r9-arch-diagram.PNG + +API definitions +=============== + +The DMI plugin provides following interfaces. + +.. list-table:: + :header-rows: 0 + + * - Interface name + - Interface definition + - Interface capabilities + - Protocol + +The DMI plugin Basic Concepts are described in :doc:`modeling`. |