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.
Install the Data Plane API Jump to heading
To install the Data Plane API:
-
If your HAProxy ALOHA host is a virtual appliance instead of hardware, you need to create an additional partition large enough to contain the files.
-
Attach a new hard disk to the virtual machine. It should be 30 GB or larger.
-
Power on your HAProxy ALOHA Virtual Appliance.
-
Log in to your HAProxy ALOHA web UI as an administrator. The web UI runs at port 4444.
-
Select the Tools tab, then edit the file
/etc/config.rc
through the File Manager. Add the following directives at the end of theservice system
section, then click Save:textapp_auto_mountapp_auto_formatapp_device_size 30000000000textapp_auto_mountapp_auto_formatapp_device_size 30000000000where:
app_auto_mount
automatically mounts the partition on/app
.app_auto_format
automatically formats the/app
partition, if needed.app_device_size <Size in bytes>
specifies the size in bytes of the/app
partition. Here we set it to 30 GB.
-
Select the Setup tab, then click Save to save your modifications.
-
Restart HAProxy ALOHA.
-
-
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.
-
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. -
Log in to your HAProxy ALOHA web UI as an administrator.
-
Go to the Tools tab, then use the File manager to upload the
management-aloha<VERSION>.img
disk image to the directory/app/images/
. -
Go to the Setup tab and click Reboot.
-
Go back to the Tools tab and check in the File Manager that the
/app/management
directory is populated. -
Check that the dataplaneapi service is started on the Services tab.
-
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:
-
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.
-
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. -
Log in to your HAProxy ALOHA web UI as an administrator.
-
In the Services tab, stop the dataplaneapi service.
-
Go to the Tools tab, then use the File manager to upload the
management-aloha<VERSION>.img
disk image to the directory/app/images/
. -
Reboot the virtual appliance through the Setup tab.
-
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:
nix/app/management/usr/sbin/dataplaneapi --versionnix/app/management/usr/sbin/dataplaneapi --version
Do you have any suggestions on how we can improve the content of this page?