Skip to content
English
More support
Contact Us
  • There are no suggestions because the search field is empty.

Migrating to RKE2 based Hyperglance Deployment

3 options to migrate your Docker based Hyperglance deployment to Kubernetes (RKE2).

Tip:  If your existing deployment does not have much state such as custom rules, dashboards, SSL certificates, SSO configuration, etc.  If all you want to do is migrate your account connections then you might find it easier to use the export/import buttons available on the Settings -> Platforms page to migrate those details across from a legacy deployment to a new deployment and then reach out to our support to help move across your license key.

Caution: All terminal commands documented here are to be performed on the Hyperglance instance/VM itself, not directly on your local PC/Mac.

All the options detailed below perform full data migrations of all state and you will require you to have SSH access to the deployments.

Select your preferred migration option:

 

Option 1:  In-place update [Easiest]

This option perform an in-situ update of the internals of your existing Instance/VM deployment.  Migrating from the legacy Docker-based stack to the new Kubernetes-based stack (RKE2).

✅ All configuration data migrated.
✅ No need to spin up a new Instance/VM.
❗ Hyperglance deployment will be offline until the migration completes.
❗ If anything goes wrong you will need to restore from a snapshot.

 
  1. We strongly recommend creating a backup / snapshot of your current deployment first. If you need to revert for any reason a snapshot of the whole Instance/VM is the only viable restore path.
  2. Ensure you have completed the Update 1-2025 upgrade process.
  3. (Recommended) Update the operating system:
    sudo apt update && sudo apt upgrade -y

    Note:   During the update process, you may be be asked whether to replace existing files, you can select "no".
     
    Once the update completes perform a reboot:

    sudo reboot now
     
  4. Update the Hyperglance application:
    sudo docker-compose -f /etc/docker-compose.yml pull && sudo docker-compose -f /etc/docker-compose.yml up -d --renew-anon-volumes
  5. Update the Hyperglance CLI tool:
     
    sudo hg update-cli
     
    Note: If the CLI is not already installed on your Hyperglance instance, you can obtain it by running the following command:
    sudo docker run --rm -it \
    -v /usr/local/bin:/app/binmap \
    docker.io/hyperglance/updatetool:latest -c "./upgrade.sh install" 
    You can confirm the availability and version of the Hyperglance CLI by running:
    hg version
     
  6. Start the in place migration by running the following command.
    Note: The process is one way and not reversible.

    sudo hg migrate insitu run --backup-path ~/backup.tgz --accept


  7. When the migration successfully completes, you will be presented with:
    The migration has completed successfully. It is highly recommended that you perform a reboot.
    If you created any backups in the /tmp directory, it is recommended that you copy these to a safe location as they could be wiped on reboot.
    Create a backup of the migration log files, and perform a reboot.
    mkdir ~/migration-logs && cp /tmp/hg-* ~/migration-logs
    sudo reboot now
  8. After reboot Hyperglance should come online as normal and be reachable in your browser after a short bootup period. You can also check on the status of the application using the CLI:
    hg status
 
 
 

Option 2:  Start a new instance and migrate data via SSH

This option involves deploying a fresh Hyperglance instance that is running the new Kubernetes-based stack (RKE2) and copying across your data over SSH.

✅ All configuration data is migrated.
✅ Your old deployment still stay running
✅ If anything goes wrong you will still have your existing deployment.
❗ You will need to provision a new Hyperglance instance or VM
❗ The new instance requires SSH with sudoer access to the old instance

 
  1. Deploy a new instance of Hyperglance but don't activate it with a license key. 
  2. SSH into your docker based Hyperglance deployment and update it to the latest version: 
    sudo docker-compose -f /etc/docker-compose.yml pull && sudo docker-compose -f /etc/docker-compose.yml up -d --renew-anon-volumes

     

  3. SSH into your new instance/VM of Hyperglance.
  4. Update the Hyperglance CLI to the latest version: 
    sudo hg update-cli
  5. Ensure that the Hyperglance application running on the new deployment is fully up to date: 
    sudo hg upgrade

     

  6. Next, you will need:
     
    1. The username of a user with sudo access, private key, ip address and ssh port of the legacy instance you wish to import your data from.
    2. The new instance/VM will need SSH network access to the legacy instance.
    3. The ssh key should be installed on the new instance.
     
    Once you have that, you can test connectivity to the docker based instance with the following 'test' command.  Just replace the UPPERCASE placeholders with your appropriate details:
    hg migrate from-remote test \
    --address DOCKER_INSTANCE_IP_ADDRESS \
    --key DOCKER_INSTANCE_SSH_KEY \
    --username DOCKER_INSTANCE_USERNAME \
    --port DOCKER_INSTANCE_PORT
    A successful connection example is shown below:
    ec2-user@ip-10-0-13-84:~$ hg migrate from-remote test \
    --address 192.168.1.68 \
    --key ~/.ssh/docker-ssh-key \
    --username ec2-user \
    --port 22
    [INFO] SSH Return Value: root
    [INFO] Successfully connected and elevated permissions!
    If the command fails, you will need to resolve the connectivity issue before continuing.
  7. Run the following command on your new Hyperglance instance to import the data.   Just replace the UPPERCASE placeholders with your appropriate details.
    sudo hg migrate from-remote run \
    --address DOCKER_INSTANCE_IP_ADDRESS \
    --key DOCKER_INSTANCE_SSH_KEY \
    --username DOCKER_INSTANCE_USERNAME \
    --port DOCKER_INSTANCE_PORT
    If the command completed succesfully, you should see the following:
    [INFO] The migration has completed successfully. It is highly recommended that you perform a reboot.
    [INFO] If you created any backups in the /tmp directory, it is recommended that you copy these to a safe location as they could be wiped on reboot.
  8. Perform a reboot: 
    sudo reboot now
  9. After reboot Hyperglance should come online as normal and be reachable in your browser after a short bootup period. You can also check on the status of the application using the CLI:
    hg status
  10. ⚠️ Please shutdown or terminate your legacy Hyperglance deployment as it is not permitted within the terms of use to run parallel instances on the same license key.  Failure to do so may result in you being double-charged.

 

Option 3:  Start a new instance and migrate data via Zipfile

This option involves deploying a fresh Hyperglance instance that is running the new Kubernetes-based stack (RKE2) and copying across your configuration as a zip-file bundle.

✅ All configuration data is migrated.
✅ If anything goes wrong you will still have your existing deployment.
❗ You will need to provision a new Hyperglance instance or VM

 
  1. Deploy a new instance of Hyperglance but don't activate it with a license key. 
  2. SSH into the legacy instance:
    1. Update the Hyperglance application:
      sudo docker-compose -f /etc/docker-compose.yml pull && sudo docker-compose -f /etc/docker-compose.yml up -d --renew-anon-volumes
    2. Stop the running containers.
      sudo docker stop wildfly httpd postgresql
    3. Create the backup bundle:
      sudo tar czf ~/docker-backup.tar.gz /var/lib/data
  3. Copy ~/docker-backup.tar.gz to the new Hyperglance deployment using a method that works within your environment (e.g. SCP, WinSCP, FileZilla, etc)
  4. SSH into the new instance:
    1. Update the Hyperglance application:
      sudo hg upgrade
    2. Import the backup bundle:
      sudo hg migrate bundle import --bundlePath path/to/imported/bundle.tar.gz
      If the command completed succesfully, you should see the following:
      [INFO] The migration has completed successfully. It is highly recommended that you perform a reboot.
      [INFO] If you created any backups in the /tmp directory, it is recommended that you copy these to a safe location as they could be wiped on reboot.
    3. Perform a reboot: 
      sudo reboot now

       

  1. After reboot Hyperglance should come online as normal and be reachable in your browser after a short bootup period. You can also check on the status of the application using the CLI:
    hg status
  2. ⚠️ Please shutdown or terminate your legacy Hyperglance deployment as it is not permitted within the terms of use to run parallel instances on the same license key.  Failure to do so may result in you being double-charged.