NONRTRIC - Implement DMaaP mediator producer service in Java
Adding API documentation
Signed-off-by: PatrikBuhr <patrik.buhr@est.tech>
Issue-ID: NONRTRIC-597
Change-Id: I0ab195525a878897fb5049cd471947e7b44f7d57
diff --git a/docs/api-docs.rst b/docs/api-docs.rst
index 660344f..0de1b91 100644
--- a/docs/api-docs.rst
+++ b/docs/api-docs.rst
@@ -21,6 +21,7 @@
* The A1 Policy Management Service
* The Information Coordinator Service
+* DMaaP Adaptor
* The Non-RT-RIC App Catalogue
* K8S Helm Chart LCM Manager (Initial) **<ToDo>**
@@ -42,6 +43,22 @@
"A1 Information Coordination Service API", ":download:`link <../information-coordinator-service/api/ics-api.json>`", ":download:`link <../information-coordinator-service/api/ics-api.yaml>`"
+DMaaP Adaptor
+=============
+
+The DMaaP Adaptor provides support for push delivery of any data received from DMaap or Kafka.
+
+See `DMaaP Adaptor API <./dmaap-adaptor-api.html>`_ for full details of the API.
+
+The API is also described in Swagger-JSON and YAML:
+
+
+.. csv-table::
+ :header: "API name", "|swagger-icon|", "|yaml-icon|"
+ :widths: 10,5, 5
+
+ "DMaaP Adaptor API", ":download:`link <../dmaap-adaptor-java/api/api.json>`", ":download:`link <../dmaap-adaptor-java/api/api.yaml>`"
+
Non-RT-RIC App Catalogue (Initial)
==================================
diff --git a/docs/conf.py b/docs/conf.py
index 20c71fc..c5e504d 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -9,7 +9,8 @@
'http://127.0.0.1.*',
'https://gerrit.o-ran-sc.org.*',
'./rac-api.html', #Generated file that doesn't exist at link check.
- './ics-api.html' #Generated file that doesn't exist at link check.
+ './ics-api.html', #Generated file that doesn't exist at link check.
+ './dmaap-adaptor-api.html' #Generated file that doesn't exist at link check.
]
extensions = ['sphinxcontrib.redoc', 'sphinx.ext.intersphinx',]
@@ -26,6 +27,12 @@
'page': 'ics-api',
'spec': '../information-coordinator-service/api/ics-api.json',
'embed': True,
+ },
+ {
+ 'name': 'DMaaP Adaptor API',
+ 'page': 'dmaap-adaptor-api',
+ 'spec': '../dmaap-adaptor-java/api/api.json',
+ 'embed': True,
}
]
diff --git a/docs/overview.rst b/docs/overview.rst
index e816975..3577e9c 100644
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -29,6 +29,7 @@
* Non-RT-RIC (Kong) Service Exposure Prototyping
* Initial Non-RT-RIC App Catalogue
* Near-RT-RIC A1 Simulator
+* DMaap Adaptor
The code base for "D" Release is in the `NONRTRIC <https://gerrit.o-ran-sc.org/r/admin/repos/nonrtric>`_, `NONRTRIC-ControlPanel <https://gerrit.o-ran-sc.org/r/admin/repos/portal/nonrtric-controlpanel>`_, and `Near-RT-RIC A1-Simulator <https://gerrit.o-ran-sc.org/r/admin/repos/sim/a1-interface>`_ , Gerrit source repositories (D Branch).
@@ -76,6 +77,10 @@
See also: `A1 Policy Management Service in ONAP <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_
+
+Implementation:
+* Implemented as a Java Spring Boot application
+
A1/SDNC Controller & A1 Adapter (Controller plugin)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Mediation point for A1 interface termination in SMO/NONRTRIC
@@ -90,8 +95,8 @@
See also: `A1 Adapter/Controller Functions in ONAP <https://wiki.onap.org/pages/viewpage.action?pageId=84672221>`_
-Information Job Coordination Service
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Information Coordination Service
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Coordinate/Register A1-EI Types, Producers, Consumers, and Jobs.
@@ -108,6 +113,20 @@
* After EI-type/Producer/Consumer/Job is successfully registered delivery/flow can happen directly between A1-EI Producers (in SMO/NONRTRIC domain) and A1-EI consumers (near-RT-RICs in RAN domain)
* *Being extended to coordinate non-A1 Information exchange between NONRTRIC Apps*
+
+Implementation:
+* Implemented as a Java Spring Boot application
+
+Dmaap Adapter
+~~~~~~~~~~~~~
+
+Is a generic information producer, which registeres itself as an information producer of information types (in Information Coordination Service).
+The information types are defined in a configuration file.
+Information jobs can retrieve data from DMaap or Kafka topics and push this to data consumers (accessing the ICS API).
+
+Implementation:
+* Implemented as a Java Spring Boot application
+
Non-RT-RIC (Spring Cloud) Service Gateway
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Support Apps to use A1 Services