From 64d6e0567a1105155ebd43bf412342f51dc4ea43 Mon Sep 17 00:00:00 2001 From: "Christopher Lott (cl778h)" Date: Mon, 5 Feb 2018 08:49:03 -0500 Subject: RST docs for DMaaP BC Web Application Long-overdue push of docs that were lingering in ATT codecloud. Issue-ID: PORTAL-150 Change-Id: I86e57f6f9841f36e6a5544e8c05897c52cb190de Signed-off-by: Christopher Lott (cl778h) --- docs/overview.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docs/overview.rst (limited to 'docs/overview.rst') diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100644 index 0000000..3bbcaf6 --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,20 @@ +======== +Overview +======== + +This is the Data Movement as a Platform (DMaaP) Bus Controller web application for ONAP. + +The DMaaP Bus Controller web application provides a front-end GUI to a subset of +the OpenDCAE DMaaP Bus Controller API. The GUI offers a user-friendly way for DMaaP +administrators to add, modify and remove Data Router feeds (transfers of large +file-based data sets) and Message Router topics (low-latency transfers of small +messages). Users can view all feeds and topics; add and remove feed publishers; +add and remove feed subscribers; and add and remove topic clients. + +The Data Bus Controller web application is essentially a proxy that passes thru +all requests to the DMaaP bus controller's REST API and displays the results. +All data is stored in the DMaaP bus controller back-end; the application stores no +data on feeds or topics. The application only stores user-entered access profiles. + +This application is based on the ONAP Portal SDK. Use Apache Maven to build and package +this webapp for deployment. See the deployment guide for more details. -- cgit 1.2.3-korg