summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/ves-openapi-manager/architecture.rst
diff options
context:
space:
mode:
authorMichal Banka <michal.banka@nokia.com>2021-03-10 14:30:09 +0100
committerMichal Banka <michal.banka@nokia.com>2021-03-15 09:14:44 +0100
commit5fb2f1d247be63de9e567c2fa0da3d3f0f1b4601 (patch)
treec92ef21a3ee2cfda1cbebf57dd749aa1d4ed1539 /docs/sections/services/ves-openapi-manager/architecture.rst
parentbcbf98beec6118acad4584d99ebef900f386690b (diff)
Add ves-openapi-manager documentation
Signed-off-by: Michal Banka <michal.banka@nokia.com> Change-Id: I84294800070ddbec7bee1bc3ea4ac63df076cc53 Issue-ID: DCAEGEN2-2571
Diffstat (limited to 'docs/sections/services/ves-openapi-manager/architecture.rst')
-rw-r--r--docs/sections/services/ves-openapi-manager/architecture.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/sections/services/ves-openapi-manager/architecture.rst b/docs/sections/services/ves-openapi-manager/architecture.rst
new file mode 100644
index 00000000..2e4c4276
--- /dev/null
+++ b/docs/sections/services/ves-openapi-manager/architecture.rst
@@ -0,0 +1,30 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+.. _ves-openapi-manager-architecture:
+
+VES OpenAPI Manager architecture
+================================
+Functionalities of VES OpenAPI Manager require communication with other ONAP components. Because of that, SDC
+Distribution Client has been used as a library to achieve such a communication. There are two components required by
+application to work: SDC BE and Message Router. SDC Distribution Client provides communication with both of them when
+it's properly configured (for application configuration instruction refer to: :ref:`ves-openapi-manager-deployment` ).
+
+.. image:: resources/architecture.png
+
+
+.. _ves-openapi-manager-flow:
+
+VES OpenAPI Manager workflow
+----------------------------
+VES OpenAPI Manager workflow can be split into phases:
+
+1) Listening for Service Model distribution events
+2) Optional downloading of artifacts depending on Service Model contents. At least one Service Model resource must contain *VES_EVENT* type artifacts.
+3) Optional validation of artifacts depending on content of downloaded artifacts. Artifact must contain stndDefined events declaration.
+
+
+VES OpenAPI Manager workflow is presented on the diagram below.
+
+.. image:: resources/workflow.png
+