HAProxy Enterprise Documentation 2.0r1

Installation

The Real-Time Dashboard is a web application that collects live metrics from your load balancers and displays them. You can also perform actions like disabling servers.

  1. Use your system's package manager to install the dashboard package onto your HAProxy Enterprise server:

    $ # On Debian/Ubuntu
    $ sudo apt-get install hapee-2.0r1-lb-dashboard
    $ # On CentOS/RedHat/Oracle
    $ sudo yum install hapee-2.0r1-lb-dashboard
    $ # On SUSE
    $ sudo zypper install hapee-2.0r1-lb-dashboard
    $ # On FreeBSD
    $ sudo pkg install hapee-2.0r1-lb-dashboard

    This installs the following components:

    Component

    Description

    /etc/hapee-2.0/dashboard-module.cfg

    Configuration that exposes a new endpoint within HAProxy Enterprise at port 9022. When a request arrives at this port, HAProxy Enterprise dispatches it to a Lua module that returns statistics for the dashboard to collect.

    /opt/hapee-2.0/dashboard/dashboard-module/

    Folder that contains the Lua module that generates HAProxy Enterprise statistics. It contains:

    • dashboard.luac - Lua module for statistics.

    • dashboard-config.lua - Configuration file that defines a cluster of HAProxy Enterprise instances from which to gather statistics.

    /opt/hapee-2.0/dashboard/dashboard/

    Folder that contains the web application for the dashboard.

  2. Copy the folder /opt/hapee-2.0/dashboard/dashboard to your web server to host it on an IP address and port of your choosing. Consult your web server's instructions for hosting static files.

    Note

    Because the dashboard starts without any data, you can use the one we host on haproxy.com. Go to https://dashboard.haproxy.com to access your hosted dashboard.

    To give you an example of hosting the dashboard yourself, you can use the following Python commands to start a rudimentary web server directly from the dashboard directory:

    $ cd /opt/hapee-2.0/dashboard/dashboard
    $ python3 -m http.server 8000

    Open the Real-Time Dashboard at port 8000 using your web browser.

    [Real-Time Dashboard]
  3. You must configure the dashboard to fetch metrics data from HAProxy Enterprise. You have two options:

    • Configure the Lua module

    • Configure the Dashboard Gateway


Next up

Lua Module