fanctl does not stop setup on first match

[Stefan Bader]

SRU Justification (Zesty/Xenial)

Impact: When /etc/network/fan contains two entries for the same mapping (for example on mapping for the generic network mapping and one for a specific interface) it will try to set up the same Fan bridge twice.

Fix: Modify fanctl to only bring up enabled networks in auto mode and to correctly apply the most specific local configuration.

Testcase: If in an environment that uses one of the 192.168.0.0/16 subnets, and host has for example a 192.168.1.0/24 address. Then trying to use
 fanatic enable-fan -u 192.168.1.x/24 -o 250.0.0.0/8
would show an error now and with the fix applied work ok.

Regression Potential: We tested both cases of using an underlay/overlay combination which is in the template section and one that was using a subset for the underlay. The former was working before the latter not. For that reason we anticipate a low risk of regression.

[Andy Whitcroft (apw)]

This is occuring because fanatic is trying to bring up the newly configured Fan Network as if it had been brought up automatically. This is done to bring the system into a state that is equivalent to having had the configuration for this Fan Network at boot time. However it does it using an interface which appear to fanctl as a user "who knows what they are doing", and it brings up all matching prefixes; in this case a prefix which is purely in the file as an example/preferred configuration.

[Andy Whitcroft (apw)]

We actually only want to bring up enabled Fan Networks, fanatic is indicating this via its use of --auto. Use this to modify the config scanner.

Does the attached (untested) patch help.

[Launchpad Janitor (janitor)]

This bug was fixed in the package ubuntu-fan - 0.12.4

---------------
ubuntu-fan (0.12.4) artful; urgency=medium

  [ Andy Whitcroft ]
  * fanctl: only bring up enabled Fan Networks in --auto mode (LP: #1707610)
  * fanctl: correctly specify local interface specific config (LP: #1707610)
  * fanatic: recast advanced commands as non-interactive
  * fanatic: fix spelling in primary help
  * fanatic: fix references to fanatic manual page

  [ Stefan Bader ]
  * fanatic: Fix typo in progress output
  * README: Refresh documentation
  * fanctl.8: Refresh documentation
  * fanatic.8: Refresh documentation
  * fanatic.8: Reword advanced to non-interactive usage
  * DEP8: lxd: Suppress stderr on profile list

 -- Stefan Bader <email address hidden> Wed, 16 Aug 2017 15:58:46 +0200

[Brian Murray (brian-murray)]

The SRU information in the bug description is missing a "Regression Potential" section.

[Łukasz Zemczak (sil2100)]

Hello Stefan, or anyone else affected,

Accepted ubuntu-fan into zesty-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/ubuntu-fan/0.12.4~17.04.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed.Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested and change the tag from verification-needed-zesty to verification-done-zesty. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-zesty. In either case, details of your testing will help us make a better decision.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance!

[Łukasz Zemczak (sil2100)]

In some of the changes for fanctl I see a lot of commented-out debugging 'echo' statements. Maybe it would be nice to get those cleaned up with one day for all releases.

[Stefan Bader (smb)]

Verified that upgrading to 0.12.4~17.04.1 allows to enable a Fan Bridge using an underlay of 192.168.122.0/24 (this failed with the current version).
Manually ran both docker and LXD self-test. The commented out debug echos are actually deliberate to be enabled if in need.

[Launchpad Janitor (janitor)]

This bug was fixed in the package ubuntu-fan - 0.12.4~17.04.1

---------------
ubuntu-fan (0.12.4~17.04.1) zesty; urgency=medium

  [ Andy Whitcroft ]
  * fanctl: only bring up enabled Fan Networks in --auto mode (LP: #1707610)
  * fanctl: correctly specify local interface specific config (LP: #1707610)
  * fanatic: recast advanced commands as non-interactive (LP: #1714966)
  * fanatic: fix spelling in primary help (LP: #1714966)
  * fanatic: fix references to fanatic manual page (LP: #1714966)

  [ Stefan Bader ]
  * fanatic: Fix typo in progress output (LP: #1714966)
  * README: Refresh documentation (LP: #1714966)
  * fanctl.8: Refresh documentation (LP: #1714966)
  * fanatic.8: Refresh documentation (LP: #1714966)
  * fanatic.8: Reword advanced to non-interactive usage (LP: #1714966)
  * DEP8: lxd: Suppress stderr on profile list (LP: #1714969)

 -- Stefan Bader <email address hidden> Fri, 18 Aug 2017 14:34:47 +0200

[Brian Murray (brian-murray)]

The verification of the Stable Release Update for ubuntu-fan has completed successfully and the package has now been released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.

[Łukasz Zemczak (sil2100)]

Hello Stefan, or anyone else affected,

Accepted ubuntu-fan into xenial-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/ubuntu-fan/0.12.7~16.04.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed.Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested and change the tag from verification-needed-xenial to verification-done-xenial. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-xenial. In either case, details of your testing will help us make a better decision.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance!

[Łukasz Zemczak (sil2100)]

Hello Stefan, or anyone else affected,

Accepted ubuntu-fan into xenial-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/ubuntu-fan/0.12.8~16.04.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed.Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested and change the tag from verification-needed-xenial to verification-done-xenial. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-xenial. In either case, details of your testing will help us make a better decision.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance!

[Stefan Bader (smb)]

dpkg -l|grep fan
ii ubuntu-fan 0.12.8~16.04.1 all Ubuntu FAN network support enablement

ip address show ens8
3: ens8: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000
    link/ether 52:54:00:be:54:c2 brd ff:ff:ff:ff:ff:ff
    inet 192.168.2.126/24 brd 192.168.2.255 scope global ens8

sudo fanatic enable-fan -u 192.168.2.0/24 -o 250.0.0.0/8
configuring fan underlay:192.168.2.0/24 overlay:250.0.0.0/8

fanctl show
Bridge Underlay Overlay Flags
fan-250 192.168.2.126/24 250.0.0.0/8 enable dhcp

[Launchpad Janitor (janitor)]

This bug was fixed in the package ubuntu-fan - 0.12.8~16.04.1

---------------
ubuntu-fan (0.12.8~16.04.1) xenial; urgency=medium

  * fanatic: Optionally provide DNS server for docker test (LP: #1732717)

ubuntu-fan (0.12.7~16.04.1) xenial; urgency=medium

  * fanctl: cmd_up needs to proparate scan_config errors (LP: #1719644)
  * fanatic: Clean up config if bringup fails (LP: #1728050)

ubuntu-fan (0.12.6~16.04.1) xenial; urgency=medium

  [ 0.12.5 ]
  * DEP8: Fix LXD default interface detection (LP: #1732739)
  * fanctl: return error on fail_up (LP: #1719644)

  [ 0.12.6 ]
  * fanatic: Add short success delay to nc_send (LP: #1721352)
  * fanatic: Catch test preparation steps failing (LP: #1735183)
  * fanatic: Add DNS checks to local-test preparation (LP: #1732747)

ubuntu-fan (0.12.4~16.04.1) xenial; urgency=medium

  [ Andy Whitcroft ]
  * fanctl.8: fix interfane type (LP: #1584845)
  * debian/control: fix use of obsolete > operator (LP: #1714969)
  * fanctl: only bring up enabled Fan Networks in --auto mode (LP: #1707610)
  * fanctl: correctly specify local interface specific config (LP: #1707610)
  * fanatic: recast advanced commands as non-interactive (LP: #1714966)
  * fanatic: fix spelling in primary help (LP: #1714966)
  * fanatic: fix references to fanatic manual page (LP: #1714966)

  [ Stefan Bader ]
  * fanatic: fix local testing and improve docker test (LP: #1714969)
  * fanatic: Support nc -N option (LP: #1714969)
  * fanatic: Prevent error message without docker installed (LP: #1714969)
  * fanatic: Supply LXD storage if needed (LP: #1714969)
  * dep8: Add LXD auto-test (LP: #1714969)
  * fanatic: Fix typo in progress output (LP: #1714966)
  * README: Refresh documentation (LP: #1714966)
  * fanctl.8: Refresh documentation (LP: #1714966)
  * fanatic.8: Refresh documentation (LP: #1714966)
  * fanatic.8: Reword advanced to non-interactive usage (LP: #1714966)
  * DEP8: lxd: Suppress stderr on profile list (LP: #1714969)

 -- Stefan Bader <email address hidden> Wed, 29 Nov 2017 16:17:26 +0100