Hyperglance is deployed as a VM image with 2 volumes attached - one for the Operating System and one for data. Running on that VM is a set of containers managed by a Docker-Compose file located at /etc/docker-compose.yml
Instance/VM Login details
You need to access the Instance/SSH CLI in order to run the commands to 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.
To upgrade to the newest version of Hyperglance run the command sequence below. These commands first pull down the latest docker images and then re-initialise the services as needed. All your configuration, including rules, tag views and SAML configuration stay intact as these are stored in the data volume.
sudo docker-compose -f /etc/docker-compose.yml pull && sudo docker-compose -f /etc/docker-compose.yml up -d
NOTE: This requires Hyperglance to have internet in order to reach Docker Hub. If you wish to obtain access to repos on ECR or ACR please email email@example.com to request access.
After upgrading, all your user data will be retained, including authentication credentials, rules, and tag-view key
If you use Hyperglance with AWS always check if a new service has been added and check if the IAM policies need updating (IAM Policy Requirements)
To free up hard drive space you must now delete the old Docker images:
docker rmi $(docker images -a -q)
docker image prune
Scheduling Automatic Updates
If you want Hyperglance to automatically update you can set up a cron job in the Hyperglance VM. The example below sets the update to run once a day at midnight:
sudo crontab -e
0 0 * * * /usr/bin/docker-compose -f /etc/docker-compose.yml pull && /usr/bin/docker-compose -f /etc/docker-compose.yml up -d
(Find examples of other cron expressions here: https://crontab.cronhub.io/ )