summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorefiacor <fiachra.corcoran@est.tech>2022-12-20 11:03:01 +0000
committerFiachra Corcoran <fiachra.corcoran@est.tech>2023-01-03 14:46:52 +0000
commit74d53a77e5d74c921cfbc034a01f2cbf08e102a4 (patch)
treec842a1b5566175eb4d0d10680f50552e1bf7930f /docs
parent9c1961ea905a619ed7c4c2c90ffa1eeda942c9ad (diff)
[VES-OPENAPI] Update docs with kafka
Signed-off-by: efiacor <fiachra.corcoran@est.tech> Change-Id: I0a96c14cb378e3a4a6e8eab83c95667b432a139c Issue-ID: DMAAP-1810
Diffstat (limited to 'docs')
-rw-r--r--docs/sections/services/ves-openapi-manager/architecture.rst2
-rw-r--r--docs/sections/services/ves-openapi-manager/deployment.rst6
-rw-r--r--docs/sections/services/ves-openapi-manager/resources/architecture.pngbin23024 -> 16810 bytes
3 files changed, 4 insertions, 4 deletions
diff --git a/docs/sections/services/ves-openapi-manager/architecture.rst b/docs/sections/services/ves-openapi-manager/architecture.rst
index 2e4c4276..47d036d4 100644
--- a/docs/sections/services/ves-openapi-manager/architecture.rst
+++ b/docs/sections/services/ves-openapi-manager/architecture.rst
@@ -7,7 +7,7 @@ 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
+application to work: SDC BE and Kafka. 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
diff --git a/docs/sections/services/ves-openapi-manager/deployment.rst b/docs/sections/services/ves-openapi-manager/deployment.rst
index fdec791a..e5797192 100644
--- a/docs/sections/services/ves-openapi-manager/deployment.rst
+++ b/docs/sections/services/ves-openapi-manager/deployment.rst
@@ -9,7 +9,7 @@ VES OpenAPI Manager is a simple Java application which can be started by using o
prerequisites to work correctly:
1) File with OpenAPI schemas mappings.
-2) Access to two ONAP services: SDC BE and Message Router.
+2) Access to two ONAP services: SDC BE and Kafka.
These prerequisites are met by default when using Helm charts created for VES OpenAPI Manager in OOM. It's described in
more detail in *Helm chart* section.
@@ -58,7 +58,7 @@ configured to deploy application with all prerequisites met. It achieves that by
1) Mounting ConfigMap with mapping file under */app/schema-map.json* path.
2) Proper setting environment variables to values described in section *Environment variables*. Mapping file path is set to point to mounted file and SDC BE URL is set to internal port available only from Kubernetes cluster.
-3) Setting Readiness check. It waits for other ONAP components to start: SDC BE, Message Router. VES OpenAPI Manager Pod will not start until they are not ready.
+3) Setting Readiness check. It waits for other ONAP components to start: SDC BE, Kafka. VES OpenAPI Manager Pod will not start until they are not ready.
Local deployment
----------------
@@ -66,4 +66,4 @@ It's possible to run VES OpenAPI Manager in local environment which connects to
requires exposing ports of some services on lab, creating local port tunneling and running VES OpenAPI Manager (using
docker-compose or IDE e.g. IntelliJ).
-It's described in more detail in the README in project repository (`README <https://github.com/onap/dcaegen2-platform-ves-openapi-manager/blob/master/README.md>`_). \ No newline at end of file
+It's described in more detail in the README in project repository (`README <https://github.com/onap/dcaegen2-platform-ves-openapi-manager/blob/master/README.md>`_).
diff --git a/docs/sections/services/ves-openapi-manager/resources/architecture.png b/docs/sections/services/ves-openapi-manager/resources/architecture.png
index 5df1198f..6e862e9e 100644
--- a/docs/sections/services/ves-openapi-manager/resources/architecture.png
+++ b/docs/sections/services/ves-openapi-manager/resources/architecture.png
Binary files differ