Configure High Availability

Last Updated: September 09, 2026

Use this procedure to configure high availability (HA) for the Virtual Appliance. HA requires an external MySQL database, an NFS share, and one or more additional Virtual Appliance instances that connect to the shared infrastructure.

Requirements

Review the Requirements before beginning.

  • Customers with an existing Virtual Appliance will configure a new primary and secondary Virtual Appliance separate from their production instance.
  • Once the HA setup is complete and tested, the final change is directing network traffic from the current production environment to the HA environment. This allows for the current production environment to run uninterrupted until the final cut over.

1. Install and Configure MySQL

1. Install MySQL

Follow these steps to install MySQL on the database server:

  1. Review the Application and Compatibility table on the Release Notes 2026 topic to confirm the MySQL version compatibility of your current Host.

  2. Go to https://dev.mysql.com/downloads/mysql/ and:

    1. Select 8.0.46 in the General Availability (GA) Releases tab.

    2. Select the Go to Download Page button and select Download next to the MSI installer.

      This download also includes the 64 bit installer.

    3. Run the MSI installer and complete the version installation.
  3. In the MySQL Installer window:
    1. In the Choosing a Setup Type window, select Custom.
    2. Select Next.
    3. In the Select Products window, select the compatible MySQL Server and MySQL Workbench version.
    4. Use the arrows to move them to the install side, then select Next.
    5. On the Download window, select Execute.
    6. Select Next and complete the installer modal.

  4. After installation, the first option on most installers is the Type and Networking tab. Complete the following:

    1. Config Type: Select Server Computer.
    2. TCP/IP: Enabled, Port 3306.
    3. XProtocol Port: Port 33060.
    4. Open Windows Firewall ports for network access.: Enabled.
    5. Show Advanced and Logging Options: Enabled if needed.
    6. Select Next to continue.

    MySQL Installer showing "Type and Networking" tab.

  5. On the Authentication Method tab, select from:

    1. Use Strong Password Encryption for Authentication (Recommended).
    2. Use Legacy authentication Method (Retain MySQL 5.x compatibility).
    3. Select Next to continue.

    Read through the information and use cases on the selection tab and choose the best option for your environment.

  6. On the Accounts and Roles tab, create the username and password for the root account.

    Document this password for use in later steps.

  7. On the Windows Service tab, confirm the selected defaults are:

    1. Enabled: Configure MySQL Server as a Windows Service.
    2. Enabled: Start the MySQL Server at System Startup.
    3. Run Windows Service as: Standard System Account.
    4. Select Next to continue.

    Windows Service tab of the MySQL Installer wizard showing the differnent options.

  8. On the Server File Permissions tab, select the desired option, then select Next.

  9. If you selected Show Advanced and Logging Options in step three:
    1. Adjust the settings and file paths on the Logging Options tab as needed.
    2. Select Next to continue.
    3. Adjust the Advanced Options as needed.
    4. Select Next to continue.
  10. On the Apply Configuration tab, select Execute.

Allow time for the processes to complete.

2. Create the Database

Follow these steps to create the app_pi database using MySQL Workbench:

  1. Install MySQL Workbench on the database server.

  2. Open MySQL Workbench and connect to localhost:3306 in the lower-right using your credentials.

    MySQL Workbench home screen showing the connection database.

    If you don't see your local instance connection, select the + icon to add it.

  3. Run the following command in the main Query field:

    Copy Code 
    CREATE DATABASE app_pi;
  4. Configure SQL Modes:

    1. Run the following command:

      Copy Code
      SET GLOBAL sql_mode = 'ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION';

    2. Close the instance, reconnect. Verify the setting with the following command:

      Copy Code
      SHOW VARIABLES LIKE 'sql_mode';
    3. Confirm that NO_ZERO_IN_DATE and NO_ZERO_DATE do not appear in the result.

2. Configure the NFS Share

Follow these steps to configure the NFS share:

  1. Set the NFS version to 4.1.
  2. Set the anonymous UID and GID to 0.

  3. Configure the export using the following format:

    Copy Code 
    /nfs_share <Virtual_Appliance_IP_Address> (rw,sync,no_root_squash,no_subtree_check,anonuid=0,anongid=0,nfsvers=4.1)

Refer to your NFS provider's documentation for full setup instructions.

3. Deploy the Virtual Appliance

1. Configure the Primary Virtual Appliance

In this section you set up your initial Virtual Appliance. Follow the configuration steps on the topics linked below. When you reach the Launch the Virtual Appliance Wizard section on the selected topic, follow the link back to this topic and continue with the steps below.

2. Launch the Virtual Appliance Wizard HA Setup

Follow these steps to finish configuring the primary Virtual Appliance instance:

  1. In your preferred, supported browser, paste or enter the Virtual Appliance IP address including port 8080. Example: 192.168.10.20:8080

  2. Once the setup wizard displays, select Let's Do This.

    Virtual Appliance configuration wizard, showing Let's Do This button.

  3. Under Configure Storage:
    1. Select NFS Network Storage.
    2. Enter the IP address or hostname.
    3. Enter the storage path.
  4. Select Continue.

  5. Select Start a New Instance.

    Virtual Appliance configuration wizard, showing "Upgrade or Start New Instance?" message with "Start a New Instance" and "Upgrade my Current Instance" buttons.

  6. On the General Settings tab:

    1. Add the domain name.

    2. Enter a Shared Storage Password.

      Passwords can contain any alphanumeric character (a-z, A-Z, 0-9), the following special characters (%^()_-+={}[]<>,.;), and up to 128 characters.

    3. Upload your license file.
    4. Upload your SSL certificate and key.

    Document and save the Shared Storage Password. It is available only during the web portion of the new Host configuration steps.

    Virtual Appliance configuration wizard, Settings page, showing General Settings section.

  7. Select Continue when finished.

  8. On the Setup Database tab:

    1. Select I will provide a MySQL 8.0+ database outside of the Virtual Appliance.

      Virtual Appliance configuration wizard, Database page, showing Setup Database section.

    2. Enter the following database details:
      1. Database name: app_pi
      2. Port: 3306
      3. Enter the Host, username, and password for your MySQL server.

    Passwords can contain any alphanumeric character (a-z, A-Z, 0-9), the following special characters (%^()_-+={}[]<>,.;), and up to 128 characters.

  9. Select Continue, then select Finish Setup.

    Virtual Appliance configuration wizard, showing "Success" message and Finish Setup button.

    Please do not refresh the page during the setup procedure.

  10. A new "Thank You" browser window will open when the installation is complete. This window can be closed as needed.

4. Migrate Data from an Existing Virtual Appliance

If you are moving from an existing Virtual Appliance deployment to an HA setup, follow these steps to migrate your data. If you are not migrating existing data, skip to 5. Configure Additional Virtual Appliance Instances.

1. Export Current Virtual Appliance Data

To export the database:

  1. Open MySQL Workbench and connect to the existing Virtual Appliance.
  2. Select the Administration tab in the left-side Navigator menu.
  3. Select Data Export.
  4. Select the app_pi database schema.
  5. Under export method, select Export to Self-Contained File to create a single .sql dump file.
    1. Alternatively, select Export to Dump Project Folder.
  6. Select Start Export.

MySQL Workbench showing the Data Export tab and options.

Please note, there is not progress bar for the export in MySQL Workbench, but it will show once complete.

2. Prepare New Primary Virtual Appliance

To adjust the secrets.env file:

  1. Connect to the new Virtual Appliance's NFS share.

  2. Open secrets.env and change the DB_DATABASE="app_pi" line to:

    Copy Code 
    DB_DATABASE="app_pi_temp"

  3. Save the file.

    Secrets.env file showing a mock up of the Values section.

  4. The Virtual Appliance creates a new app_pi_temp database.
  5. Verify that the new database appears in MySQL Workbench Schemas list.

3. Reset the Target Database

Because of differences in database versions, the cleanest route is to drop the database before the data import then recreate. This creates a fresh database that won't conflict if the database template does not match your current database structure.

To drop the schema:

  1. In MySQL Workbench, connect to the new external database.
  2. In the Schemas tab, right-click app_pi and select Drop Schema.
  3. Right-click in an empty area of the Schemas tab.
  4. Select Create Schema to create a new, empty app_pi schema.

4. Import Data

Follow these steps based on your export method.

Self-Contained Filed:

To import the existing database:

  1. Select the Administration tab, then select Data Import / Restore.
  2. Select Import from Self-Contained File and browse to the .sql file.
  3. Set Default Target Schema to app_pi.
  4. Select the Import Progress tab.
  5. Select Start Import.

Dump Project Folder

To import the existing database:

  1. Select the Administration tab, then select Data Import / Restore.
  2. Select Import from Dump Project Folder and browse to the dump project folder.
  3. Select Load Folder Contents.
  4. Set Default Target Schema to app_pi.
  5. In Select Database Object, select the database in the left pane and the tables in the right pane.
  6. Select the Import Progress tab.
  7. Select Start Import.

MySQL Workbench showing the Data Import tab and its settings.

5. Update Database and Verify Data

  1. Connect to the new Virtual Appliance's NFS share.

  2. Open secrets.env and revert the DB_DATABASE="app_pi_temp" database name:

    Copy Code 
    DB_DATABASE="app_pi"
  3. Save the file and allow a few minutes for the Admin Console to come online.
  4. If it wasn't added before:
    1. Add the license file.
    2. If applicable, add the SSL certificate and key to \\<nfs-share>\applicance-storage\certs.
  5. Sign in and verify that the data matches the original Virtual Appliance.

5. Configure Additional Virtual Appliance Instances

The process for adding additional Virtual Appliance instances in your HA setup starts the same as 1. Configure the Primary Virtual Appliance. The difference occurs when running the Virtual Appliance Wizard for the instances after the primary.

  1. Create the next Virtual Appliance and configure the network settings.
  2. In your preferred, supported browser, paste or enter the Virtual Appliance IP Address including port 8080. Example: 192.168.10.20:8080

  3. Once the setup wizard displays, select Let's Do This.

    Virtual Appliance configuration wizard, showing Let's Do This button.

  4. Under Configure Storage:
    1. Select NFS Network Storage.
    2. Enter the IP address or hostname.
    3. Enter the storage path.
    4. Select Continue.

  5. In the next window, select Continue with Previous Settings.

    Virtual Appliance wizard showing "Continue with Previous Settings" and Change Settings buttons.

  6. Allow time for the Virtual Appliance wizard to finish.

    Please do not refresh the page during the installation procedure.

  7. This connects your additional Virtual Appliance to the same NFS Network Share as the primary Virtual Appliance.

6. Finalize the Migration

The final steps in the HA configuration are verifying Admin Console accessibility and configuring your instance. If you are not migrating data from an existing Virtual Appliance environment, your setup is complete. Ensure you can access and log into the Admin Console.

If you did migrate data from an existing Virtual Appliance, confirm your settings and feature configurations migrated over correctly. Thoroughly test to make sure the instance is functioning correctly.

When you are ready to cut over, redirect network traffic to the new Virtual Appliance. After verifying a successful cut over, you may decommission the previous Virtual Appliance.