Installation

Install the HAProxy Data Plane API on HAProxy ALOHA

Available since

  • HAProxy ALOHA firmware 13.0
  • HAProxy ALOHA hardware appliance 5300

This section describes how to install the HAProxy Data Plane API on HAProxy ALOHA.

Attach a hard disk Jump to heading

For the HAProxy ALOHA virtual appliance, before enabling the Data Plane API, you must mount an additional disk partition to store its files.

  1. Allocate at least 6 GB of RAM to each of your HAProxy ALOHA virtual appliance.

    Why 6GB of RAM?

    This number comes from benchmarking memory usage of the additional packages while taking into account the RAM needed to run other services on the system. Note that insufficient memory may cause HAProxy ALOHA to reboot due to a watchdog process that monitors memory.

  2. Attach a new disk to your HAProxy ALOHA virtual appliance. We recommend creating a 30 GB or larger disk.

    Consult the instructions for your hypervisor.

  3. Log in to your HAProxy ALOHA web UI as an administrator.

  4. Go to the Tools tab, then use the File manager to edit the file /etc/config.rc.

  5. Add the following directives at the end of the service system section, then click Save:

    config.rc
    app_auto_mount app_auto_format app_device_size 30000000000
    config.rc
    app_auto_mount app_auto_format app_device_size 30000000000

    In this example:

    • app_auto_mount automatically mounts the partition on /app.
    • app_auto_format automatically formats the /app partition, if needed.
    • app_device_size specifies the size in bytes of the /app partition.
  6. Select the Setup tab, then save your modifications by clicking Save.

  7. Restart HAProxy ALOHA.

Enable the Data Plane API Jump to heading

By default, the Data Plane API is deactivated.

  1. Obtain your credentials for accessing HAProxy ALOHA downloads. You can create a new support ticket in the HAProxy Technologies Customer Portal to request your credentials.

  2. Go to the ALOHA downloads page, navigate into the folder for your firmware and then into the packages folder. Enter your credentials to access the folder.

    Download the latest management-aloha<VERSION>.img disk image.

  3. Log in to your HAProxy ALOHA web UI as an administrator.

  4. Go to the Tools tab, then use the File manager to upload the management-aloha<VERSION>.img disk image to the directory /app/images/.

  5. Go to the Setup tab and click Reboot.

  6. Go back to the Tools tab and check in the File Manager that the /app/management directory is populated.

  7. Check that the dataplaneapi service is started on the Services tab.

  8. Optional: To change the default settings of the Data Plane API, edit the file /app/management/var/lib/dataplaneapi/dataplaneapi.yaml and then restart the dataplaneapi service on the Services tab.

Update to a newer version of the API Jump to heading

To update to a newer version of the API, follow these steps:

  1. Obtain your credentials for accessing HAProxy ALOHA downloads. You can create a new support ticket in the HAProxy Technologies Customer Portal to request your credentials.

  2. Go to the ALOHA downloads page, navigate into the folder for your firmware and then into the packages folder. Enter your credentials to access the folder.

    Download the latest management-aloha<VERSION>.img disk image.

  3. Log in to your HAProxy ALOHA web UI as an administrator.

  4. In the Services tab, stop the dataplaneapi service.

  5. Go to the Tools tab, then use the File manager to upload the management-aloha<VERSION>.img disk image to the directory /app/images/.

  6. Reboot the virtual appliance through the Setup tab.

  7. Check that the dataplaneapi service is started in the Services tab.

    You can also verify which version of the API is installed by running the following command from the CLI:

    bash
    /app/management/usr/sbin/dataplaneapi --version
    bash
    /app/management/usr/sbin/dataplaneapi --version

If this page was useful, please, Leave the feedback.