This is a companion app for the popular MacOS virtual machine host UTM to manage snapshots for existing virtual machines. UTM itself doesn't give access to that functionality so far; however the QEMU hypervisor which UTM leverages per default, offers snapshot management. This project is intended as proof-of-concept for that functionality and not as a releasable product – especially it doesn't support taking live snapshots, supports only the default QEMU hypervisor and doesn't come with a precompiled release binary (since I don't have a paid Apple Developer subscription to create an app package signed for distribution). However it should be perfectly possible to just download and compile it out of the box.
Clone the repository ( git clone [email protected]:Metamogul/UTM-Snapshot-Manager.git ), open the included project file in a recent XCode version (14.2. or newer) and build. There are no further source dependencies.
For it's functionality the app depends on qemu-img – it's basically a nice UI frontend for it. The app expects to find it at /opt/homebrew/bin/qemu-img. This dependency is not included. It can be installed as part of the brew qemu package via brew install qemu.
Use the navigation pane on the right to manage groups of VMs. A group can also just contain one virtual machine. With a group selected, virtual machines can be added via the ➕ icon in the navigation area. Every virtual machine in a group will display a list of it's snapshots or a placeholder if there are none. Use the ➕, ➖ and 🔄 icons in the central toolbar area to create, delete or restore a snapshot of the disks for every VM in the group. Open a context menu in an empty space at the bottom of a snapshot list to add a snapshot to just that single virtual machine's disk. Select a snapshot in a list and open a context menu to restore or delete just that particular snapshot.
Warning: Please keep in mind that the snapshot creation operates only on the disk files of the VMs. Don't use it on live VMs, because there's a very high risk of ending up with a corrupted file system due to uncommitted changes, unwritten caches etc.
During development and testing, I've discovered a number of minor issues with the UI which I didn't take the time to fix so far.
- When deleting the VM group directly over the creation button, the creation button will be highlighted until clicked again.
- Selecting a row in a snapshot table sometimes takes clicking on it twice or more, same goes for opening the context menu on it.
- When deleting a snapshot, occasionally a bunch of
=== AttributeGraph: cycle detected through attribute 787512 ===warnings show up in the debug log.
Feel free to contribute by creating a fork and issuing a pull request. When issuing a pull request, it would be nice if you could relate it to an open ticket so there's documentation later on.
If you're part of the UTM development team and want to incorporate such functionality into UTM, let me know. I'd be glad to help.
To report a bug, please create an issue ticket for it. In the ticket please provide a description of the state of the app, the action you've been performing, the expected outcome and the actual outcome. Also include your system architecture as reported by arch, the MacOS version you're on as reported by sw_vers, the XCode-Version you've been using as reported by xcodebuild -version as well as any other information that seems relevant to you.
This project is distributed under the permissive Apache 2.0 license as included. It doesn't use any other source components, packages or libraries under different licenses (apart from Apple's own system frameworks).
The app icon was taken from the orignal UTM project, where it's included with the source. If you're part of that project and feel that this is not appropriate, please contact me so I can replace it.
