docs/sections/services/datalake-handler/userguide.rst

   1 .. This work is licensed under a
   2    Creative Commons Attribution 4.0 International License.
   3    http://creativecommons.org/licenses/by/4.0
   4
   5 Admin UI User Guide
   6 -------------------
   7
   8 Introduction
   9 ~~~~~~~~~~~~
  10 DataLake Admin UI aims to provide a user-friendly dashboard to easily monitor and
  11 manage DataLake configurations for the involved components, ONAP topics, databases,
  12 and 3rd-party tools. Please refer to the link to access the Admin UI portal
  13 via http://datalake-admin-ui:30479
  14
  15
  16 DataLake Feeder Management
  17 **************************
  18 .. image:: ./images/adminui-feeder.png
  19
  20 Click the "DataLake Feeder" on the menu bar, and the dashboard will show
  21 the overview DataLake Feeder information, such as the numbers of topics.
  22 Also, you can enable or disable DataLake Feeder process backend process
  23 by using the toggle switch.
  24
  25
  26 Kafka Management
  27 ****************
  28 .. image:: ./images/adminui-kafka.png
  29
  30 Click the "Kafka" on the menu bar, and it provides the kafka resource settings
  31 including add, modify and delete in the page to fulfill your management demand.
  32
  33 .. image:: ./images/adminui-kafka-edit.png
  34
  35 You can modify the kafka resource via clicking the card,
  36 and click the plus button to add a new Kafka resource.
  37 Then, you will need to fill the required information such as identifying name,
  38 message router address and zookeeper address, and so on to build it up.
  39
  40
  41 Topics Management
  42 *****************
  43 .. image:: ./images/adminui-topics.png
  44 .. image:: ./images/adminui-topic-edit1.png
  45 .. image:: ./images/adminui-topic-edit2.png
  46 .. image:: ./images/adminui-topic-edit3.png
  47
  48 The Topic page lists down all the topics which you have been configured
  49 by topic management. You can edit the topic setting via double click the specific row.
  50 The setting includes DataLake feeder status - catch the topic or not,
  51 data format, and the numbers of time to live for the topic.
  52 And choose one or more Kafka items as topic resource
  53 and define the databased to store topic info are necessary.
  54
  55 .. image:: ./images/adminui-topic-config.png
  56
  57 For the default configuration of Topics, you can click the "Default configurations" button
  58 to do the setting. When you add a new topic, these configurations will be filled into the form automatically.
  59
  60 .. image:: ./images/adminui-topic-new.png
  61
  62 To add a new topic for the DataLake Feeder, you can click the "plus icon" button
  63 to catch the data into the 3rd-party database.
  64 Please be noted that only existing topics in the Kafka can be added.
  65
  66
  67 Database Management
  68 *******************
  69 .. image:: ./images/adminui-dbs.png
  70 .. image:: ./images/adminui-dbs-edit.png
  71
  72 In the Database Management page, it allows you to add, modify and delete the database resources
  73 where the message from topics will be stored.
  74 DataLake supports a bunch of databases including Couchbase DB, Apache Druid, Elasticsearch, HDFS, and MongoDB.
  75
  76
  77 3rd-Party Tools Management
  78 **************************
  79 .. image:: ./images/adminui-tools.png
  80
  81 In the Tools page, it allows you to manage the resources of 3rd-party tools for data visualization.
  82 Currently, DataLake supports two Tools which are Kibana and Apache Superset.
  83
  84
  85 3rd-Party Design Tools Management
  86 *********************************
  87 .. image:: ./images/adminui-design.png
  88 .. image:: ./images/adminui-design-edit.png
  89
  90 After setting up the 3rd-party tools, you can import the template as the JSON, YAML or other formats
  91 for data exploration, data visualization and dashboarding. DataLake supports Kibana dashboarding,
  92 Kibana searching, Kibana visualization, Elasticsearch field mapping template,
  93 and Apache Druid Kafka indexing service.