Pre-upgrade checklist

Use this checklist before upgrading any version of HAProxy Enterprise. Complete every item before proceeding.

Review documentation Jump to heading #

• Read the release notes for the target version (for example, check for new module changes, deprecated directives, or default behavior changes).
• Confirm the currently installed version.
• Verify that your OS version is supported by the target HAProxy Enterprise version.
• If HAProxy Enterprise is managed by HAProxy Fusion Control Plane, follow the upgrade node documentation before directing production traffic.

Hardware and OS requirements Jump to heading #

• Confirm the server meets the minimum hardware requirements for your expected traffic load.
• Verify that your OS version is supported by the target HAProxy Enterprise version.
• Obtain and record your HAProxy Enterprise license keys or subscription credentials required for the package repository.
• Note that if installing manually, the installation procedure has instructions for configuring your package manager with the correct HAProxy Enterprise repository for the target version.

Validate the existing configuration Jump to heading #

• Confirm the current configuration is valid and the process is healthy.

  Run a configuration syntax check:

  Configuration syntax check

  Configuration syntax check3.3r13.2r13.0r12.8r12.6r1

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

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

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

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

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

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

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

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

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

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

  Confirm HAProxy Enterprise is currently running and healthy:

  Check service status

  Check service status3.3r13.2r13.0r12.8r12.6r1

  nix
  sudo systemctl status hapee-3.3-lb

  nix
  sudo systemctl status hapee-3.3-lb

  nix
  sudo systemctl status hapee-3.2-lb

  nix
  sudo systemctl status hapee-3.2-lb

  nix
  sudo systemctl status hapee-3.0-lb

  nix
  sudo systemctl status hapee-3.0-lb

  nix
  sudo systemctl status hapee-2.8-lb

  nix
  sudo systemctl status hapee-2.8-lb

  nix
  sudo systemctl status hapee-2.6-lb

  nix
  sudo systemctl status hapee-2.6-lb

• Review logs for any existing errors or warnings:

  Review logs

  Review logs3.3r13.2r13.0r12.8r12.6r1

  nix
  sudo journalctl -u hapee-3.3-lb --since "1 hour ago"

  nix
  sudo journalctl -u hapee-3.3-lb --since "1 hour ago"

  nix
  sudo journalctl -u hapee-3.2-lb --since "1 hour ago"

  nix
  sudo journalctl -u hapee-3.2-lb --since "1 hour ago"

  nix
  sudo journalctl -u hapee-3.0-lb --since "1 hour ago"

  nix
  sudo journalctl -u hapee-3.0-lb --since "1 hour ago"

  nix
  sudo journalctl -u hapee-2.8-lb --since "1 hour ago"

  nix
  sudo journalctl -u hapee-2.8-lb --since "1 hour ago"

  nix
  sudo journalctl -u hapee-2.6-lb --since "1 hour ago"

  nix
  sudo journalctl -u hapee-2.6-lb --since "1 hour ago"

Save configuration files Jump to heading #

• Save a copy of your main configuration file (for example, /etc/hapee-3.2/hapee-lb.cfg).
• Save copies of any files or configuration files (for example, anything under /etc/hapee-3.2/ and /etc/hapee-extras/).
• Save a copy of your SSL/TLS certificate and key files and note their configured paths, for example /etc/hapee-3.2/certs/.
• Save a copy of any custom error pages, maps, or Lua scripts referenced in your configuration.
• Note your current package version and repository source so you can pin or roll back if needed.

Create a backup Jump to heading #

• Copy all configuration files to a different backup location, for example, outside of /etc/hapee-3.2/.
• If using HAProxy Fusion Control Plane, take an HAProxy Fusion backup.
• Get the HAProxy Enterprise version and record the output to document all compiled-in options and modules for the current version.

Snapshot your virtual machines Jump to heading #

• Take a VM snapshot of each HAProxy Enterprise server using your hypervisor before making any changes. This allows you to revert quickly if the upgrade encounters a problem.

Plan for downtime and rollback Jump to heading #

• Notify stakeholders of the planned upgrade window.
• Confirm you have a rollback plan.
  • VM snapshots can restore the previous state if the upgrade fails.
  • The backed-up configuration files can be restored manually if needed.
  • The previous package version can be reinstalled from the repository or a saved .rpm/.deb file.
• For multi-node deployments, plan to upgrade one node at a time, initiating failover via VRRP or your load balancer before upgrading each node.
• If HAProxy Enterprise is managed by the HAProxy Fusion Control Plane, coordinate the node upgrade with any planned Fusion upgrade.