← Back to team overview

sts-sponsors team mailing list archive

[Bug 1693574] Re: Docker plugin uses the wrong command for Ubuntu

 

I tested the packages in trusty, xenial, zesty and artful. The Docker
plugin runs well and gathers the expected information for Docker:

===================
Trusty

root@trustysosreport:/tmp/sosreport-trustysosreport-20180115193757# ls  sos_commands/docker/
docker_images  docker_inspect_c800e07175bf  docker_network_ls  docker_ps_-a   docker_stats_--no-stream  journalctl_--no-pager_--unit_docker
docker_info    docker_inspect_efc145e48b1e  docker_ps          docker_ps_-as  docker_version            ls_-alhR_.etc.docker

root@trustysosreport:/tmp/sosreport-trustysosreport-20180115193757# dpkg -l | grep -i sosreport
ii  sosreport                       3.5-1~ubuntu14.04.1                        amd64        Set of tools to gather troubleshooting data from a system

root@trustysosreport:/tmp/sosreport-trustysosreport-20180115193757# lsb_release -a
No LSB modules are available.
Distributor ID:	Ubuntu
Description:	Ubuntu 14.04.5 LTS
Release:	14.04
Codename:	trusty

===================
Xenial

root@xenialsosreport:/tmp/sosreport-xenialsosreport-20180115193800# ls sos_commands/docker/
docker_images  docker_inspect_3f8a4339aadd  docker_network_inspect_bridge  docker_network_inspect_none  docker_ps     docker_ps_-as             docker_version                       ls_-alhR_.etc.docker
docker_info    docker_inspect_60b785b1981b  docker_network_inspect_host    docker_network_ls            docker_ps_-a  docker_stats_--no-stream  journalctl_--no-pager_--unit_docker

root@xenialsosreport:/tmp/sosreport-xenialsosreport-20180115193800# dpkg -l | grep -i sosreport
ii  sosreport                     3.5-1~ubuntu16.04.1                        amd64        Set of tools to gather troubleshooting data from a system

root@xenialsosreport:/tmp/sosreport-xenialsosreport-20180115193800# lsb_release -a
No LSB modules are available.
Distributor ID:	Ubuntu
Description:	Ubuntu 16.04.3 LTS
Release:	16.04
Codename:	xenial

===================
Zesty

root@zestysosreport:/tmp/sosreport-zestysosreport-20180115193803# ls  sos_commands/docker/
docker_images  docker_inspect_3f8a4339aadd  docker_network_inspect_bridge  docker_network_inspect_none  docker_ps     docker_ps_-as             docker_version                       ls_-alhR_.etc.docker
docker_info    docker_inspect_f35ad9f7545c  docker_network_inspect_host    docker_network_ls            docker_ps_-a  docker_stats_--no-stream  journalctl_--no-pager_--unit_docker

root@zestysosreport:/tmp/sosreport-zestysosreport-20180115193803# dpkg -l | grep -i sosreport
ii  sosreport                     3.5-1~ubuntu17.04.1                     amd64        Set of tools to gather troubleshooting data from a system

root@zestysosreport:/tmp/sosreport-zestysosreport-20180115193803# lsb_release -a
No LSB modules are available.
Distributor ID:	Ubuntu
Description:	Ubuntu 17.04
Release:	17.04
Codename:	zesty

===================
Artful

root@artfulsosreport:/tmp/sosreport-artfulsosreport-20180115193802# ls sos_commands/docker/
docker_images  docker_inspect_3f8a4339aadd  docker_network_inspect_bridge  docker_network_inspect_none  docker_ps     docker_ps_-as             docker_version                       ls_-alhR_.etc.docker
docker_info    docker_inspect_f98581a186af  docker_network_inspect_host    docker_network_ls            docker_ps_-a  docker_stats_--no-stream  journalctl_--no-pager_--unit_docker

root@artfulsosreport:/tmp/sosreport-artfulsosreport-20180115193802# dpkg -l | grep -i sosreport
ii  sosreport                     3.5-1~ubuntu17.10.1               amd64        Set of tools to gather troubleshooting data from a system

root@artfulsosreport:/tmp/sosreport-artfulsosreport-20180115193802# lsb_release -a
No LSB modules are available.
Distributor ID:	Ubuntu
Description:	Ubuntu 17.10
Release:	17.10
Codename:	artful

-- 
You received this bug notification because you are a member of STS
Sponsors, which is subscribed to the bug report.
https://bugs.launchpad.net/bugs/1693574

Title:
  Docker plugin uses the wrong command for Ubuntu

Status in sosreport:
  Fix Released
Status in sosreport package in Ubuntu:
  Fix Released
Status in sosreport source package in Trusty:
  Fix Committed
Status in sosreport source package in Xenial:
  Fix Committed
Status in sosreport source package in Zesty:
  Fix Committed
Status in sosreport source package in Artful:
  Fix Committed
Status in sosreport package in Debian:
  Fix Released

Bug description:
  [Impact]

  The docker plugin in sosreport doesn't collect informations for
  Ubuntu.

  In docker.py for the Ubuntu Plugin, the docker command is set to
  'docker.io'[1] which seems to be a old workaround that has been
  removed[2], thus the docker plugin is no longer calling an existing
  docker binary which as a result doesn't collect docker informations in
  Ubuntu.

  [1]- Plugin : docker.py

  # Name collision with another package requires docker binary rename
  docker_cmd = 'docker.io'

  [2]- docker.io package : debian/changelog

  docker.io (1.3.1~dfsg1-2) unstable; urgency=medium
  * Remove deprecated /usr/bin/docker.io symlink
  - added as a temporary shim in 1.0.0~dfsg1-1 (13 Jun 2014)
  - unused by package-installed files in 1.2.0~dfsg1-1 (13 Sep 2014)
  -- Tianon Gravi <admwiggin@xxxxxxxxx> Fri, 07 Nov 2014 13:11:34 -0700

  [Test Case]

  # Install sosreport from the Ubuntu archive
  $ apt-get update
  $ apt-get install sosreport

  # Install Docker from the Ubuntu archive
  $ apt-get install docker.io

  # Run sosreport with docker plugin only or all loaded plugins (for the
  sake of testing docker plugin the "-o" is more appropriate

  Docker plugin only :
  $ sosreport -o docker

  All loaded plugins:
  $ sosreport -a

  # Extract the sosreport*.tar.xz file generated by the above command
  found in /tmp and verify that information is gathered properly

  [Regression Potential]

  No regression, this is a trivial fix that will allow sosreport to
  start collecting the docker informations again.

  If for some reasons, a regression is found, it would be 100% limited
  to docker plugin of sosreport and not affecting the functionality the
  core functionality nor other plugins.

  [Other Info]

  Additional informations about the context can be found here :
  https://bugs.launchpad.net/ubuntu/+source/docker.io/+bug/1338768

  * Upstream Bug
  https://github.com/sosreport/sos/issues/930

  * Pull Request
  https://github.com/sosreport/sos/pull/1009
  https://github.com/sosreport/sos/pull/1009/commits/f8a939d792d8ac683f341458b8cf77a35c4db929

  * Debian Bug :
  https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=863374
  (Patch submitted to Debian on June 2 2017)

  * Ubuntu Bug :
  Working on a backport into stable release (SRU) which will include this change via (LP: #1734983).

  [Original Description]

  This Launchpad bug is based on an existing GitHub bug[1].

  The docker plugin is currently broken in sosreport. In docker.py[2]
  for Ubuntu the docker command is set to 'docker.io'.

      docker_cmd = 'docker.io'

  The docker.io package used to have a docker.io binary but this was
  reverted in this debian/changelog from Ubuntu Xenial/16.04 (LTS):

   docker.io (1.3.1~dfsg1-2) unstable; urgency=medium
      * Remove deprecated /usr/bin/docker.io symlink
        - added as a temporary shim in 1.0.0~dfsg1-1 (13 Jun 2014)
        - unused by package-installed files in 1.2.0~dfsg1-1 (13 Sep 2014)
     -- Tianon Gravi <admwiggin@xxxxxxxxx>  Fri, 07 Nov 2014 13:11:34 -0700

  The Docker Community and Enterprise Editions (docker-ce and docker-ee
  packages) also use the plain docker binary and this change is
  necessary to make the sosreport docker module work again.

  There are currently two different pull requests that fix this issue:

  https://github.com/sosreport/sos/pull/1009
  https://github.com/sosreport/sos/pull/1012

  We should SRU this fix once one of them is accepted.

  [1] https://github.com/sosreport/sos/issues/930
  [2] https://github.com/sosreport/sos/blob/master/sos/plugins/docker.py

To manage notifications about this bug go to:
https://bugs.launchpad.net/sosreport/+bug/1693574/+subscriptions