summaryrefslogtreecommitdiffstats
path: root/docs/architecture.rst
diff options
context:
space:
mode:
authorNiamh Core <niamh.core@est.tech>2021-09-14 14:48:01 +0000
committerGerrit Code Review <gerrit@onap.org>2021-09-14 14:48:01 +0000
commita73d90d02462ec0b09402917102dd2be8cd59df9 (patch)
treef79bc2a7641a52859084dbdcd0c632539e203f9d /docs/architecture.rst
parent1c9896a1905584150a720d14d745762f1014315c (diff)
parent3d1579cb8cfe7fe924181bc3e02c570dca6ae081 (diff)
Merge "Create preliminary documentation for ONAP DMI-Plugin"
Diffstat (limited to 'docs/architecture.rst')
-rw-r--r--docs/architecture.rst40
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`.