eni rendering broken for bridge params that require repeated key for values

Bug #1706752 reported by Scott Moser on 2017-07-26
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
cloud-init
Medium
Unassigned
cloud-init (Ubuntu)
Medium
Unassigned
Xenial
Medium
Unassigned
Zesty
Medium
Unassigned
Artful
Medium
Unassigned

Bug Description

=== Begin SRU Template ===
[Impact]
ENI rendering of bridge configuration options for bridge_pathcost, bridge_portprio and bridge_waitport would be limited to a single key/val pair. Now support multi-line key values for these configuration options.

[Test Case]
if [ ! -f lxc-proposed-snapshot ]; then
  wget https://git.launchpad.net/~smoser/cloud-init/+git/sru-info/plain/bin/lxc-proposed-snapshot -O lxc-proposed-snapshot
  chmod 755 lxc-proposed-snapshot
fi

## get render tool
$ wget https://git.launchpad.net/~cloud-init-dev/cloud-init/plain/tools/net-convert.py -O net-convert.py

## write the network_data.json
$ cat >network_data.yaml <<EOF
version: 1
config:
    - type: physical
      name: eth0
      mac_address: "c0:d6:9f:2c:e8:80"
    - type: physical
      name: eth1
      mac_address: "aa:d6:9f:2c:e8:80"
    - type: bridge
      name: br0
      bridge_interfaces:
        - eth0
        - eth1
      params:
        bridge_ageing: 250
        bridge_bridgeprio: 22
        bridge_fd: 1
        bridge_gcint: 2
        bridge_hello: 1
        bridge_maxage: 10
        bridge_maxwait: 0
        bridge_pathcost:
          - eth0 50
          - eth1 75
        bridge_portprio:
          - eth0 28
          - eth1 14
        bridge_stp: 'off'
        bridge_waitport:
          - 1 eth0
          - 2 eth1
EOF

for release in xenial zesty; do
        ref=$release-proposed;
        echo "$release START --------------";
        ./lxc-proposed-snapshot --proposed --publish $release $ref;
        lxc start test-$release;
        lxc file push net-convert.py test-$release/net-convery.py;
        lxc file push network_data.yaml test-$release/network_data.yaml;
        for k in eni netplan; do
            lxc exec test-$release -- python3 /net-convert.py \
            --network-data=net-config.yaml --kind=yaml \
            --output-kind=$k --mac=eth0,c0:d6:9f:2c:e8:80 \
            --directory=out.d ;
        done
        lxc exec test-$release -- cat out.d/etc/network/interfaces
        lxc exec test-$release -- cat out.d/etc/netplan/50-cloud-init.yaml
done

[Regression Potential]
Fairly low, this feature adds support for multi-line keys for 3 specific bridge configuration options bridge_pathcost, bridge_portprio and bridge_waitport.
Prior releases didn't have this support and would have only allowed for a single configuration value for the key. Now the configuration is properly rendered for multiple-interfaces.

[Other Info]
Upstream commit at
  https://git.launchpad.net/cloud-init/commit/?id=00b678c61

This is fixed in cloud-init via commit 00b678c61a.

 Fix eni rendering for bridge params that require repeated key for values.

 There are a few bridge parameters which require repeating the key with each
 value in the list when rendering eni. Extend the network unittests to cover
 all of the known bridge parameters and check we render eni and netplan
 correctly.

ProblemType: Bug
DistroRelease: Ubuntu 17.04
Package: cloud-init 0.7.9-90-g61eb03fe-0ubuntu1
ProcVersionSignature: Ubuntu 4.10.0-26.30-generic 4.10.17
Uname: Linux 4.10.0-26-generic x86_64
NonfreeKernelModules: zfs zunicode zavl zcommon znvpair
ApportVersion: 2.20.4-0ubuntu4.5
Architecture: amd64
Date: Wed Jul 26 19:33:36 2017
PackageArchitecture: all
ProcEnviron:
 TERM=xterm-256color
 PATH=(custom, no user)
 LANG=C.UTF-8
SourcePackage: cloud-init
UpgradeStatus: No upgrade log present (probably fresh install)

Scott Moser (smoser) wrote :
Changed in cloud-init:
status: New → Fix Committed
importance: Undecided → Medium
Changed in cloud-init (Ubuntu):
status: New → Fix Released
importance: Undecided → Medium
Changed in cloud-init (Ubuntu Xenial):
status: New → Confirmed
Changed in cloud-init (Ubuntu Zesty):
status: New → Confirmed
Changed in cloud-init (Ubuntu Xenial):
importance: Undecided → Medium
Changed in cloud-init (Ubuntu Zesty):
importance: Undecided → Medium
Scott Moser (smoser) on 2017-08-01
description: updated
Chad Smith (chad.smith) on 2017-08-01
description: updated
Scott Moser (smoser) on 2017-08-04
description: updated

Hello Scott, or anyone else affected,

Accepted cloud-init into xenial-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/cloud-init/0.7.9-233-ge586fe35-0ubuntu1~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!

Changed in cloud-init (Ubuntu Xenial):
status: Confirmed → Fix Committed
tags: added: verification-needed verification-needed-xenial
Changed in cloud-init (Ubuntu Zesty):
status: Confirmed → Fix Committed
tags: added: verification-needed-zesty
Chris J Arges (arges) wrote :

Hello Scott, or anyone else affected,

Accepted cloud-init into zesty-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/cloud-init/0.7.9-233-ge586fe35-0ubuntu1~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!

Chad Smith (chad.smith) wrote :
Download full text (11.5 KiB)

# validated xenial and zesty network configuration output with net-convert.py

csmith@fringe:~$ for release in xenial zesty; do
> echo "$release START --------------";
> lxc exec test-$release -- grep CODENAME /etc/lsb-release;
> lxc exec test-$release -- dpkg-query --show cloud-init;
> lxc file push net-convert.py test-$release/net-convert.py;
> lxc file push network_data.yaml test-$release/network_data.yaml;
> for k in eni netplan; do
> lxc exec test-$release -- python3 /net-convert.py \
> --network-data=/network_data.yaml --kind=yaml \
> --output-kind=$k --mac=eth0,c0:d6:9f:2c:e8:80 \
> --directory=out.d ;
> done;
> lxc exec test-$release -- cat out.d/etc/network/interfaces;
> lxc exec test-$release -- cat out.d/etc/netplan/50-cloud-init.yaml
>
> echo "$release FINISH --------------";
> done
xenial START --------------

DISTRIB_CODENAME=xenial
cloud-init 0.7.9-233-ge586fe35-0ubuntu1~16.04.1
Input YAML
config:
- mac_address: c0:d6:9f:2c:e8:80
    name: eth0
    type: physical
- mac_address: aa:d6:9f:2c:e8:80
    name: eth1
    type: physical
- bridge_interfaces:
    - eth0
    - eth1
    name: br0
    params:
        bridge_ageing: 250
        bridge_bridgeprio: 22
        bridge_fd: 1
        bridge_gcint: 2
        bridge_hello: 1
        bridge_maxage: 10
        bridge_maxwait: 0
        bridge_pathcost:
        - eth0 50
        - eth1 75
        bridge_portprio:
        - eth0 28
        - eth1 14
        bridge_stp: 'off'
        bridge_waitport:
        - 1 eth0
        - 2 eth1
    type: bridge
version: 1

Internal State
!!python/object:cloudinit.net.network_state.NetworkState
_network_state:
    dns:
        nameservers: []
        search: []
    interfaces:
        br0:
            address: null
            bridge_ageing: 250
            bridge_bridgeprio: 22
            bridge_fd: 1
            bridge_gcint: 2
            bridge_hello: 1
            bridge_maxage: 10
            bridge_maxwait: 0
            bridge_pathcost:
            - eth0 50
            - eth1 75
            bridge_portprio:
            - eth0 28
            - eth1 14
            bridge_ports:
            - eth0
            - eth1
            bridge_stp: 'off'
            bridge_waitport:
            - 1 eth0
            - 2 eth1
            gateway: null
            inet: inet
            mac_address: null
            mode: manual
            mtu: null
            name: br0
            subnets: []
            type: bridge
        eth0:
            address: null
            gateway: null
            inet: inet
            mac_address: c0:d6:9f:2c:e8:80
            mode: manual
            mtu: null
            name: eth0
            subnets: []
            type: physical
        eth1:
            address: null
            gateway: null
            inet: inet
            mac_address: aa:d6:9f:2c:e8:80
            mode: manual
            mtu: null
            name: eth1
            subnets: []
            type: physical
    routes: []
    use_ipv6: false
_version: 1
use_ipv6: false

Input YAML
config:
- mac_address: c0:d6:9...

tags: added: verification-done-xenial verification-done-zesty
removed: verification-needed verification-needed-xenial verification-needed-zesty
Launchpad Janitor (janitor) wrote :
Download full text (6.4 KiB)

This bug was fixed in the package cloud-init - 0.7.9-233-ge586fe35-0ubuntu1~16.04.1

---------------
cloud-init (0.7.9-233-ge586fe35-0ubuntu1~16.04.1) xenial-proposed; urgency=medium

  * debian/cloud-init.templates: enable Scaleway cloud.
  * debian/cloud-init.templates: enable Aliyun cloud.
  * drop the following cherry picks, now incorporated in snapshot.
    + debian/patches/cpick-5fb49bac-azure-identify-platform...
    + debian/patches/cpick-003c6678-net-remove-systemd-link...
    + debian/patches/cpick-1cd4323b-azure-remove-accidental...
    + debian/patches/cpick-ebc9ecbc-Azure-Add-network-config...
    + debian/patches/cpick-11121fe4-systemd-make-cloud-final...
  * debian/patches/stable-release-no-jsonschema-dep.patch:
    add patch to remove optional dependency on jsonschema.
  * New upstream snapshot.
    - cloudinit.net: add initialize_network_device function and tests
      [Chad Smith]
    - makefile: fix ci-deps-ubuntu target [Chad Smith]
    - tests: adjust locale integration test to parse default locale.
    - tests: remove 'yakkety' from releases as it is EOL.
    - centos: do not package systemd-fsck drop-in.
    - systemd: make systemd-fsck run after cloud-init.service (LP: #1691489)
    - tests: Add initial tests for EC2 and improve a docstring.
    - locale: Do not re-run locale-gen if provided locale is system default.
    - archlinux: fix set hostname usage of write_file. [Joshua Powers]
    - sysconfig: support subnet type of 'manual'.
    - tools/run-centos: make running with no argument show help.
    - Drop rand_str() usage in DNS redirection detection
      [Bob Aman] (LP: #1088611)
    - sysconfig: use MACADDR on bonds/bridges to configure mac_address
      [Ryan Harper]
    - net: eni route rendering missed ipv6 default route config
      [Ryan Harper] (LP: #1701097)
    - sysconfig: enable mtu set per subnet, including ipv6 mtu
      [Ryan Harper]
    - sysconfig: handle manual type subnets [Ryan Harper]
    - sysconfig: fix ipv6 gateway routes [Ryan Harper]
    - sysconfig: fix rendering of bond, bridge and vlan types.
      [Ryan Harper]
    - Templatize systemd unit files for cross distro deltas. [Ryan Harper]
    - sysconfig: ipv6 and default gateway fixes. [Ryan Harper]
    - net: fix renaming of nics to support mac addresses written in upper
      case. (LP: #1705147)
    - tests: fixes for issues uncovered when moving to python 3.6.
    - sysconfig: include GATEWAY value if set in subnet
      [Ryan Harper]
    - Scaleway: add datasource with user and vendor data for Scaleway.
      [Julien Castets]
    - Support comments in content read by load_shell_content.
    - cloudinitlocal fail to run during boot [Hongjiang Zhang]
    - doc: fix disk setup example table_type options [Sandor Zeestraten]
    - tools: Fix exception handling. [Joonas Kylmälä]
    - tests: fix usage of mock in GCE test.
    - test_gce: Fix invalid mock of platform_reports_gce to return False
      [Chad Smith]
    - test: fix incorrect keyid for apt repository. [Joshua Powers]
    - tests: Update version of pylxd [Joshua Powers]
    - write_files: Remove log from helper function signatures.
      [Andrew Jorgensen]
    - doc: document...

Read more...

Changed in cloud-init (Ubuntu Xenial):
status: Fix Committed → Fix Released

The verification of the Stable Release Update for cloud-init 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.

Launchpad Janitor (janitor) wrote :
Download full text (6.4 KiB)

This bug was fixed in the package cloud-init - 0.7.9-233-ge586fe35-0ubuntu1~17.04.1

---------------
cloud-init (0.7.9-233-ge586fe35-0ubuntu1~17.04.1) zesty; urgency=medium

  * debian/cloud-init.templates: enable Scaleway cloud.
  * debian/cloud-init.templates: enable Aliyun cloud.
  * drop the following cherry picks, now incorporated in snapshot.
    + debian/patches/cpick-5fb49bac-azure-identify-platform...
    + debian/patches/cpick-003c6678-net-remove-systemd-link...
    + debian/patches/cpick-1cd4323b-azure-remove-accidental...
    + debian/patches/cpick-ebc9ecbc-Azure-Add-network-config...
    + debian/patches/cpick-11121fe4-systemd-make-cloud-final...
  * debian/patches/stable-release-no-jsonschema-dep.patch:
    add patch to remove optional dependency on jsonschema.
  * New upstream snapshot.
    - cloudinit.net: add initialize_network_device function and tests
      [Chad Smith]
    - makefile: fix ci-deps-ubuntu target [Chad Smith]
    - tests: adjust locale integration test to parse default locale.
    - tests: remove 'yakkety' from releases as it is EOL.
    - centos: do not package systemd-fsck drop-in.
    - systemd: make systemd-fsck run after cloud-init.service (LP: #1691489)
    - tests: Add initial tests for EC2 and improve a docstring.
    - locale: Do not re-run locale-gen if provided locale is system default.
    - archlinux: fix set hostname usage of write_file. [Joshua Powers]
    - sysconfig: support subnet type of 'manual'.
    - tools/run-centos: make running with no argument show help.
    - Drop rand_str() usage in DNS redirection detection
      [Bob Aman] (LP: #1088611)
    - sysconfig: use MACADDR on bonds/bridges to configure mac_address
      [Ryan Harper]
    - net: eni route rendering missed ipv6 default route config
      [Ryan Harper] (LP: #1701097)
    - sysconfig: enable mtu set per subnet, including ipv6 mtu
      [Ryan Harper]
    - sysconfig: handle manual type subnets [Ryan Harper]
    - sysconfig: fix ipv6 gateway routes [Ryan Harper]
    - sysconfig: fix rendering of bond, bridge and vlan types.
      [Ryan Harper]
    - Templatize systemd unit files for cross distro deltas. [Ryan Harper]
    - sysconfig: ipv6 and default gateway fixes. [Ryan Harper]
    - net: fix renaming of nics to support mac addresses written in upper
      case. (LP: #1705147)
    - tests: fixes for issues uncovered when moving to python 3.6.
    - sysconfig: include GATEWAY value if set in subnet
      [Ryan Harper]
    - Scaleway: add datasource with user and vendor data for Scaleway.
      [Julien Castets]
    - Support comments in content read by load_shell_content.
    - cloudinitlocal fail to run during boot [Hongjiang Zhang]
    - doc: fix disk setup example table_type options [Sandor Zeestraten]
    - tools: Fix exception handling. [Joonas Kylmälä]
    - tests: fix usage of mock in GCE test.
    - test_gce: Fix invalid mock of platform_reports_gce to return False
      [Chad Smith]
    - test: fix incorrect keyid for apt repository. [Joshua Powers]
    - tests: Update version of pylxd [Joshua Powers]
    - write_files: Remove log from helper function signatures.
      [Andrew Jorgensen]
    - doc: document the cmdli...

Read more...

Changed in cloud-init (Ubuntu Zesty):
status: Fix Committed → Fix Released
Scott Moser (smoser) wrote :

This is believed fixed in 17.1.

Changed in cloud-init:
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