mii-mon should have a consistent unit schema

Bug #1756587 reported by Mark Shuttleworth on 2018-03-17
10
This bug affects 1 person
Affects Status Importance Assigned to Milestone
netplan
High
Unassigned
netplan.io (Ubuntu)
High
Unassigned
Xenial
Undecided
Unassigned
Artful
Undecided
Unassigned
Bionic
Undecided
Unassigned
nplan (Ubuntu)
Undecided
Unassigned
Xenial
Undecided
Unassigned
Artful
Undecided
Unassigned
Bionic
Undecided
Unassigned

Bug Description

[Impact]
Documentation is confusing to users wishing to tune bond and bridge parameters. This potentially affects all users of netplan.

[Test case]
1) Update the netplan.io package.
2) Run 'man netplan'
3) Verify that the documentation under "parameters" for bridges and bonds is clear that time-based parameters are in milliseconds unless otherwise specified by the individual parameter:

For example, in the bonds section:
 - learn-packet-interval is in seconds
 - mii-monitor-interval, up-delay, down-delay, arp-interval are in milliseconds

[Regression potential]
Change is limited to the manpage; there is no risk of regression there, except for a garbled manpage or missing file. Any new bugs in netplan behavior found after this SRU that can't be reproduced with the immediately previous version should be investigated as potential toolchain / build issues introduced by the new build required for the SRU.

---

The docs say "Using the NetworkManager renderer, parameter values for intervals should be expressed in milliseconds; for the systemd renderer, they should be in seconds unless otherwise specified."

This however fails to encapsulate the description of the network in a form abstracted from the renderer. We should have a scheme which is clear, has one and only one explicit form, and works with all renderers.

Steve Langasek (vorlon) on 2018-03-27
Changed in netplan:
status: New → Triaged
importance: Undecided → High

The manpage is missing a doc update here, clearly.

We made sure the units were consistently milliseconds where appropriate (some parameters are always seconds, no matter what backend is used) late in the bionic cycle (LP: #1765833); the last of these updates included a doc change, but it didn't change it by much.

Let's fix this in a SRU.

Changed in netplan:
status: Triaged → In Progress
Changed in netplan.io (Ubuntu):
importance: Undecided → High
status: New → In Progress
description: updated

Doc changes are applied in git now; SRU in progress, but I'm debugging autopkgtest issues with intergration between it and systemd...

Changed in netplan:
status: In Progress → Fix Committed

Updating the bug tags to make it clear where we've landed this and where it hasn't been fixed yet, given the rename of nplan -> netplan.io in bionic.

Changed in nplan (Ubuntu):
status: New → Invalid
Changed in netplan.io (Ubuntu Xenial):
status: New → Invalid
Changed in netplan.io (Ubuntu Artful):
status: New → Invalid
Changed in nplan (Ubuntu Bionic):
status: New → Invalid

Hello Mark, or anyone else affected,

Accepted netplan.io into bionic-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/netplan.io/0.36.2 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-bionic to verification-done-bionic. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-bionic. In either case, without details of your testing we will not be able to proceed.

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

Changed in netplan.io (Ubuntu Bionic):
status: New → Fix Committed
tags: added: verification-needed verification-needed-bionic
Brian Murray (brian-murray) wrote :

Hello Mark, or anyone else affected,

Accepted nplan into artful-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/nplan/0.32~17.10.4 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-artful to verification-done-artful. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-artful. In either case, without details of your testing we will not be able to proceed.

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

Changed in nplan (Ubuntu Artful):
status: New → Fix Committed
tags: added: verification-needed-artful
Brian Murray (brian-murray) wrote :

Hello Mark, or anyone else affected,

Accepted nplan into xenial-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/nplan/0.32~16.04.5 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, without details of your testing we will not be able to proceed.

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

Changed in nplan (Ubuntu Xenial):
status: New → Fix Committed
tags: added: verification-needed-xenial
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package netplan.io - 0.37.1

---------------
netplan.io (0.37.1) cosmic; urgency=medium

  * tests/integration.py: fix autopkgtests to be less flaky, especially given
    changes in systemd-networkd's behavior regarding Router Advertisements.

 -- Mathieu Trudel-Lapierre <email address hidden> Fri, 11 May 2018 09:58:19 -0400

Changed in netplan.io (Ubuntu):
status: In Progress → Fix Released

Verification-done on bionic: netplan.io 0.36.2
Verification-done on artful: nplan 0.32~17.10.4
Verification-done on xenial: nplan 0.32~16.04.5

The updated documentation is available in the SRU'ed packages:

"""
[...] Unless otherwise specified, parameter values for time intervals should be expressed in milliseconds, but can also be expressed in seconds using a time suffix (such as "s" for seconds, "ms" for milliseconds).
"""

"""
              forward-delay (scalar)
                     Specify the period of time (in seconds) the bridge will remain in Listening and Learning states before getting to the
                     Forwarding state. This field maps to the ForwardDelaySec= property for the networkd renderer.
"""

tags: added: verification-done-artful verification-done-bionic verification-done-xenial
removed: verification-needed verification-needed-artful verification-needed-bionic verification-needed-xenial
Changed in netplan:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers