Manage the HAProxy Enterprise service

This section describes how to manage the load balancer service on Linux.

Get the HAProxy Enterprise version Jump to heading #

To see the installed version of the software:

nix
/opt/hapee-3.1/sbin/hapee-lb version

nix
/opt/hapee-3.1/sbin/hapee-lb version

Start and stop the service Jump to heading #

HAProxy Enterprise runs as a service, which you can start or stop by calling systemctl:

Start the service:

nix
sudo systemctl start hapee-3.1-lb

nix
sudo systemctl start hapee-3.1-lb

Stop the service:

nix
sudo systemctl stop hapee-3.1-lb

nix
sudo systemctl stop hapee-3.1-lb

Use the systemctl status command to check whether the service is running:

nix
sudo systemctl status hapee-3.1-lb

nix
sudo systemctl status hapee-3.1-lb

output
text
hapee-3.1-lb.service - HAPEE Load Balancer
  Loaded: loaded (/lib/systemd/system/hapee-3.1-lb.service; enabled; vendor preset: enabled)
  Active: active (running) since Wed 2020-12-02 15:56:43 UTC; 1min 35s ago
  Main PID: 12977 (hapee-lb)
  Tasks: 3 (limit: 1152)
  CGroup: /system.slice/hapee-3.1-lb.service
          ├─12977 /opt/hapee-3.1/sbin/hapee-lb -Ws -f /etc/hapee-3.1/hapee-lb.cfg -p /ruhapee-3.1-lb.pid
          └─12992 /opt/hapee-3.1/sbin/hapee-lb -Ws -f /etc/hapee-3.1/hapee-lb.cfg -p /run/ hapee-3.1-lb.pid
Dec 02 15:56:43 lb1 systemd[1]: Starting HAPEE Load Balancer...
Dec 02 15:56:43 lb1 hapee-lb[12977]: [NOTICE] 336/155643 (12977) : New worker #1 (12992) forked
Dec 02 15:56:43 lb1 systemd[1]: Started HAPEE Load Balancer.

output
text
hapee-3.1-lb.service - HAPEE Load Balancer
  Loaded: loaded (/lib/systemd/system/hapee-3.1-lb.service; enabled; vendor preset: enabled)
  Active: active (running) since Wed 2020-12-02 15:56:43 UTC; 1min 35s ago
  Main PID: 12977 (hapee-lb)
  Tasks: 3 (limit: 1152)
  CGroup: /system.slice/hapee-3.1-lb.service
          ├─12977 /opt/hapee-3.1/sbin/hapee-lb -Ws -f /etc/hapee-3.1/hapee-lb.cfg -p /ruhapee-3.1-lb.pid
          └─12992 /opt/hapee-3.1/sbin/hapee-lb -Ws -f /etc/hapee-3.1/hapee-lb.cfg -p /run/ hapee-3.1-lb.pid
Dec 02 15:56:43 lb1 systemd[1]: Starting HAPEE Load Balancer...
Dec 02 15:56:43 lb1 hapee-lb[12977]: [NOTICE] 336/155643 (12977) : New worker #1 (12992) forked
Dec 02 15:56:43 lb1 systemd[1]: Started HAPEE Load Balancer.

Reload the configuration Jump to heading #

To reload the configuration without restarting the process, call systemctl reload:

nix
sudo systemctl reload hapee-3.1-lb

nix
sudo systemctl reload hapee-3.1-lb

This sends the SIGUSR2 signal, which causes the load balancer’s main process to re-execute itself. It reloads the configuration file and sends the SIGUSR1 signal to workers to perform a soft stop and create new workers. No connections will be dropped.

In versions prior to 2.6r1, you must add the expose-fd listeners parameter on the stats socket line in the global section of your configuration for this to work. Versions 2.6r1 and later do not require this.

haproxy
stats socket  /var/run/hapee-3.1/hapee-lb.sock user hapee-lb group hapee mode 660 level admin expose-fd listeners

haproxy
stats socket  /var/run/hapee-3.1/hapee-lb.sock user hapee-lb group hapee mode 660 level admin expose-fd listeners

More tuning options:

• Add hard-stop-after to your configuration to limit how long to wait for workers to finish active connections before forcing them to stop. It sets a maximum time to wait. You could use this to prevent long-running sessions from blocking the reload.
• Add grace to your configuration to pause for a period of time before initiating the soft stop of workers. During this delay, you could send a notification of the pending reload.

Validate the configuration file Jump to heading #

Use the hapee-lb program’s -c flag to validate the configuration file.

Depending on your version, the command’s output indicates that the file is valid in these ways:

• In version 2.8 and earlier, the command indicates a valid configuration by printing Configuration file is valid in addition to setting the zero return status.
• In version 2.9 and later, the command sets the zero return status for a valid configuration but does not display a message. To display the message, include the -V option on the command line.

Example:

nix
sudo /opt/hapee-3.1/sbin/hapee-lb -c -f /etc/hapee-3.1/hapee-lb.cfg -V

nix
sudo /opt/hapee-3.1/sbin/hapee-lb -c -f /etc/hapee-3.1/hapee-lb.cfg -V

Alerts and warnings that appear in the console output explain the errors encountered. An alert is a fatal condition and prohibits the service from starting. A warning indicates a condition that is not fatal now but may become fatal in a future release. Address all the errors until you receive the successful output: Configuration file is valid.