Skip to main content


Upgrading Unravel from version 4.7.x to 4.7.7.x

This topic provides instructions to upgrade Unravel from version v4.7.x, and v4.7.7.x for the following platforms:

The following upgrade paths are supported:

  • 4.7.x.x4.7.7.x

  • v4.6.1.9 v4.7.7.0

  • v4.6.1.8 or earlierv4.6.1.9v4.7.7.0

Upgrading GCP- Bigquery/Dataproc from Unravel (v4.7.x to v4.7.7.0)

This section provides information about upgrading Unravel for GCP-Bigquery and GCP-Dataproc.

Before you upgrade, do the following:

An existing license for any previous version (before 4.7.7.x) does not work with the newer version of Unravel. Therefore, you must obtain a license file from Unravel Customer Support.

To set the license, see Upgrade Unravel for GCP - BigQuery, Dataproc (v4.7.x to v4.7.7.0).

Take a backup of the data directory and the external database if you use one. To back up the data, refer to Backing up and recovering Unravel


If an upgrade fails, you can roll back the upgrade to the release from which you had upgraded. For information, see Rollback after a failed upgrade. For this rollback to work, you must ensure to take a backup of the data directory and the external database before you upgrade.

Unravel requires Java Runtime Environment (JRE), and hence it is shipped with OpenJDK version 17.0.1. If you have a different version of JDK installed, you must configure Unravel to access the corresponding jre directory in that JDK. For instructions, refer to Configuring custom JDK.

  1. Go to the Download section. The complete list of Unravel downloads is available in this section.

  2. Download the Unravel version that you want to upgrade. The section provides the details and necessary instructions to download Unravel.

  3. Extract the Unravel binaries of the Unravel version you want to upgrade.

    tar zxf unravel-<version>tar.gz -C </path/to/installation/directory>

    For example: tar zxf unravel- -C /opt

  4. Stop Unravel.

    <Unravel installation directory>/unravel/manager stop
  5. Activate Unravel version

    <Unravel installation directory>/unravel/manager activate
  6. Set Unravel license. Changing the license is mandatory. Contact Unravel Customer Support to get a new license file.

    <Unravel installation directory>/unravel/manager config license set <path to license file>

    For example:

    Example: /opt/unravel/manager config license set /tmp/license.txt

    For more information about setting the license file, see Setting Unravel license.

  7. Apply the changes.

    <unravel_installation_directory>/unravel/manager config apply

    All the Jobs from the previous version of Unravel will appear on the Unravel UI.

  8. Start Unravel

    <Unravel installation directory>/unravel/manager start
  9. Check the status of the services.

    <unravel_installation_directory>/unravel/manager report 

    The following service statuses are reported:

    • OK: Service is up and running.

    • Not Monitored: Service is not running. (Has stopped or has failed to start)

    • Initializing: Services are starting up.

    • Does not exist: The process unexpectedly disappeared. A restart will be attempted 10 times.


    If you have configured the Push or Pull method earlier to get data from BigQuery, then the same method is applied after you upgrade to Unravel without any additional changes.

    Run the following command to check the method used after the upgrade.

    <Unravel_installation_directory>/unravel/manager config bigquery show
  10. Delete the previous installation directory from unravel/versions/<THE.OLD.VERSION>.

  • Enable Hadoop daemons (hive_worker, kafka_monitor, yarn_jc_worker, oozie_sensor)

    If you are already running BigQuery on GCP and want to enable Dataproc, then run the following steps to enable Hadoop daemons (hive_worker, kafka_monitor, yarn_jc_worker, oozie_sensor).

    1. Enable the Hadoop daemons.

      <Unravel/installation/directory>/manager service enable --permanent hive_worker kafka_monitor yarn_jc_worker oozie_sensor

      For the complete list of Unravel daemons, refer to Unravel daemons.

    2. Apply the changes.

      <Unravel/installation/directory>/manager config apply --restart
    3. Verify the status of the service.

      <unravel_installation_directory>/unravel/manager report 
  • Set message ordering for BigQuery project subscriptions

    For best performance, enable message ordering in GCP Cloud Pub/Sub. The Message ordering setting lets you receive the messages in the order they are published. Refer to Ordering messages for more details. After you upgrade, you cannot directly update the Message ordering setting.

    To enable the Message ordering setting after an upgrade, do the following:

    1. From the GCP console, delete the configured subscription for the respective project.

    2. Create a new subscription with the Message ordering setting on.


      The Message ordering setting can be configured only once when configuring the Pub/Sub service for the first time.

    Refer to 7. Configure Pub/Sub service and Unravel LR endpoint for complete instructions.