SosreportUpdates

Revision 37 as of 2020-06-22 17:49:19

Clear message

This document describes the policy for updating sosreport package in a stable supported distro, including LTS. It is also the aim of this document to provide an example for any upstream project that wants to push updates to an Ubuntu stable release.

Sos is an extensible, portable, support data collection tool primarily aimed at Linux distributions and other UNIX-like operating systems. This tool is mission critical for Canonical to support UA (Ubuntu Advantage) customer, partners and community. Sosreport is also widely used by other third party vendors.

https://sos.readthedocs.io/en/latest/

http://github.com/sosreport/sos

Therefore, in addition to bug fixes, new features are allowed in an update as long as the conditions outlined below are met.

Process

This is the mandatory process that the proposed packages have to pass. The following requirements must be met:

  • Sosreport need to be tested by a significant amount of Canonical Support team members with positive and detailed feedbacks.
  • Sosreport need to be tested on physical hardware, container and Virtual Machine
  • Sosreport need to be tested in different context: cloud, MAAS, JuJu managed, ....

  • For each test above
    • Extract archive and look at the content, look for 0 size file (and use common sense if legit or not)
    • Look under "sos_reports" for full report.
    • Look under "sos_logs" for WARN and/or ERROR
      • $ grep -v "INFO:" sos_logs/sos.log
  • Run "simple.sh": A upstream port of the travis tests to bash. Generating various type of sosreport collections (which is part of the autopkgtest (d/test/simple.sh) now.

Requesting the SRU

The SRU should be requested as usual (StableReleaseUpdates) with the additional note about having the above steps being completed.