HAProxy Enterprise Documentation 2.4r1

Install HAProxy Enterprise as a Docker container

The HAProxy Enterprise Docker image lets you run the load balancer as a container.

Install the HAProxy Enterprise Docker container

The haproxy-enterprise Docker image hosts HAProxy Enterprise and the HAProxy Data Plane API. Follow these steps to install it:

  1. Log into the hapee-registry.haproxy.com Docker registry using your HAProxy Enterprise license key as both the username and password. If you do not have a key, get one by registering and requesting a free trial of HAProxy Enterprise at https://www.haproxy.com/downloads/hapee-trial/.

    $ sudo docker login https://hapee-registry.haproxy.com
  2. Pull the HAProxy Enterprise image.

    $ sudo docker pull hapee-registry.haproxy.com/haproxy-enterprise:2.4r1
  3. Create an HAProxy Enterprise configuration file (i.e. hapee-lb.cfg) that defines your load balancer settings.

  4. Start the Docker container, referencing the directory containing your configuration file as a volume by using the -v flag.

    $ sudo docker run \
        --name hapee-2.4 \
        -d \
        -p 80:80 \
        -p 443:443 \
        -p 5555:5555 \
        -v $(pwd):/etc/hapee-2.4  \
        --restart=unless-stopped \

Access the Data Plane API

The Data Plane API listens at port 5555. However, you must retrieve the Basic authentication credentials to access it.

  1. Use the following command to read the username and password from the Data Plane API configuration file:

    $ sudo docker exec -it hapee-2.4 grep user: -A3 /etc/hapee-extras/dataplaneapi.yml
    - insecure: true
      password: v7xkLr4Z4Qlc
      name: admin

    Then you can verify that the API is working by calling the info function. In the example below, we use the username and password that we retrieved during the last step:

    $ curl -X GET --user admin:v7xkLr4Z4Qlc http://localhost:5555/v2/info
    {"api":{"build_date":"2021-06-01T21:18:15.000Z","version":"v2.3.2-ee2 8fdcfba"},"system":{}}

Reload the services

When you change your hapee-lb.cfg configuration file, you will need to reload the service for the changes to take effect. We use s6-overlay to run HAProxy Enterprise and the HAProxy Data Plane API as services.

  1. Make sure that the following line is included in the global section of your HAProxy Enterprise configuration file. It ensures that you can perform a hitless reload, which means no traffic is dropped.

       stats socket /var/run/hapee-2.4/hapee-lb.sock user hapee-lb group hapee mode 660 level admin expose-fd listeners
  2. Reload the HAProxy Enterprise process with this command:

    $ sudo docker exec hapee-2.4 s6-svc -2 /var/run/s6/services/haproxy

    You can also perform a hard restart by using this command:

    $ docker exec hapee-2.4 s6-svc -t /var/run/s6/services/haproxy

    To restart the Data Plane API, use this command:

    $ sudo docker exec hapee-2.4 s6-svc -t /var/run/s6/services/dataplaneapi

Installing with a custom Docker file

To install a modified HAProxy Enterprise environment, create a custom Docker file. Specify the desired HAProxy Enterprise base image as in the following example, which specifies version 2.4r1:

FROM hapee-registry.haproxy.com/haproxy-enterprise:2.4r1

Then add any further Dockerfile commands as needed.

The following example Dockerfile builds a HAProxy Enterprise version 2.4r1 image that includes a custom set of tools. The custom tool installation script, install_mytools-4.3.sh, must reside in the current directory.

FROM hapee-registry.haproxy.com/haproxy-enterprise:2.4r1

# install internal tools
ARG mytools_version="4.3"
COPY install_mytools-"$mytools_version".sh .
RUN  /tmp/install_mytools-"$mytools_version".sh

Next up