[VES-OPENAPI] Update docs with kafka
[dcaegen2.git] / docs / sections / services / ves-openapi-manager / architecture.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 .. _ves-openapi-manager-architecture:
5
6 VES OpenAPI Manager architecture
7 ================================
8 Functionalities of VES OpenAPI Manager require communication with other ONAP components. Because of that, SDC
9 Distribution Client has been used as a library to achieve such a communication. There are two components required by
10 application to work: SDC BE and Kafka. SDC Distribution Client provides communication with both of them when
11 it's properly configured (for application configuration instruction refer to: :ref:`ves-openapi-manager-deployment` ).
12
13 .. image:: resources/architecture.png
14
15
16 .. _ves-openapi-manager-flow:
17
18 VES OpenAPI Manager workflow
19 ----------------------------
20 VES OpenAPI Manager workflow can be split into phases:
21
22 1) Listening for Service Model distribution events
23 2) Optional downloading of artifacts depending on Service Model contents. At least one Service Model resource must contain *VES_EVENT* type artifacts.
24 3) Optional validation of artifacts depending on content of downloaded artifacts. Artifact must contain stndDefined events declaration.
25
26
27 VES OpenAPI Manager workflow is presented on the diagram below.
28
29 .. image:: resources/workflow.png
30