3.1.x to 3.2.x Migration Guide

This is a major HiveMQ upgrade. HiveMQ 3.2 is a drop in replacement for HiveMQ 3.1.x

No manual steps are required for upgrading from HiveMQ 3.1 to HiveMQ 3.2.

HiveMQ Upgrade

  • Create a backup of the entire HiveMQ installation folder

  • Install HiveMQ 3.2 as described in the HiveMQ Installation Guide

  • Migrate the configuration file contents of your old HiveMQ installation

  • To migrate the persistent data, copy all contents in the data folder from your backup to the new HiveMQ 3.2 data folder. On first start HiveMQ 3.2 will migrate the persistent data from your previous installation into its new persistent storage.

Configuration File Upgrade

HiveMQ 3.2 introduces some changes to the configuration file:

Persistent Data Migration

HiveMQ 3.2 automatically migrates all data in your data folder from previous versions to updated file storage formats.

To allow HiveMQ to migrate the persistent data from previous versions you have to copy the contents of your data folder from the previous installation to the data folder of the new installation.

Linux example
cp -r /opt/hivemq-3.1.6/data/* /opt/hivemq-3.2.0/data/

On the first start up HiveMQ 3.2 will automatically migrate the persistent data from your previous installation into its new persistent storage.

Cluster Upgrade

Rolling upgrades are supported and it’s possible to run HiveMQ version 3.1 and version 3.2 simultaneously in the same cluster. When all nodes are upgraded to the new version, all new HiveMQ cluster features will be enabled by default. No manual intervention is needed.

Please follow the instructions in our user guide to ensure a seamless and successful rolling upgrade.

Please see the HiveMQ Clustering Documentation for more information.

Plugin System Upgrade

The plugin system update has new features that can be used. HiveMQ 3.2 is completely backward compatible with older versions, so you are not required to update your plugins if you don’t want to use the new plugin system features.

Upgrading your plugins

In order to upgrade your plugin, execute the following steps:

  • Update your pom.xml

Adapt your pom.xml file

Change your HiveMQ SPI version to 3.2.0 in your pom.xml file

<dependency>
    <groupId>com.hivemq</groupId>
    <artifactId>hivemq-spi</artifactId>
    <version>3.2.0</version>
</dependency>