search

ASN Visualization Integrated Installer

hashtag
Overview

This document describes the integration of Kibana and Elasticsearch into the ASN installation, providing visualisation capabilities for ASN data.

ASN uses below version from R2.3 release onwards.

  1. cp-zookeeper:7.9.4

  2. cp-kafka:7.9.4

  3. cp-kafka-connect:7.9.4

  4. elasticsearch:8.11.1

  5. kibana:8.11.1

hashtag
Usage Instructions

hashtag
Installation

Extract the package tar -xvf asn-viz-packages.tar.gz

Change to the extracted directory cd asn-viz/

Execute the asn package script : sudo ./run-asn-viz.sh

hashtag
Accessing the Dashboard

  • Open the Kibana URL displayed at the end of installation.

  • Log in using the credentials provided.

  • Navigate to the Dashboard section to view the ASN data visualizations.

hashtag
Credentials Management

  • Credentials are displayed at the end of installation.

hashtag
Installation Process

The visualization stack is deployed after the standard ASN installation. The installation script performs these key functions:

hashtag
Infrastructure Setup

  • Deploys Elasticsearch, Kibana, and Kafka Connect using Docker Compose.

  • Configures security settings with password authentication.

  • Sets up connectivity between components.

hashtag
Security Configuration

  • Enables secure authentication for Elasticsearch.

  • Creates and manages access credentials.

  • Configures Kibana to authenticate with Elasticsearch.

hashtag
Data Pipeline Configuration

  • Connects Kafka topics to Elasticsearch indices.

  • Configures data transformation for visualization.

hashtag
Dashboard Deployment

  • Imports pre-configured dashboards into Kibana.

hashtag
How does the script work?

The `run-asn-viz.sh` script performs the following steps:

  • Validates the presence of required files.

  • Detects the system IP address for proper configuration.

  • Updates Docker Compose configuration (with system ip).

  • Extracts and installs the Kafka-Elasticsearch connector in the /etc directory.

  • Starts the visualization stack containers in the correct order (zookeper > kafka > all containers).

  • Sets up secure passwords for Elasticsearch users (uses elastic search reset commands to generate passwords).

  • Configures Kibana to use these credentials (updates required .yml file in the kibana container).

  • Updates the Kafka-Elasticsearch connector configuration (IP changes to system ip in the conn script along with the authentication details before calling the curl commands).

  • Imports the pre-configured dashboard (uses curl command to save object in the Stack Management of kibana).

  • Outputs access information including URLs and credentials.

hashtag
Troubleshooting

hashtag
Kibana page troubleshooting

  • Execute “sudo docker compose down” and execute the install script, this is the case where already the containers are up and installation script needs to be executed

  • Steps to check docker status if its already running,

    1. sudo docker ps -a

    2. sudo docker stop $(sudo docker ps -q)

    3. sudo docker compose rm

    4. sudo docker rm $(sudo docker ps -aq)

    5. sudo docker ps -a

hashtag
Dashboard Import Issues

  • If dashboard import fails during installation, manually import using the command shown at the end of installation output.

hashtag
Connection Issues

  • Ensure all services are running with `sudo docker ps`.

hashtag
Authentication Problems

  • Verify the credentials in the Kibana configuration. It is suggested to use the elastic user and the corresponding password to login to the kibana

hashtag
Other Details

hashtag
Data Flow

  • Kafka topics → Kafka Connect → Elasticsearch → Kibana

This integration enhances the ASN platform with visualization capabilities while maintaining a simple shell script based deployment process.

hashtag
Accessing the Dashboard - Telco

  • Open the Kibana URL displayed at the end of installation.

  • Log in using the credentials provided.

Navigate to the Dashboard section to view the ASN data visualizations

  • ASN-RADIUS-DASHBOARD

  • ASN-TELCO-UPLANE-Dashboard

  • ASN-TELCO-CONTROL

  • Open the kafka UI URL displayed at the end of installation

Navigate to the Topics section and click on the overview to get kafka statistics information

hashtag
Credentials Management

  • Credentials are displayed at the end of installation.

hashtag
Accessing the Dashboard — DC

  • Open the Kibana URL displayed at the end of installation.

  • Log in using the credentials provided.

Navigate to the Dashboard section to view the ASN data visualizations.

Open the kafka UI URL displayed at the end of installation

Navigate to the Topics section and click on the overview to get kafka statistics information

Note - Existing dashboard ASN-DC-FTTH-Dashboard will be replaced

PreviousASN Package InstallationNextDownloads

Last updated