cloud-init interface renaming should apply .lower() to mac_address values to match sysfs entries
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| cloud-init |
Fix Released
|
Medium
|
Unassigned | ||
| cloud-init (Ubuntu) |
Fix Released
|
Medium
|
Unassigned | ||
| Xenial |
Fix Released
|
Medium
|
Unassigned | ||
| Zesty |
Fix Released
|
Medium
|
Unassigned | ||
Bug Description
=== Begin SRU Template ===
[Impact]
cloud-init takes network configuration input in a variety of formats.
It then applies that network configuration, including renaming devices
based on their mac address and provided name.
If the mac address provided contained upper case letters (hex values,
so A-F) then cloud-init would fail to rename the devices and show a
WARN message in /var/log/
The warn message would look like:
Failed to rename devices: [nic not present] Cannot rename
mac=
[Test Case]
The basic idea below is:
a.) launch an lxd instance with proposed version of cloud-init.
b.) inside instance, change the provided network config to use upper case
for mac addresses.
c.) clean the system and reboot.
d.) check no errors in /var/log/
## launch an instance.
$ release=xenial
$ ref=$release-
$ lxc-proposed-
$ lxc launch $ref $name
$ lxc exec $name -- /bin/bash
## inside
% read lower < /sys/class/
% echo $lower
00:16:3e:fc:3d:65
% upper=$(echo "$lower" | tr '[a-z]' '[A-Z]')
% sed -i.dist -e 's,\( *\)name: eth0,1円name: nic0\n\
/var/
% ( cd /var/lib/
--- network-config.dist 2017年08月01日 20:44:48.445568094 +0000
+++ network-config 2017年08月01日 20:44:58.277456919 +0000
@@ -1,7 +1,8 @@
version: 1
config:
- type: physical
- name: eth0
+ name: nic0
+ mac_address: "00:16:3E:5D:72:AE"
subnets:
- type: dhcp
## clean up skipping the 'seed' directory.
% ( cd /var/lib/cloud && for i in *; do [ "$i" = "seed" ] || rm -Rf $i; done )
% rm -Rf /var/log/
% reboot
## back outside, wait a bit, then
% lxc exec $name -- /bin/bash
% grep WARN /var/log/
% ip addr show nic0
90: nic0@if91: <BROADCAST,
link/ether 00:16:3e:5d:72:ae brd ff:ff:ff:ff:ff:ff link-netnsid 0
inet 10.75.205.253/24 brd 10.75.205.255 scope global nic0
valid_lft forever preferred_lft forever
inet6 fe80::216:
valid_lft forever preferred_lft forever
[Regression Potential]
Regression potential here should be very low. The fix was essentially to
be more liberal on matching mac addresses by using '.lower()' on both values.
[Other Info]
Upstream commit at
https:/
lxc-proposed-
https:/
It publishes an image to lxd with proposed enabled and cloud-init upgraded.
=== End SRU Template ===
When supplying a network config to cloud-init with MAC address values using Upper case letters, this will fail to match MAC address values returned from sysfs. THe result is that cloud-init gives up on the renaming of the interface.
Related branches
- Ryan Harper: Approve
- Server Team CI bot: Approve (continuous-integration)
-
Diff: 77 lines (+33/-2) 2 files modifiedapicloudinit/net/__init__.py (+6/-2)
tests/unittests/test_net.py (+27/-0)
Hello Ryan, or anyone else affected,
Accepted cloud-init into xenial-proposed. The package will build now and be available at https:/
Please help us by testing this new package. See https:/
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-
Further information regarding the verification process can be found at https:/
Hello Ryan, or anyone else affected,
Accepted cloud-init into zesty-proposed. The package will build now and be available at https:/
Please help us by testing this new package. See https:/
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-
Further information regarding the verification process can be found at https:/
Validated UPPERCASE macs do not cause warnings on xenial and zesty
--- Xenial
csmith@fringe:~$ lxc exec test-xenial bash
root@test-xenial:~# grep CODENAME /etc/lsb-release; dpkg-query --show cloud-init
DISTRIB_
cloud-init 0.7.9-233-
root@test-xenial:~# read lower < /sys/class/
root@test-xenial:~# echo $lower
00:16:3e:1e:df:cc
root@test-xenial:~# upper=$(echo "$lower" | tr '[a-z]' '[A-Z]')
root@test-xenial:~# sed -i.dist -e 's,\( *\)name: eth0,1円name: nic0\n\
> /var/lib/
root@test-xenial:~# ( cd /var/lib/
--- network-config.dist 2017年08月28日 17:49:04.566339355 +0000
+++ network-config 2017年08月28日 21:36:30.007994177 +0000
@@ -1,7 +1,8 @@
version: 1
config:
- type: physical
- name: eth0
+ name: nic0
+ mac_address: "00:16:3E:1E:DF:CC"
subnets:
- type: dhcp
root@test-xenial:~# ( cd /var/lib/cloud && for i in *; do [ "$i" = "seed" ] || rm -Rf $i; done )
root@test-xenial:~# rm -Rf /var/log/
root@test-xenial:~# reboot
csmith@fringe:~$ lxc exec test-xenial -- grep WARN /var/log/
no warnings
---- test zesty
csmith@fringe:~$ lxc exec test-zesty bash
root@test-zesty:~# grep CODENAME /etc/lsb-release; dpkg-query --show cloud-init
DISTRIB_
cloud-init 0.7.9-233-
root@test-zesty:~# read lower < /sys/class/
root@test-zesty:~# echo $lower
00:16:3e:b0:72:1f
root@test-zesty:~# upper=$(echo "$lower" | tr '[a-z]' '[A-Z]')
root@test-zesty:~# sed -i.dist -e 's,\( *\)name: eth0,1円name: nic0\n\
> /var/lib/
root@test-zesty:~# ( cd /var/lib/
--- network-config.dist 2017年08月28日 17:50:39.302871814 +0000
+++ network-config 2017年08月28日 21:41:24.999348297 +0000
@@ -1,7 +1,8 @@
version: 1
config:
- type: physical
- name: eth0
+ name: nic0
+ mac_address: "00:16:3E:B0:72:1F"
subnets:
- type: dhcp
root@test-zesty:~# ( cd /var/lib/cloud && for i in *; do [ "$i" = "seed" ] || rm -Rf $i; done )
root@test-zesty:~# rm -Rf /var/log/
root@test-zesty:~# reboot
csmith@fringe:~$ lxc exec test-zesty -- grep WARN /var/log/
no warnings
removed: verification-needed verification-needed-xenial verification-needed-zesty
This bug was fixed in the package cloud-init - 0.7.9-233-
---------------
cloud-init (0.7.9-
* debian/
* debian/
* drop the following cherry picks, now incorporated in snapshot.
+ debian/
+ debian/
+ debian/
+ debian/
+ debian/
* debian/
add patch to remove optional dependency on jsonschema.
* New upstream snapshot.
- cloudinit.net: add initialize_
[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_
[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 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.
This bug was fixed in the package cloud-init - 0.7.9-233-
---------------
cloud-init (0.7.9-
* debian/
* debian/
* drop the following cherry picks, now incorporated in snapshot.
+ debian/
+ debian/
+ debian/
+ debian/
+ debian/
* debian/
add patch to remove optional dependency on jsonschema.
* New upstream snapshot.
- cloudinit.net: add initialize_
[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_
[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...
This bug is believed to be fixed in cloud-init in 17.1. If this is still a problem for you, please make a comment and set the state back to New
Thank you.
Tracked in Github Issues as https:/