Upgrade, Reconfigure, or Back Up ARD Hub
This article covers upgrading, uninstallation, reinstallation, database back-up and restore, and the configuration of port, proxy, and memory allocation for ARD Hub.
The Docker-based installation script
ard.shalso handles upgrades, uninstallation, reinstallation, and the configuration of port, ssl proxy, and memory allocation. For information about the basic installation procedure, see Install ARD Hub Using a Docker Container.
ARD Hub 3.0 only works with ARD Studio 3.x. If you are planning on upgrading the ARD Hub to 3.0, then you must also upgrade the desktop client.
This article covers the following advanced maintenance topics:
Advanced Installation Example
You can combine several options of the
ard.shscript into one command. For example, to run the installer, change the port, and increase the heap size to 8 GB, you would execute the script with the following options:
./ard.sh --hostname myserver.example.org --port 1234 --jvm-heap-max-size 8192
Upgrade ARD Hub (Docker)
The installation script also handles upgrades for the Docker installation.
- Download the new installation package from the Customer Support Site, and unpack the archive
- Execute the new installer script with the options of your choice../ard.sh --hostname myserver.example.orgThe script detects that you have another version installed and prompts you with "Do you wish to upgrade from version x to y?"
- Respond Yes to continue or No to cancel.If you respond yes, the script backs up your previous configuration in the folder.ard/.backupand upgrades ARD Hub to the new version.
If you installed ARD Hub manually, follow these steps to upgrade:
Upgrade ARD Hub (Manual)
- Download the new installation package from the Customer Support Site, and unpack the archive.
- Remove the old .war files atTOMCAT_HOME/webapps/ard#*.warfrom your installation. The Tomcat server removes the associated directories automatically.
- Shut down the Tomcat server.
- Copy the contents of the downloadedhub_install_dir/war/directory to yourTOMCAT_HOME/webapps/directory.
- Restart the Tomcat server.
Install ARD Hub Silently
When you run the installation script, it prompts you asking whether you want to proceed. To continue, you need to enter Y or N (yes or no) manually. To bypass this prompt and install ARD Hub silently, create a custom response file and pass the relevant answers to the shell script.
- Create a plain text file response.txt containing the letter Y on the first line.
- Save the file in the same directory as the installer script.
- Run the installer script with an input redirect from the response file:./ard.sh --hostname myserver.com --port 8080 --jvm-heap-max-size 8192 --offline < ./response.txt
If the script prompts for more questions, include each custom answer in that response file, each on its own line, and rerun.
Configure a Reverse Proxy
Configuring a reverse proxy is useful if you want to use a secure HTTPS connection, or, if you do not want to use the port number in the ARD Hub URL.
The reverse proxy works for either HTTP or HTTPS. You could enable it for HTTP to try out a reverse proxy configuration without needing to obtain a security certificate. You can disable the reverse proxy again at any time.
- Enable the Proxy for HTTP:./ard.sh --proxy-enableThe script detects if you have the same version of ARD Hub already installed. In this case, it asks you whether you want to reinstall.
- Respond Yes to continue or No to cancel.If you respond Yes, the script updates the configuration to include the proxy settings. You find a backup of your previous settings in the folder.ard/.backup.
- Verify that a file.ard/conf/proxy.tomlwas created and that the file contains the new proxy config.
Now you can access the web interface by using the domain only (
http://myserver.example.org), instead of the whole socket (
Alternatively, you can also configure an SSL proxy.
- Get an SSL certificate from your certification authority.
- Copy the two certificate files to the.ard/certfolder and rename them as follows:
- Enable the secure reverse proxy../ard.sh --proxy-ssl-enable
To disable the reverse proxy (and access the web interface with the specified port again), execute the following command.
Reconfigure the Port
To use a different port, execute the following command:
Increase Memory Allocation
If you have issues with the memory usage of your server, increase the heap size. Allocating more memory becomes especially important before using the migration feature. The default Tomcat server heap size is 1.5 GB (1536 MB). If you migrate flows of large size or number, increase the heap size, for example, to 8 GB (8192 MB).
To increase the memory allocation, execute the following command:
./ard.sh --jvm-heap-max-size 8192
Reinstall ARD Hub
If your ARD Hub Docker installation worked previously, and you changed settings and it stopped working, try reinstalling it before calling Support. The reinstall command recreates the Docker containers and configuration, but it keeps your data. The command also keeps a backup of your previous configuration config in the folder
To reinstall ARD Hub, execute the following command:
Uninstall ARD Hub
ARD Hub includes the MySQL database that contains all your ARD flows at
.ard/storage/mysql. If you execute the uninstall command, it removes all ARD Hub docker containers, configuration files, and all the flows in the storage. The command prompts to make archive the data as a backup.
To delete your ARD Hub installation, execute the following command:
If you responded Yes to archive the data, the command archives configuration files and database data in /var/ard/application-data/archive in a folder with a name such as
Command Summary ard.sh
./ard.sh --helpon the Linux command line to see all commands supported by the ARD Hub installer.
Installation command usage:
The installation command supports the following options:
- --hostnameserver-domain-nameDefines the fully qualified domain name of the host server (FQDN).
- --portserver-portDefines a custom port for the Host server port. The default is 8080.
- --jvm-heap-max-sizemax-size-in-mbSpecifies the maximum heap size for the Tomcat server in megabytes.
- --offlineEnables offline installation mode using pre-downloaded Docker files that you have copied into your docker registry.
- --reinstallRe-installs the current version of ARD Hub.
- --get-filesDownloads the Docker images and installation files without installing ARD Hub.
- --uninstallUninstalls ARD Hub (including volumes, network, config). Make a backup of your data before uninstalling!
- --proxy-enableEnables reverse proxy with HTTP for ARD Hub.
- --proxy-ssl-enableEnables reverse proxy with HTTPS for ARD Hub.
- --proxy-disableDisables reverse proxy for the Hub stack.
- --versionShows the version of this installer script and quits.
- --helpShows information about supported installer commands and quits.
Back Up ARD Hub Databases
Databases are stored in volumes. ARD does not perform any automatic database backups, so set up a backup schedule manually.
Your database is stored in
/var/ard/application-data/storage/mysql. In this folder, there are two subfolders,
keycloak, which store data for FlowStorage and Keycloak, respectively. A full backup does not only include the databases, but also the configurations and passwords.
Regularly back up the whole
/var/ard/application-datafolder. If there is a crash, having a backup of the whole folder makes it easier to recover an ARD Hub installation
Use ARD 2.10 Hub Database in ARD Hub 3.0 Installation
To use ARD Hub 2.10 databases in ARD Hub 3.0 installations, transfer the old
/var/ard/application-datafolder to the new machine, and install ARD Hub again. The installation script recognizes the data, including the database, and starts using it.
Restore Database From Back-Up
- Back up your old/var/ard/application-datafolder.
- Uninstall ARD Hub. Uninstalling deletes all the data and configurations.
- Copy your backed-up/var/ard/application-databack to its old location.
- Re-Install ARD Hub. The Hub recognized the data, including the database, and starts using it.
Switch to an External FlowStorage Database
You can switch to an external FlowStorage database that is not the one in your volume.
- Install ARD Hub.
- Stop the ARD Hub container using the following command:docker container stopcontainerId
- Go to the/var/ard/application-data/.ard/conffolder and edit thesettings.propertiesfile.
- Change the following fields so they point to your database location:flow_storage.database.type=mysql flow_storage.database.host=f865402a-db flow_storage.database.port=3306 flow_storage.database.name=ARDFlowStorage flow_storage.database.user=root flow_storage.database.password=my_database_passwordflow_storage.database.tenant=ARDFlowStorage
- Save thesettings.propertiesfile.
- Start the ARD Hub container using the following command:docker container startcontainerId