Upgrading

How to upgrade the Anka Build Cloud

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

These steps also apply to downgrading

It is generally safe to upgrade the controller while VMs are running and nodes are joined. However, we do recommend temporarily pausing CI/CD jobs or assigning to agents and letting the currently running jobs drain before moving forward if you want to be extra careful

If upgrade the Anka Virtualization package:

  1. Block CI/CD jobs from starting or being assigned to agents
  2. Wait for all CI/CD jobs to complete on your nodes
  3. Run sudo ankacluster disjoin on each node

You can then safely install the latest Anka Build Virtualization CLI

If your existing Anka Virtualization version is noted in the Anka Virtualization Upgrade Matrix:

  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 <tag>

Before upgrading, check if your current version is noted in the Pre-Upgrade Considerations and adjust your upgrade plan accordingly.

  1. Go to your Controller & Registry server:

    • Docker:
      1. Make a backup of your docker-compose.yml.
      2. Download and extract the latest package.
      3. Configure the values in the docker-compose.yml or copy your previous docker-compose.yml to the new directory.
      4. Run docker-compose build to prepare the new docker tag.
      5. Run docker-compose down to take down the older version.
      6. Run docker-compose up -d in the newer version directory.
    • Native macOS package:
      1. Make a backup of your /usr/local/bin/anka-controllerd.
      2. Install the new .pkg (see the MacOS Guide).
      3. Run sudo anka-controller restart.

  2. Run curl -O http://**{controllerUrlHere}**/pkg/AnkaAgent.pkg && sudo installer -pkg AnkaAgent.pkg -tgt / on your nodes to pull the latest Anka Agent binary and ensure proper communication between the CLI and the Controller API.

Pre-Upgrade Considerations

Existing VersionTarget VersionRecommendation
1.2.11.5.2Upgrade Anka CLI package on all the hosts to atleast 2.1.X
1.2.11.5.2Recommended to upgrade Anka Registry to version 1.5.2, if you want to use cache builder
1.2.11.5.2Recommended to upgrade Anka Jenkins Plugin to version 1.22.2
1.2.11.5.2Recommended to upgrade Anka TeamCity Plugin to version 1.7.0
Existing VersionTarget VersionRecommendation
1.3.01.5.2Upgrade Anka CLI package on all the hosts to atleast 2.1.X
1.3.01.5.2Recommended to upgrade Anka Registry to version 1.5.2, if you want to use cache builder
1.3.01.5.2Recommended to upgrade Anka Jenkins Plugin to version 1.22.2
1.3.01.5.2Recommended to upgrade Anka TeamCity Plugin to version 1.7.0
Existing VersionTarget VersionRecommendation
1.4.01.5.2No need to upgrade Anka CLI package on hosts
1.4.01.5.2Recommended to upgrade Anka Registry to version 1.5.2, if you want to use cache builder
1.4.01.5.2Recommended to upgrade Anka Jenkins Plugin to version 1.22.2 but not necessary
1.4.01.5.2Recommended to upgrade Anka TeamCity Plugin to version 1.7.0 1.22.2 but not necessary
Existing VersionTarget VersionRecommendation
1.5.01.5.2No need to upgrade Anka CLI package on hosts
1.5.01.5.2Recommended to upgrade Anka Registry to version 1.5.2, if you want to use cache builder
1.5.01.5.2Recommended to upgrade Anka Jenkins Plugin to version 1.22.2, but not necessary
1.5.01.5.2Recommended to upgrade Anka TeamCity Plugin to version 1.7.0, but not necessary

Last modified November 20, 2020 : better upgrade documents (b2af666) by Nathan Pierce