> For the complete documentation index, see [llms.txt](https://aviznetworks.gitbook.io/asn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://aviznetworks.gitbook.io/asn/deploying-asn/asn-visualization-integrated-installer.md).

# ASN Visualization Integrated Installer

## 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-kafka:8.1.1
2. cp-kafka-connect:8.1.1
3. elasticsearch:8.19.9
4. kibana:8.19.9

## Usage Instructions

### Installation 

Extract the package <kbd>tar -xvf asn-viz-packages.tar.gz</kbd>

Change to the extracted directory <kbd>cd asn-viz/</kbd>

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

<figure><img src="https://content.gitbook.com/content/IPuwYU8kWKXe85bX1sjR/blobs/IWkKGka6rQ5wOYlMJdlz/image.png" alt=""><figcaption></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/IPuwYU8kWKXe85bX1sjR/blobs/OpN2msIP5cRbSErOyf0F/image.png" alt=""><figcaption></figcaption></figure>

### 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.

### Credentials Management

* Credentials are displayed at the end of installation.

## Installation Process

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

### Infrastructure Setup

* Deploys Elasticsearch, Kibana, and Kafka Connect using Docker Compose.
* Configures security settings with password authentication.
* Sets up connectivity between components.

### Security Configuration

* Enables secure authentication for Elasticsearch.
* Creates and manages access credentials.
* Configures Kibana to authenticate with Elasticsearch.

### Data Pipeline Configuration

* Connects Kafka topics to Elasticsearch indices.
* Configures data transformation for visualization.

### Dashboard Deployment

* Imports pre-configured dashboards into Kibana.

## How does the script work?

The \`<kbd>run-asn-viz.sh</kbd>\` 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.

## Troubleshooting

### 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. <kbd>sudo docker ps -a</kbd>&#x20;
  2. <kbd>sudo docker stop $(sudo docker ps -q)</kbd>
  3. <kbd>sudo docker compose rm</kbd>
  4. <kbd>sudo docker rm $(sudo docker ps -aq)</kbd>
  5. <kbd>sudo docker ps -a</kbd>

### Dashboard Import Issues

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

### Connection Issues

* Ensure all services are running with \`sudo docker ps\`.

### 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

## Other Details

### 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.

### Accessing the Dashboard - Telco

* Open the Kibana URL displayed at the end of installation.
* Log in using the credentials provided.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXfwmzubpjMVfQW902FySZ7_jWgzhviTVjrbqhIDFCoTjsUnIFcZbIjGP_Ejq6OS7DNdV0k1IotJitX9RsLZct8ldD9YBJAQskTYLh4sdNB42TTe3Sqpml3SDRbrG1qW4FEewsc0?key=tymwpJRaQNIGYHHD0pfPgHxV" alt=""><figcaption></figcaption></figure>

Navigate to the Dashboard section to view the ASN data visualizations

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXfqHzpyEsMe5lAtSMKx3ke65Jr1cX43OBrgpO7Pq_ijwQwfufwV1vDHmxz9X2VuJc3YAzqszaPsj3XnBc3tzdMNA2PKFbqBnwVMI5CO9E0qf6l0J5RX2ke4dTeY_yUjTGBZz72Vbg?key=tymwpJRaQNIGYHHD0pfPgHxV" alt=""><figcaption></figcaption></figure>

* ASN-RADIUS-DASHBOARD
* ASN-TELCO-UPLANE-Dashboard
* ASN-TELCO-CONTROL

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXebyPlHnpkOj4QIXCkNDDR4viz2HskKWpEuwIIdd-LYC5eEDv6NKglFREgkUn7vegTNPQzh098akqPbZq6oX-Kd0QpUTfQ7Dqwd72bHj75C1CucCRJP7jFDv3X_1pXIM7-MDL8R?key=tymwpJRaQNIGYHHD0pfPgHxV" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXetXvMzORcfIeNta6dbmEqgvvhNdZMw0UP6RX1DqFmuB4aqn0cGBm1CahIp2HpzgfFbm6mlp1nOjUWwPeBUYtk6jMEWz4F3gVgR7RVmhsh22cWrFUxEsEPIn50nbAWfNHBpnOxXvQ?key=tymwpJRaQNIGYHHD0pfPgHxV" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXcocO-MavrufzsppUkc8GiJmjJmg9ETasWgvWe9pF9WbIryJGkKI_oULzYw6x1eCPJevOvAR2JSzM-GDb55BOyJLaSmntAz_YRaokXc54Ju81OjBSeTekkaw9RvOTS5xFvXqzTwxQ?key=tymwpJRaQNIGYHHD0pfPgHxV" alt=""><figcaption></figcaption></figure>

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXe-DIxbnQADZT82X-MEsoQi0wPcf1sQMUYTLHHYsIJAeH1m-NIf9DT9-_nc7zj7eOWm3R1ihRSM3EvZofl8wG7UtTc8OeS34Asmw8IDL7U-G41Q0XrzbphnDBBug2Cr9pTY9SNg?key=tymwpJRaQNIGYHHD0pfPgHxV" alt=""><figcaption></figcaption></figure>

### Credentials Management

* Credentials are displayed at the end of installation.

### Accessing the Dashboard - DC

* Open the Kibana URL displayed at the end of installation.
* Log in using the credentials provided.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXfV_eNXYVgXgINjl97RBzmOj1MS97xyp2VlPwtZrNVNygQooDKZ19FQhSyuOUMoU28VId_vY1KNFB9TZTMdZvt5gssjXn7B6zXQMIGVlHPZRZs4zXE-Hs9mGjfM_SlCwQIfqWzsfg?key=tymwpJRaQNIGYHHD0pfPgHxV" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXfh2FCTjA7v5eOQLLFkx-BDddCwLSpMeLjN1ixGdpOU_kxEK3bSkIxOt2Ppl8nOjpGz9fvsziP1K7sl43q1rXSKyiuiAZsXVepCNvoG8pIO-eck1aNQ005w0q_VfkrB0UYXjtQ4?key=tymwpJRaQNIGYHHD0pfPgHxV" alt=""><figcaption></figcaption></figure>

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXd9L3jH_zTNVXLfmLq6Y__B1A_7ht_032qDxm0vbV4Dyz0cs46GY_inS_RTKfGCBrNgQTVw0Tk0dIcU7QMDC9EAehPsv8Y3xF2HrznVptOd7OLuFclmFzlhQeUnyaZGQRO0S-knug?key=tymwpJRaQNIGYHHD0pfPgHxV" alt=""><figcaption></figcaption></figure>

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXcO04u3jFZFsFWD1W0MHNtZwdCuBv2K21FW5j0DD4uGlVsGrP4hvQw31fchR1dvrDSVTBQfuHNGNzPXGiEL5Ny6Q9gvvGGYgJhyBhjBKKLIBTqbLZDWdjNSPNy_l-ezbcAMH804?key=tymwpJRaQNIGYHHD0pfPgHxV" alt=""><figcaption></figcaption></figure>

Open the kafka UI URL displayed at the end of installation

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdKuxThLPc4IinfRKNwhI-Xt7Oi6Fsr910PbgCYNldgvl3AGkgeQzIP8XR8xDZNQXpCTnFKOQ5ye-moYtyj8Y1RaDR4MKQOyGRFh1Nmo7eKymxy8VDpWmCGAr3XQ3tlZUaoRKYU?key=tymwpJRaQNIGYHHD0pfPgHxV" alt=""><figcaption></figcaption></figure>

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

> Any existing dashboard ASN-DC-FTTH-Dashboard will be replaced