summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/datalake-handler/userguide.rst
diff options
context:
space:
mode:
authorVENKATESH KUMAR <vv770d@att.com>2020-11-12 15:00:02 -0500
committerVENKATESH KUMAR <vv770d@att.com>2020-11-12 22:30:51 -0500
commite21c848562599340a99fc216bdaae97686d92a72 (patch)
tree65a3446cccde840220e3e2be2b53ee16d0bad7b4 /docs/sections/services/datalake-handler/userguide.rst
parent2cf33d0d1cecad5a309d428aa44f7740ca48032e (diff)
DCAE doc cleanup warnings
Change-Id: I39daca57d4754abe0db56a7f85e7274a5f45ad74 Signed-off-by: VENKATESH KUMAR <vv770d@att.com> Issue-ID: DCAEGEN2-2141 Signed-off-by: VENKATESH KUMAR <vv770d@att.com>
Diffstat (limited to 'docs/sections/services/datalake-handler/userguide.rst')
-rw-r--r--docs/sections/services/datalake-handler/userguide.rst26
1 files changed, 17 insertions, 9 deletions
diff --git a/docs/sections/services/datalake-handler/userguide.rst b/docs/sections/services/datalake-handler/userguide.rst
index b3be9491..f1de54d0 100644
--- a/docs/sections/services/datalake-handler/userguide.rst
+++ b/docs/sections/services/datalake-handler/userguide.rst
@@ -1,8 +1,8 @@
Admin UI User Guide
----------------------
+-------------------
Introduction
-~~~~~~~~
+~~~~~~~~~~~~
DataLake Admin UI aims to provide a user-friendly dashboard to easily monitor and
manage DataLake configurations for the involved components, ONAP topics, databases,
and 3rd-party tools. Please refer to the link to access the Admin UI portal
@@ -10,8 +10,9 @@ via http://datalake-admin-ui:30479
DataLake Feeder Management
-******************
+**************************
.. image:: ./images/adminui-feeder.png
+
Click the "DataLake Feeder" on the menu bar, and the dashboard will show
the overview DataLake Feeder information, such as the numbers of topics.
Also, you can enable or disable DataLake Feeder process backend process
@@ -19,12 +20,14 @@ by using the toggle switch.
Kafka Management
-******************
+****************
.. image:: ./images/adminui-kafka.png
+
Click the "Kafka" on the menu bar, and it provides the kafka resource settings
including add, modify and delete in the page to fulfill your management demand.
.. image:: ./images/adminui-kafka-edit.png
+
You can modify the kafka resource via clicking the card,
and click the plus button to add a new Kafka resource.
Then, you will need to fill the required information such as identifying name,
@@ -32,11 +35,12 @@ message router address and zookeeper address, and so on to build it up.
Topics Management
-******************
+*****************
.. image:: ./images/adminui-topics.png
.. image:: ./images/adminui-topic-edit1.png
.. image:: ./images/adminui-topic-edit2.png
.. image:: ./images/adminui-topic-edit3.png
+
The Topic page lists down all the topics which you have been configured
by topic management. You can edit the topic setting via double click the specific row.
The setting includes DataLake feeder status - catch the topic or not,
@@ -45,37 +49,41 @@ And choose one or more Kafka items as topic resource
and define the databased to store topic info are necessary.
.. image:: ./images/adminui-topic-config.png
+
For the default configuration of Topics, you can click the "Default configurations" button
to do the setting. When you add a new topic, these configurations will be filled into the form automatically.
.. image:: ./images/adminui-topic-new.png
+
To add a new topic for the DataLake Feeder, you can click the "plus icon" button
to catch the data into the 3rd-party database.
Please be noted that only existing topics in the Kafka can be added.
Database Management
-******************
+*******************
.. image:: ./images/adminui-dbs.png
.. image:: ./images/adminui-dbs-edit.png
+
In the Database Management page, it allows you to add, modify and delete the database resources
where the message from topics will be stored.
DataLake supports a bunch of databases including Couchbase DB, Apache Druid, Elasticsearch, HDFS, and MongoDB.
3rd-Party Tools Management
-******************
+**************************
.. image:: ./images/adminui-tools.png
+
In the Tools page, it allows you to manage the resources of 3rd-party tools for data visualization.
Currently, DataLake supports two Tools which are Kibana and Apache Superset.
3rd-Party Design Tools Management
-******************
+*********************************
.. image:: ./images/adminui-design.png
.. image:: ./images/adminui-design-edit.png
+
After setting up the 3rd-party tools, you can import the template as the JSON, YAML or other formats
for data exploration, data visualization and dashboarding. DataLake supports Kibana dashboarding,
Kibana searching, Kibana visualization, Elasticsearch field mapping template,
and Apache Druid Kafka indexing service.
-