Upgrading the Zoomdata Server


Due to the upgrade of the HashiCorp Consul (service discovery) version from 0.7.5 to 1.2.2, custom connectors built before Zoomdata 3.2 ( built for versions 3.1 or earlier versions) will not appear in Zoomdata after you migrate to Zoomdata 3.7. This is caused by incompatibilities between old connectors and the new Consul. To make your custom connectors compatible with Zoomdata 3.7 (and later versions), you must migrate them as described in Version 3.7 Custom Connector Migration Information.

This migration step is required only for custom connectors built with Zoomdata versions earlier than 3.2 or for connectors that were present before Zoomdata 3.2 but that are now deprecated (for example, the Hive on Tez connector, which was replaced by the Hive connector in Zoomdata 3.7).

If you have used Zoomdata versions earlier than 3.3, you must delete the RabbitMQ queues before you upgrade to Zoomdata 3.3 or later. In addition, an additional header specifying the media type on non-browser HTTP requests is now required. These changes are required because in Zoomdata version 3.3, we updated the Spring Cloud library underlying our application. See Version 3.3 Upgrade Information.
Zoomdata version 3.2 and later versions use headless Google Chrome instead of Firefox for Zoomdata's Screenshot service. The Chrome-based Screenshot service cannot be installed in CentOS v6 environments because the Google Chrome dependencies do not support that platform. See Setting Up the Screenshot Feature.

You can upgrade your Zoomdata server to the current release.

SQL connectors require a JDBC driver to be configured before you can connect to your data source. You can download the driver from the vendor’s site. Be aware that you need to download and configure JDBC drivers for the following Zoomdata connectors:

If you are using one of the above data sources, you need to download and configure a JDBC driver as soon as your Zoomdata server has finished upgrading. For steps, see Add a JDBC Driver.

For information about the difference between a clean installation of Zoomdata and an upgrade to the latest GA release, see Clean Installation and Upgrade Differences.

If you are upgrading from version 2.6.1 to the latest Zoomdata version, you can change the default http port to enable https for your environment. For information and steps, see Configuring Zoomdata Property Files.


Prior to upgrading your Zoomdata software, Zoomdata strongly recommends that you:

  • back up your metadata store
  • backup any previously uploaded CSV files. These files are located in the /opt/zoomdata/data directory.

Failure to have a proper backup could result in losing data during the upgrade process. For more information, see Backing Up and Restoring the Metadata Store.

The installer script works in the following environments:

  • Centos v6 and v7
  • Ubuntu v14.04 and 16.04

See System Requirements for recommended settings for deploying Zoomdata on-premise.

If you if have any of the above mentioned data sources that require a JDBC driver, you need to download and install the driver from the vendor's website.

The target server for the Zoomdata program should meet the following conditions:

  • Server is connected to the Internet
  • The user installing Zoomdata is able to use the 'sudo' command in the server

Upgrade Instructions

To begin the upgrade process, you must receive an email containing upgrade instructions from Zoomdata Support. This email provides the upgrade script that you need to run in the server where the Zoomdata environment will reside.

If you have not received upgrade instructions, select the button on this page to open a ticket with Zoomdata Support.
  1. When you receive the email, enter the upgrade command on your target server to start the automated upgrade process. The following Zoomdata components are downloaded on your target server:

    • The Zoomdata server
    • Scheduler service
    • Connector services
    • Query Engine
    • Streamwriter service
    • Upload service

    The upgrade script also handles the installation and setup of RabbitMQ in your environment.

    The Zoomdata Scheduler is a component within the Server used to run jobs that will refresh Zoomdata’s connection to the data source in asynchronous mode. For more information, see Using the Zoomdata Scheduler.

  2. After the upgrade script has completed, it will take a few minutes for Zoomdata to complete its update of the metadata store. We recommend that you wait a few minutes before accessing Zoomdata from your web browser.

    If you receive a message indicating that Zoomdata is not yet accessible, it may not have completed its setup yet. Wait a few more minutes before trying again or opening a Support ticket. If you continue to have issues accessing Zoomdata from your browser, click the Support button on this page to open a ticket with Zoomdata Technical Support. For information about accessing Zoomdata, see Accessing Zoomdata.

    If you notice some unusual behavior in the Zoomdata UI after upgrading the Zoomdata software (for example, if a drop-down menu doesn't open or the application doesn't react when you click on a button), clear the browser cache and try again. If the problem persists, contact Support.

  3. The firewall setup you used with earlier versions of Zoomdata should have been retained and your Zoomdata IP address should remain unchanged, but see the following for more information: