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

Export & Import of config & data

This article covers various ways to export/import and migrate configuration and user-data between Hyperglance deployments

When we talk about migration of data we only mean user-created configuration and content. 

Any ingested data about your environment will be recreated in-full on a new instance and does not need to be migrated.

The data that can be migrated across includes:

  • Account connection details (access keys, subscription IDs, etc

  • User-created dashboards

  • User-created rules
  • User-editable configuration made through the UI
  • User-editable configuration made through config files (config.yaml)
  • License key

 

Deciding what to migrate:

The easiest assets to migrate are account connections, dashboards and rules which can be exported & imported via the UI.  Full data migrations are more technical and are performed through the terminal.

Use these links to jump down the page to corresponding section:

 

 

Import & export of account connections

To export:

1) Go to Settings

2) On the Platforms tab click the Bulk Export button

3) Accept the message that the export will decrypt your secrets to a local downloaded file.

To import:

1) Go to Settings

2) Click the Bulk Import button and upload the file you previously downloaded.

 

Import & export of dashboards

To export:

1) Visit a dashboard you want to export

2) In the top-right hand menu click Export Dashboard:

To import:

1) In the UI visit any dashboard

2) In the top-left hand corner click the name of the dashboard to expand the dashboard list -> Select the arrow on the right-hand side of the 'New' button -> select Import dashboard

 

Import & export of rules

To export:

1) Visit 'Rules' page

2) At the top click the 'Export' button.  This will download a zip of all rules.

3) To migrate only a subset of rules unzip the zipfile and remove any you do not want to migrate.  Then rezip the remaining files into a new zipfile.

To import:

1) Visit 'Rules' page

2) At the top click the 'Import' button and select a zip bundle of rules to import.  Note: Any duplicates with pre-existing rules will fail to import.

 

Full-data migration over SSH

Prereqs:

  • Migration source and target are both Hyperglance VMs (not running in your k8s clusters)
  • Target instance has SSH access to the source instance to pull data across
  • Note: Only suitable for direct licensed customers, not marketplace customers.

Process:

  1. You will need to enable SSH access to allow the new instance to SSH into the legacy one.

    Copy the SSH keyfile onto the new instance and run the command below to test connectivity to the legacy instance.. Just replace the UPPERCASE placeholders with your appropriate details:
    hg migrate from-remote test \
    --address LEGACY_INSTANCE_IP_ADDRESS \
    --key PATH_TO_SSH_KEY \
    --username SSH_USERNAME \
    --port SSH_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.

  2. Import the config from the legacy instance.
    Just replace the UPPERCASE placeholders with your appropriate details:
    sudo hg migrate from-remote run \
    --address LEGACY_INSTANCE_IP_ADDRESS \
    --key PATH_TO_SSH_KEY \
    --username SSH_USERNAME \
    --port SSH_PORTIf 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. Migrate the license key from the legacy instance.  This will leave the legacy instance in an unlicensed state.
    Just replace the UPPERCASE placeholders with your appropriate details: 
    sudo hg migrate from-remote license \
    --address LEGACY_INSTANCE_IP_ADDRESS \
    --key PATH_TO_SSH_KEY \
    --username SSH_USERNAME \
    --port SSH_PORT \
    --accept

     

  4. Perform a reboot: 
    sudo reboot now

     

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

 

Full-data migration via zipfile

Prereqs:

  • Migration source and target are both Hyperglance VMs (not running in your k8s clusters)
  • Note: Does not migrate license key.  Direct licensed customers will need Hyperglance customer support to create a new key for you.  Marketplace customers are not affected by this limitation since they do not require a license key.

Process:

  1. 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
    4. Download ~/docker-backup.tar.gz to your local PC (e.g. using SCP, WinSCP, FileZilla, etc)
  2. [This step is for Marketplace customers only]:
    Stop your legacy instance/VM. You do not have to delete it. Just make sure it's not in a running state and this will free up your marketplace subscription.
  3. [This step is for Marketplace customers only]:
    Redeploy Hyperglance from the marketplace portal. It is important to make sure you launch the same product variant that you had subscribed to. Do not enter into any new subscription contracts as this could have significant billing implications. You should just redeploy your existing product's launch template. If in doubt, contact us first.
  4. Copy ~/docker-backup.tar.gz from your PC to the new Hyperglance deployment (e.g. using SCP, WinSCP, FileZilla, etc)
  5. SSH into the new instance:
    1. Update the Hyperglance CLI to the latest version: 
      sudo hg update-cli
    2. Update the Hyperglance application to the latest version: 
      sudo hg upgrade
    3. Import the backup bundle: 
      sudo hg migrate bundle import --bundlePath path/to/imported/bundle.tar.gzIf 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.
    4. Perform a reboot: 
      sudo reboot now
    5. 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