group.of.nepali.translators team mailing list archive

Thread
Date
[Bug 1925351] Re: [sos39][networking] dpdk port flapping observed during sosreport execution

To: group.of.nepali.translators@xxxxxxxxxxxxxxxxxxx
From: Eric Desrochers <1925351@xxxxxxxxxxxxxxxxxx>
Date: Thu, 22 Apr 2021 13:59:41 -0000
Reply-to: Bug 1925351 <1925351@xxxxxxxxxxxxxxxxxx>
Sender: bounces@xxxxxxxxxxxxx
** Description changed:

  [IMPACT]
  
  sosreport networking plugin unconditionally exercise 'ethtool -e'.
  
  EEPROM dump collection might hang on specific types of devices,
  
  ETHTOOL(8)
         -e --eeprom-dump
                Retrieves and prints an EEPROM dump for the specified network device.  When raw is enabled,  then  it dumps  the raw EEPROM data to stdout. The length and offset parameters allow dumping certain portions of the EEPROM.  Default is to dump the entire EEPROM.
  
  [TEST PLAN]
  
  * On a xenial system
  
  ## Should not execute 'ethtool -e' (New default behaviour)
  * sosreport -o networking
  
  ## Should execute 'ethtool -e'. (Only if sosreport is instructed to do so (AKA former default behaviour))
  * sosreport -o networking --plugin-option networking.eepromdump
  
  ## Should not execute 'ethtool -e' with -a (if with appropriate tunables in /etc/sos.conf)
  ---
  [tunables]
  networking.eepromdump = off
  ---
  
  ## Should execute 'ethtool -e' with -a (if without appropriate tunables
  in /etc/sos.conf)
  
  [WHERE PROBLEM OCCURS]
  
  No problem expected.
  
  networking plugin will be gated to prevent 'ethtool -e' to be run by
  default, so that 'sosreport -o networking' will now no longer execute
  'ethtool -e' command.
  
  On the other end, if one really want to eepromdump, one can use the
  'eepromdump' plugin option as follows:
  
  sosreport -o networking --plugin-option networking.eepromdump
  
  Yes, we are changing the default behaviour for good reasons as it may
  produce more harm than good the way it is at the moment, BUT the former
  behaviour is still available if *REALLY* needed, and after knowing the
  risk that this could occur.
  
  Note:
  sosreport -a ## Will still execute 'ethtool -e' as it turns all options to 'True'.
  
         -a, --alloptions
                Set all boolean options to True for all enabled plug-ins.
  
  Unless one specify the following in /etc/sos.conf:
  ---
  [tunables]
  networking.eepromdump = off
  ---
  
  so 'sosreport -a' with a combination of adding the right tunables in
  /etc/sos.conf will prevent 'ethtool_e' to be executed.
  
  [OTHER INFORMATION]
  
  Upstream fix:
- https://github.com/sosreport/sos/commit/bc3b7eefa093af150286ad6c345cef6afe282756
+ https://github.com/sosreport/sos/commit/a74ef444a72691fab9c65fa679687cc2d6e0fc8c
+ 
+ $ git describe --contains aca8bd83
+ 4.1~44
+ 
+ $ rmadison sosreport
+ => sosreport | 3.9.1-1ubuntu0.16.04.1    | xenial-updates 
+ sosreport | 4.1-1ubuntu0.18.04.1         | bionic-updates            
+ sosreport | 4.1-1ubuntu0.20.04.1         | focal-updates 
+ sosreport | 4.1-1ubuntu0.20.10.1         | groovy-updates    
+ sosreport | 4.1-1ubuntu1                 | hirsute

** Also affects: sosreport (Ubuntu Focal)
   Importance: Undecided
       Status: New

** Also affects: sosreport (Ubuntu Groovy)
   Importance: Undecided
       Status: New

** Also affects: sosreport (Ubuntu Hirsute)
   Importance: Undecided
       Status: Fix Released

** Also affects: sosreport (Ubuntu Bionic)
   Importance: Undecided
       Status: New

** Changed in: sosreport (Ubuntu Bionic)
       Status: New => Fix Released

** Changed in: sosreport (Ubuntu Focal)
       Status: New => Fix Released

** Changed in: sosreport (Ubuntu Groovy)
       Status: New => Fix Released

-- 
You received this bug notification because you are a member of नेपाली
भाषा समायोजकहरुको समूह, which is subscribed to Xenial.
Matching subscriptions: Ubuntu 16.04 Bugs
https://bugs.launchpad.net/bugs/1925351

Title:
  [sos39][networking] dpdk port flapping observed during sosreport
  execution

Status in sosreport package in Ubuntu:
  Fix Released
Status in sosreport source package in Xenial:
  In Progress
Status in sosreport source package in Bionic:
  Fix Released
Status in sosreport source package in Focal:
  Fix Released
Status in sosreport source package in Groovy:
  Fix Released
Status in sosreport source package in Hirsute:
  Fix Released

Bug description:
  [IMPACT]

  sosreport networking plugin unconditionally exercise 'ethtool -e'.

  EEPROM dump collection might hang on specific types of devices,

  ETHTOOL(8)
         -e --eeprom-dump
                Retrieves and prints an EEPROM dump for the specified network device.  When raw is enabled,  then  it dumps  the raw EEPROM data to stdout. The length and offset parameters allow dumping certain portions of the EEPROM.  Default is to dump the entire EEPROM.

  [TEST PLAN]

  * On a xenial system

  ## Should not execute 'ethtool -e' (New default behaviour)
  * sosreport -o networking

  ## Should execute 'ethtool -e'. (Only if sosreport is instructed to do so (AKA former default behaviour))
  * sosreport -o networking --plugin-option networking.eepromdump

  ## Should not execute 'ethtool -e' with -a (if with appropriate tunables in /etc/sos.conf)
  ---
  [tunables]
  networking.eepromdump = off
  ---

  ## Should execute 'ethtool -e' with -a (if without appropriate
  tunables in /etc/sos.conf)

  [WHERE PROBLEM OCCURS]

  No problem expected.

  networking plugin will be gated to prevent 'ethtool -e' to be run by
  default, so that 'sosreport -o networking' will now no longer execute
  'ethtool -e' command.

  On the other end, if one really want to eepromdump, one can use the
  'eepromdump' plugin option as follows:

  sosreport -o networking --plugin-option networking.eepromdump

  Yes, we are changing the default behaviour for good reasons as it may
  produce more harm than good the way it is at the moment, BUT the
  former behaviour is still available if *REALLY* needed, and after
  knowing the risk that this could occur.

  Note:
  sosreport -a ## Will still execute 'ethtool -e' as it turns all options to 'True'.

         -a, --alloptions
                Set all boolean options to True for all enabled plug-ins.

  Unless one specify the following in /etc/sos.conf:
  ---
  [tunables]
  networking.eepromdump = off
  ---

  so 'sosreport -a' with a combination of adding the right tunables in
  /etc/sos.conf will prevent 'ethtool_e' to be executed.

  [OTHER INFORMATION]

  Upstream fix:
  https://github.com/sosreport/sos/commit/a74ef444a72691fab9c65fa679687cc2d6e0fc8c

  $ git describe --contains aca8bd83
  4.1~44

  $ rmadison sosreport
  => sosreport | 3.9.1-1ubuntu0.16.04.1    | xenial-updates 
  sosreport | 4.1-1ubuntu0.18.04.1         | bionic-updates            
  sosreport | 4.1-1ubuntu0.20.04.1         | focal-updates 
  sosreport | 4.1-1ubuntu0.20.10.1         | groovy-updates    
  sosreport | 4.1-1ubuntu1                 | hirsute

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/sosreport/+bug/1925351/+subscriptions
References

[Bug 1925351] [NEW] [networking] dpdk port flapping observed during sosreport execution
From: Eric Desrochers, 2021-04-21