This document describes the policy for updating ubuntu-advantage-tools and ubuntu-advantage-pro deb packages into a stable supported release.

In order to add Ubuntu Advantage support services to all supported LTS, ubuntu-advantage-tools will need to be updated periodically to add support for new services offered on those Ubuntu releases. Regular (non-LTS) releases will likely not have many available support services, so risk is limited on regular releases.

The ubuntu-advantage-tools is a python client used to attach machines to existing Ubuntu Advantage support contracts and initialize support services such as livepatch, fips, esm and common criteria EAL2. It is a command line interface providing a single point of entry for enabling, disabling and maintaining Ubuntu Advantage support services on a single machine or cloud instance. It interacts with a backend https://contracts.canonical.com with GETs and POSTs over https to extract configuration directives to add or remove apt repos, install deb packages and/or snaps (in the case of livepatch).

Any services managed by ubuntu-advantage-tools are described in detail in https://ubuntu.com/advantage.

The ubuntu-advantage-client repository is the repository from which all ubuntu-advantage-tools and ubuntu-advantage-pro packages are built as well as where CI for the project is run.

The intent of the main branch is to support all Ubuntu releases from 16.04 (Xenial) through devel out of the box without release-specific changes, though functionality is limited on non-LTS releases. The SRU process for ubuntu-advantage-tools will target any supported LTS releases as well as the most recent supported regular release.

Since ubuntu-advantage-tools is the primary mechanism for obtaining Ubuntu Advantage support services on cloud-images (AWS, Azure, GCP), verification is required on applicable cloud platforms, Ubuntu Pro images, lxc containers and kvm images.

Therefore, the following types of changes are allowed as long as the processes outlined below are followed:

  • Bug fixes
  • New features

In the event of a change breaking backwards compatibility, then SRU team approval will need to be obtained by emailing the ubuntu-release team mailing list.

Requesting the SRU

The SRU should be done with a single process bug, instead of individual bug reports for individual bug fixes. The one bug should have the following:

  • The SRU should be requested per the StableReleaseUpdates documented process

  • The template at the end of this document should be used and all ‘TODO’ filled out
  • The change log will contain a reference to the single SRU process bug, not all bugs fixed by the SRU. However, if there are very important bugs that are deemed worthy of reference they too should be included in the change log.
  • Major changes should be called out in the SRU template, especially where changed behavior is not backward compatible.
  • For each release (e.g. Ubuntu 16.04, 18.04 etc.) that is targeted by the SRU, a link to the results of integration testing for at least the following cloud platforms must be provided:
    • CI success runs covering the *-proposed version ubuntu-advantage-tools:
      • LXD VM and container of all LTS and regular (e.g. Eoan) releases targeted by the SRU.
      • EC2 Ubuntu Pro images and standard Canonical cloud images on all LTS releases
      • Azure Ubuntu Pro images and standard Canonical cloud images on all LTS releases
      • GCP Ubuntu Pro images and standard Canonical cloud images on all LTS releases
      • LTS to LTS upgrade test of attached machine for all affected LTS
      • LTS to LTS upgrade test of unattached machine for all affected LTS
  • Any architecture-specific fixes need to be noted and architecture-specific test results included
  • Any packaging changes (e.g. a dependency change) need to be stated, and appropriate separate test cases provided
  • If any manual testing occurs it should also be documented with a comment and attached manual logs

QA Process

  • ubuntu-advantage-client repo has a suite of automated integration tests that cover AWS Pro, lxc container and kvm images and exercise the bulk of features functionality delivered on trusty, xenial, bionic and focal. CI runs both tip of main against daily cloudimages and against any https://github.com/canonical/ubuntu-advantage-client/pulls before merging. Additional manual missing manual verification will be attached to each SRU process bug.


Updates to tip of ubuntu-advantage-tools:main go through the following process:

  • Reviewed and approved by a member of the development team (Canonical Ubuntu server team only)
  • Daily integration tests on tip
  • Successful run of unit tests, style and integration tests based on the branch
  • Branch manually set to the merged state by the approving development member with commit access.


The following describes the requirements for each package generated for the SRU.

For each package generated a successful completion of ubuntu-advantage-tools integration tests, as described above in https://wiki.ubuntu.com/UbuntuAdvantageToolsUpdates#Requesting_the_SRU, using the proposed package with no unexplained errors or failures

The ubuntu-advantage-tools team (Canonical's Ubuntu Server team) will be in charge of attaching the artifacts and console output of the appropriate run to the bug. ubuntu-advantage-tools team members will not mark ‘verification-done’ until this has happened.

SRU Template

== Begin SRU Template ==
This release sports both bug-fixes and new features and we would like to
make sure all of our supported customers have access to these
improvements. The notable ones are:

   * <TODO: Create list with LP: # included>

See the changelog entry below for a full list of changes and bugs.

[Test Case]
The following development and SRU process was followed:

The ubuntu-advantage-tools team will be in charge of attaching the artifacts and
console output of the appropriate run to the bug.  ubuntu-advantage-tools team
members will not mark ‘verification-done’ until this has happened.

* Automated Test Results
Attach or link the following automated integration test runs for ubuntu-advantage-tools on each affected LTS release:

- lxd.container platform
- lxd.kvm platform
- AWS Ubuntu PRO
- AWS Ubuntu cloud-images (non-Pro)

- Azure Ubuntu PRO
- Azure Ubuntu cloud-images (non-Pro)

- GCP Ubuntu PRO
- GCP Ubuntu cloud-images (non-Pro)

[Regression Potential]
In order to mitigate the regression potential, the results of the
aforementioned integration tests are attached to this bug.

<TODO: other background>

== End SRU Template ==

<TODO: Paste in change log entry>

Past SRUs

Links to past SRUs using this process are below:

SRU Version

SRU bug

UbuntuAdvantageToolsUpdates (last edited 2021-09-30 16:35:30 by chad.smith)