Reporting Deployment

Introduction

There are two models of generating Reporting and visualizing dashboards in OpenG2P currently. One is through Apache Superset (which performs direct SQL queries on the Database to generate reports). Second is through reporting framework, extended from MOSIP (which replicates all the data into OpenSearch in real-time). Weigh the pros and cons of both approaches here, before choosing one model.

TODO

Installation of Apache Superset

Prerequisites

• PostgreSQL

• Keycloak for Authentication and Sign-in to OpenSearch Dashboards

Installation

• Clone the https://github.com/openg2p/openg2p-deployment repo and navigate to kubernetes/superset directory.

• Run:

  SANDBOX_HOSTNAME=openg2p.sandbox.net \
      ./install.sh

Post-installation

After installation is successful, Superset can be accessed at https://superset.openg2p.sandbox.net, depending on the hostname given above.

Import pre-configured dashboards via Superet's console. During import provide password postgres user.

Follow the instructions given here to install pre-configured dashboards.

Installation of Reporting Framework

Prerequisites

• PostgreSQL
• Kafka
• Keycloak for Authentication and Sign-in to OpenSearch Dashboards
• OpenSearch

Installation

• Clone the https://github.com/openg2p/openg2p-reporting repository, and navigate to scripts folder.
• Run:

  SANDBOX_HOSTNAME=openg2p.sandbox.net \
      ./install.sh

Post-installation

• Import Sample Dashboards from the dashboards folder into OpenSearch Dashboards through UI.