Upgrade Composer v5

You can upgrade your Composer server to the current release.

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

Upgrade and Migration Considerations

• Before installing or upgrading to any Composer 5.9.x version, please read Composer 5.9.x Installation and Upgrade Process for Multiple Context Paths.

• If you are upgrading to a newer version of Composer and you also want to change your encryption mode, perform the upgrade first and complete the steps described in Changing the Encryption Mode.

• Manually upgrading Composer no longer provides the Java Runtime Environment (JRE) needed for Composer to start. Make sure you have Java 11.0.5 or later installed before you manually install or manually upgrade to Composer 5.8 or later. If you do not, Composer will not start.

• 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 after you migrate to Zoomdata 3.7 (or later) or to Composer 5 (or later). This is caused by incompatibilities between old connectors and the new Consul. To make your custom connectors compatible with Zoomdata 3.7 (or later) and Composer 5 (or later), you must migrate the connectors as described in Custom Connector Migration.

  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).

• Zoomdata version 3.2 (or later) and Composer 5 (or later) versions use headless Google Chrome instead of Firefox for the Screenshot microservice. See Setting Up the Screenshot Microservice.

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

Prerequisites

Prior to upgrading your software, we strongly recommend that you:

• Back up your metadata store. See Backing Up and Restoring the Metadata Store.
• Back up any previously uploaded CSV files. These files are located in the /opt/zoomdata/data directory.
• Store or back up any CA certificates you added to the Java code installed by Zoomdata 2, 3, 4, and Composer 5.7 installations. The CA certificates you added to Java in previous versions will be lost when you perform the manual installation of Java 11.0.5 or later requested by Composer 5.8 (or later) installations. After you have upgraded to Composer 5.8 (or later), you can reimport the CA certificates to your new version of Java.

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.

An option to install OpenJDK is included in the installation and upgrade scripts provided by Composer. If you skip this option or if you install or upgrade the product manually, make sure that Java 11.0.5 (or later) is installed. If you do not, Composer will not start after the upgrade.

The installer script works in the following environments:

• CentOS 7 or 8
• Ubuntu 16 or 18

Important CentOS 6 Information

CentOS 6 is no longer supported and the special installation Bootstrap procedure (bootstrap-zoomdata-centos6.run) is no longer provided with this product. CentOS 6 is no longer supported by Red Hat Linux (RHEL). Use CentOS 7 or 8 instead.

Important Ubuntu Information

Ubuntu users who have Composer or Zoomdata versions earlier than 5.8 installed must first remove the legacy repository before upgrading Composer 5.8 or later. Use this command:

sudo rm -f /etc/apt/sources.list.d/saltstack.list

See Supported Browsers for recommended settings for deploying Composer on-premise.

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

• Server is connected to the Internet
• The user installing Composer 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 Technical Support. This email provides the upgrade script that you need to run on the server where the Composer environment resides.

If you have not received upgrade instructions, open a ticket with Composer Support

1. When you receive the email, enter the upgrade command on your target server to start the automated upgrade process. The following Composer components are downloaded on your target server:

   • The Composer server
   • Connector microservices
   • Query Engine
   • Data Writer microservice

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

   If you receive a message indicating that Composer 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 Composer from your browser, open a ticket with Composer Technical Support. For information about accessing Composer, see Accessing Composer.

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

3. The upgrade script provided by Technical Support assumes that your Postgres metadata store is running locally on the same machine as the Composer code and automatically adds the new databases required by Zoomdata 4.9 (or later) and Composer 5.7 (or later) to your local installation. If you have upgraded and your metadata store is installed on a different machine (not locally), you will need to manually create the following databases in your Postgres metadata store after the upgrade.

   • zoomdata
   • zoomdata-keyset
   • zoomdata-qe
   • zoomdata-upload

   See Creating the Composer User.

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

   • Configuring the Firewall
   • Identifying the Composer IP Address

5. 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 Composer connectors:

   • Microsoft SQL Server
   • MemSQL
   • MySQL
   • Oracle
   • Amazon Redshift
   • Teradata

   If you are using one of these connectors, you need to download and configure a JDBC driver as soon as your Composer server has finished upgrading. For steps, see Adding a JDBC Driver.

6. Reimport any CA certificates to the Java 11.0.5 or later you installed prior to the Composer upgrade. (In Prerequisites, we recommended that you store them or back them up before the Composer upgrade.