HiveMQ Edge 2024.5.x to 2024.6 Migration Guide

This is a minor HiveMQ Edge upgrade. HiveMQ Edge 2024.6 is a drop in replacement for HiveMQ Edge 2024.5.

You can learn more about all the new features HiveMQ Edge 2024.6 introduces in our release blogpost.

HiveMQ Edge is prepackaged with all HiveMQ Edge Commercial Modules, HiveMQ Data Hub and all protocol adapters.

When you migrate from one HiveMQ Edge version to another, we recommend that you review the upgrade information for each version between your current HiveMQ Edge version and the target HiveMQ Edge version.
Note changes that are relevant to your use case and adjust your configuration as needed.

Upgrade a HiveMQ Edge installation

  • Create a backup of the entire HiveMQ Edge 2024.5 installation folder from which you want to migrate.

  • Install HiveMQ Edge 2024.6 as described in the HiveMQ Edge Installation Guide.

  • Migrate the content of the config.xml and license files from your old HiveMQ Edge 2024.5 installation.

  • To migrate your persistent data, copy everything from the data folder of your backup to the data folder of the new HiveMQ Edge 2024.6 installation.

HiveMQ Edge Configuration File Changes

No changes.

HiveMQ Edge Persistent Data Migration

When you migrate, HiveMQ Edge 2024.5 automatically updates the file storage formats of all the data that you copied into your new data folder.

To migrate the persistent data, you must copy everything in the data folder of the previous HiveMQ Edge 2024.5 installation to the data folder of your new HiveMQ Edge 2024.6 installation.

Linux example
cp -r /opt/hivemq-edge-2024.5/data/* /opt/hivemq-edge-2024.6/data/

The first time you start HiveMQ Edge 2024.6, the file storage formats of the persistent data from your previous installation are automatically updated in the new persistent storage.

Breaking Change in the Adapter Discovery API

HiveMQ Edge 2024.6 changes the return type of the discoverValues() method from CompletableFuture<Void> to void. Use the ProtocolAdapterDiscoveryOutput object to signal Edge the progress of the discovery.

Before:

@NotNull CompletableFuture<Void> discoverValues(
    @NotNull ProtocolAdapterDiscoveryInput input,
    @NotNull ProtocolAdapterDiscoveryOutput output);

After:

void discoverValues(
    @NotNull ProtocolAdapterDiscoveryInput input,
    @NotNull ProtocolAdapterDiscoveryOutput output);