How to upgrade the Anka Virtualization package

Upgrading the Build Cloud too? Check out our upgrade procedure for the Anka Build Cloud Controller & Registry

We do not follow strict semantic versioning; minor and major version increases can have significant changes

Upgrading Anka Virtualization software while VMs are running is typically safe.

Upgrade Procedure

  1. Download and install the latest version

NOTE: If your existing version is noted in the Pre-Upgrade Considerations, or, if you're going between major/minor versions of Anka:

  1. Upgrade the guest addons inside existing VM templates with anka start -u
  2. Push the newly upgraded VM templates to registry with anka registry push {vmNameOrUUID} --tag <newTag>

We cannot guarantee that suspended VMs will start properly between major and minor versions of Anka, though, we do try and ensure the compatibility.

Pre-Upgrade Considerations

Existing VersionTarget VersionRecommendation
1.4.32.x.xRequires upgrade of all existing VM templates with anka start --update and push to the registry
2.x2.1.2Only requires upgrade of existing Catalina VM templates with anka start --update and push to the registry
x.x2.xmacOS 10.14.X does not contain the necessary Apple APIs to work with 2.5.X of Anka. You will need to upgrade the host OS version before trying to install 2.5.X of Anka.

Upgrading macOS inside of a running VM

This scenario is possible, however, it's recommended that you upgrade Anka addons before upgrading macOS.

Anka VMs support softwareupdate and also the System Preferences method of upgrading. However, please ensure that Software Update and other settings are disabled enabled post-update as Apple can force re-enable these features.

Last modified October 11, 2021 : note about 10.14 and 2.5.X (f03b342) by Nathan Pierce