INSTALLATION

# INSTALLATION


## Dependecies
    Grafana (v5.0.3)
    Kytos
    Kytos apps
        amlight/flow_stats:0.1
        amlight/coloring:0.1
        amlight/sdntrace:0.2
        amlight/sdntrace_cp:latest
        kytos/flow_manager:2.2.0
        kytos/of_core:1.2.0
        kytos/of_l2ls:1.1.0
        kytos/of_lldp:0.1.1
        kytos/of_stats:1.1.0
        kytos/pathfinder:2.1.1
        kytos/storehouse:1.1.0
        kytos/topology:3.2.0


## Grafana.
This app was tested using Grafana v5.0.3 in Linux environment.
    http://docs.grafana.org/installation/

You can run the Dockerfile and jump to the section "Enabling the grafana app"


## Install application dependencies
To compile the application you have to install Node.js
If you do not have Node.js installed, check the website for more information of how to install in you operational system.

    https://nodejs.org/en/download/package-manager/

Install all npm dependencies
    npm install


## Compile the application

Install the grunt client to run in command line.
    npm install -g grunt-cli

Compile the javascript, running grunt.
    grunt

Grunt command will create a 'dist' directory.


## Install the grafana app

One way to install a custom application is to copy the code to Grafana plugin directory.
The default location is:
    /var/lib/grafana/plugins/

Create an app directory (ex: grafana-amlight-app-sdnlg) inside the plugin directory.
Copy the 'dist' directory generated by Grunt.

Restart the Grafana server.
    service grafana-server stop
    service grafana-server start


## Enabling the grafana app

Access the grafana. The default port is 3000
    http://localhost:3000/

You have to login. The default authorization is:
    user: admin
    password: admin

Access the grafana plugin page.
    http://localhost:3000/plugins

You can find SDN LG app installed in the plugin tab, but you still need to enable it.

Click the SDN LG app. In the 'Config' tab you must click the 'Enable' button.


## Configuring the SDN LG app

In the same tab 'Config' that you enabled the SDN LG app, you have to configure the address of Kytos API Server.
Ex:
    http://localhost:8181

## Import a example dashboard

The SDN LG comes with an example dashboard.
In the plugin configuration page, enter the 'Dashboards' tab.
You can import the dashboard and change it as you like.