How to update the Hyperglance app

Find out how to update Hyperglance to the latest version, and schedule automatic updates

Hyperglance is deployed as a VM image with 2 volumes attached; one for the Operating System and one for data. A set of containers run on that VM, managed by a Docker-Compose file that's located at /etc/docker-compose.yml

Instance/VM Login Details

You need to access the Instance/SSH CLI to run the commands that will upgrade Hyperglance. In AWS, you can either SSH in, or use system manager access.

AWS SSH Login Details

The user login is ec2-user, root has been disabled. Use the SSH key defined when first deploying the instance.

Azure SSH Login Details

Use the user/password or the user/SSH key defined when you first deployed the VM.

How To Upgrade Hyperglance

One-Off Updates

1. To upgrade to the newest version of Hyperglance, you must run this command sequence:

sudo docker-compose -f /etc/docker-compose.yml pull && sudo docker-compose -f /etc/docker-compose.yml up -d

These commands pull down the latest docker images, then re-initialise the services. All your configuration, including rules, tag-views and SAML configuration stay intact as these are stored in the data volume.

Hyperglance requires an internet connection to reach Docker Hub. If you'd like access to repos on ECR/ACR, please contact the team.


2. To free up hard drive space, run these commands to delete the old Docker images:

docker rmi $(docker images -a -q)

docker image prune


3. If you use Hyperglance with AWS, check our release notes to see if a new service has been added, or any IAM policies need updating.

Updating the "Automations & Remediations" Terraform stack

It is a good idea to update your automations deployment at the same time as updating Hyperglance. See Updating the Hyperglance automation deployment.

Schedule Automatic Updates

If you'd like Hyperglance to update automatically, you can set up a cron job in the Hyperglance VM.

This example sets the update to run once a day at midnight: 

sudo crontab -e

0 0 * * * /usr/bin/docker image prune -f && /usr/bin/docker-compose -f /etc/docker-compose.yml pull && /usr/bin/docker-compose -f /etc/docker-compose.yml up -d

If you'd like to see/find other cron expressions, this is a great place to start.