cloud-init doesn't prefer new APT config format when old and new are provided

Bug #1616831 reported by Andres Rodriguez
14
This bug affects 2 people
Affects Status Importance Assigned to Milestone
cloud-init
Fix Released
High
Christian Ehrhardt 
cloud-init (Ubuntu)
Fix Released
High
Christian Ehrhardt 
Xenial
Fix Released
Medium
Unassigned

Bug Description

==== Begin SRU Template ====
[Impact]
New apt configuration was enabled, but if the user provided both new
configuration format and old configuration format, then then cloud-init
would error.

The fixed behavior is to allow new and old and warn if they differ.

This allows a user to provide the same data for older releases and newer release.

[Test Case]
# Recreate failure (this would recreate on intermediate versions of
# cloud-init that were in trusty, but will not on xenial version.
# testing the working path is still valid though to ensure it functions.
# you will need to adjust both proxy settings to a local proxy.

$ cat >user-data <<EOF
#cloud-config
apt:
  preserve_sources_list: false
  primary:
  - arches: [default]
    uri: http://us.archive.ubuntu.com/ubuntu
  proxy: http://192.168.122.1:8000/
  security:
  - arches: [default]
    uri: http://us.archive.ubuntu.com/ubuntu
  sources:
    launchpad_3: {source: 'deb http://ppa.launchpad.net/maas/next/ubuntu main'}

apt_proxy: http://192.168.122.1:8000/
EOF

$ release=xenial
$ name=x1
$ lxc launch ubuntu-daily:$release $name "--config=user.user-data=$(cat user-data)"
$ while ! lxc exec "$name" -- [ -f /run/cloud-init/result.json ]; do sleep 1; done
$ lxc exec $name -- grep WARN /var/log/cloud-init.log

## Now update container, clean and reboot to show first boot
$ lxc exec $name -- sh -c '
    p=/etc/apt/sources.list.d/proposed.list
    echo deb http://archive.ubuntu.com/ubuntu $(lsb_release -sc)-proposed main > "$p" &&
    apt-get update -q && apt-get -qy install cloud-init'
$ lxc exec $name -- sh -c '
    cd /var/lib/cloud && for d in *; do [ "$d" = "seed" ] || rm -Rf "$d"; done
    rm -Rf /var/log/cloud-init*'

$ lxc exec $name reboot

$ lxc exec $name -- grep WARN /var/log/cloud-init.log || echo no warn

# this should show us archive used.
$ lxc exec $name -- grep us.archive /etc/apt/sources.list | grep deb | tail -n 3
$ lxc exec $name -- cat /etc/apt/apt.conf.d/95cloud-init-proxy

[Regression Potential]
The apt feature itself (added under bug 1574113) could have regressions, as seen in bug 1621180.
This fix specifically relaxed cloud-init's behavior, making it more backwards compatible. It should not be too prone to regression itself.

==== End SRU Template ====

Trying to use the new configuration format of APT configuration while still providing the OLD format, causes cloud-init fails to configure APT.

cloud-init should be ignoring the old format if the new format is provided to ensure backwards compat.

This is a problem for MAAS provided that we cannot safely differentiate / determine what cloud-init version we are using for a specific release we are deploying, and as such, we still need to send the old config while still providing the new one because:

1. Yakkety uses newer cloud-init with new format above
2. Xenial, Trusty, Precise use older cloud-init that doesn't support new format.

And this is a problem because:

1. MAAS won't be able to use derived repositories in Xenial, Trusty, Precise until this gets backported into cloud-init.
2. Commission is done in Xenial, while deployment in Yakkety, but both may require the same config, but it is only supported in Yakkety's cloud-init.
3. Users may be using old images that may not contain new cloud-init at all, and even though the release already supports it, the image they are using doesn't and they have to continue to use the old format.
4. MAAS cannot differentiate/identify which cloud-init version its being used, as such, needs to sends both old and new config.

Aug 25 09:44:17 node02 [CLOUDINIT] cc_apt_configure.py[ERROR]: Error in apt configuration: old and new format of apt features are mutually exclusive ('apt':'{'primary': [{'arches': ['default'], 'uri': 'http://us.archive.ubuntu.com/ubuntu'}], 'preserve_sources_list': True, 'security': [{'arches': ['default'], 'uri': 'http://us.archive.ubuntu.com/ubuntu'}], 'sources': {'launchpad_3': {'source': 'deb http://ppa.launchpad.net/maas/next/ubuntu yakkety main'}}}' vs 'apt_proxy' key)

Aug 25 09:51:58 node02 [CLOUDINIT] util.py[DEBUG]: Running module apt-configure (<module 'cloudinit.config.cc_apt_configure' from '/usr/lib/python3/dist-packages/cloudinit/config/cc_apt_configure.py'>) failed#012Traceback (most recent call last):#012 File "/usr/lib/python3/dist-packages/cloudinit/stages.py", line 785, in _run_modules#012 freq=freq)#012 File "/usr/lib/python3/dist-packages/cloudinit/cloud.py", line 70, in run#012 return self._runners.run(name, functor, args, freq, clear_on_fail)#012 File "/usr/lib/python3/dist-packages/cloudinit/helpers.py", line 199, in run#012 results = functor(*args)#012 File "/usr/lib/python3/dist-packages/cloudinit/config/cc_apt_configure.py", line 77, in handle#012 ocfg = convert_to_v3_apt_format(ocfg)#012 File "/usr/lib/python3/dist-packages/cloudinit/config/cc_apt_configure.py", line 527, in convert_to_v3_apt_format#012 cfg = convert_v2_to_v3_apt_format(cfg)#012 File "/usr/lib/python3/dist-packages/cloudinit/config/cc_apt_configure.py", line 489, in convert_v2_to_v3_apt_format#012 raise ValueError(msg)#012ValueError: Error in apt configuration: old and new format of apt features are mutually exclusive ('apt':'{'preserve_sources_list': True, 'primary': [{'uri': 'http://us.archive.ubuntu.com/ubuntu', 'arches': ['default']}], 'security': [{'uri': 'http://us.archive.ubuntu.com/ubuntu', 'arches': ['default']}], 'sources': {'launchpad_3': {'source': 'deb http://ppa.launchpad.net/maas/next/ubuntu yakkety main'}}}' vs 'apt_proxy, apt_preserve_sources_list' key)

Revision history for this message
Andres Rodriguez (andreserl) wrote :

Since not all Ubuntu releases and not all users will have the latest, the new configuration format should be preferred instead of the old configuration format if both are provided, rather than failing.

description: updated
description: updated
Changed in cloud-init (Ubuntu):
assignee: nobody → ChristianEhrhardt (paelzer)
Scott Moser (smoser)
Changed in cloud-init:
status: New → Confirmed
importance: Undecided → High
Changed in cloud-init (Ubuntu):
status: New → Confirmed
importance: Undecided → High
Changed in cloud-init:
assignee: nobody → Christian Ehrhardt (der-schoenne)
assignee: Christian Ehrhardt (der-schoenne) → ChristianEhrhardt (paelzer)
Revision history for this message
Andres Rodriguez (andreserl) wrote :
Revision history for this message
Scott Moser (smoser) wrote :

Here is a simple recreate
$ cat > /tmp/my.user-data <<"EOF"
#cloud-config
apt:
  preserve_sources_list: false
  primary:
  - arches: [default]
    uri: http://us.archive.ubuntu.com/ubuntu
  proxy: http://192.168.122.1:8000/
  security:
  - arches: [default]
    uri: http://us.archive.ubuntu.com/ubuntu
  sources:
    launchpad_3: {source: 'deb http://ppa.launchpad.net/maas/next/ubuntu main'}

apt_proxy: http://192.168.122.1:8000/

system_info:
  package_mirrors:
  - arches: [i386, amd64]
    failsafe:
      primary: 'http://archive.ubuntu.com/ubuntu'
      security: 'http://security.ubuntu.com/ubuntu'
    search:
      primary: ['http://us.archive.ubuntu.com/ubuntu']
      security: ['http://us.archive.ubuntu.com/ubuntu']
  - arches: [default]
    failsafe:
      primary: 'http://ports.ubuntu.com/ubuntu-ports'
      security: 'http://ports.ubuntu.com/ubuntu-ports'
    search:
      primary: ['http://ports.ubuntu.com/ubuntu-ports']
      security: ['http://ports.ubuntu.com/ubuntu-ports']
EOF

$ lxc launch ubuntu-daily:yakkety "--config=user.user-data=$(cat /tmp/my.user-data)"

tags: added: 4010
Revision history for this message
Christian Ehrhardt  (paelzer) wrote :
Changed in cloud-init (Ubuntu):
status: Confirmed → In Progress
Revision history for this message
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package cloud-init - 0.7.7-22-g763f403-0ubuntu1

---------------
cloud-init (0.7.7-22-g763f403-0ubuntu1) yakkety; urgency=medium

  * New upstream snapshot.
    - apt-config: allow both old and new format to be present.
      [Christian Ehrhardt] (LP: #1616831)
    - python2.6: fix dict comprehension usage in _lsb_release. [Joshua Harlow]
    - Add a module that can configure spacewalk. [Joshua Harlow]
    - add install option for openrc [Matthew Thode]
    - Generate a dummy bond name for OpenStack (LP: #1605749)
  * debian/control, debian/README.source: update to reference git.
  * debian/new-upstream-snapshot: small fixes.

 -- Scott Moser <email address hidden> Fri, 26 Aug 2016 15:22:13 -0400

Changed in cloud-init (Ubuntu):
status: In Progress → Fix Released
Revision history for this message
Andres Rodriguez (andreserl) wrote :

I'm reopening this bug and this has not really been fixed:

ubuntu@node01:~$ dpkg -l | grep cloud-init
ii cloud-init 0.7.7-22-g763f403-0ubuntu1 all Init scripts for cloud instances

Config MAAS sends cloud-init: http://pastebin.ubuntu.com/23111940/

/etc/apt/sources.list: http://pastebin.ubuntu.com/23111941/

cloud-init.log: http://paste.ubuntu.com/23111945/
cloud-init-output.log: http://paste.ubuntu.com/23111947/

Note that curtin rev 418 works just fine, while cloud-init doesn't. Note that in the cloud-init config we send "preserve_sources_list: True" while in curtin config it is False.

Changed in cloud-init (Ubuntu):
status: Fix Released → New
Revision history for this message
Andres Rodriguez (andreserl) wrote :

http://pastebin.ubuntu.com/23111966/ -> with preserve_source_list: false, then sources.list gets updated accordingly.

Revision history for this message
Andres Rodriguez (andreserl) wrote :

Seeting back to fix-released, as now we need to send preserve_sources_list: false

Changed in cloud-init (Ubuntu):
status: New → Incomplete
status: Incomplete → Fix Released
Scott Moser (smoser)
Changed in cloud-init:
status: Confirmed → Fix Committed
Revision history for this message
Scott Moser (smoser) wrote :

fixed in 0.7.8.

Changed in cloud-init:
status: Fix Committed → Fix Released
Scott Moser (smoser)
Changed in cloud-init (Ubuntu Xenial):
status: New → In Progress
importance: Undecided → Medium
Revision history for this message
Chris J Arges (arges) wrote : Please test proposed package

Hello Andres, 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.7-31-g65ace7b-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 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 to verification-done. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed. 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: In Progress → Fix Committed
tags: added: verification-needed
Scott Moser (smoser)
description: updated
description: updated
Scott Moser (smoser)
description: updated
description: updated
Revision history for this message
Martin Pitt (pitti) wrote :

Hello Andres, 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.8-1-g3705bb5-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 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 to verification-done. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed. 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!

Revision history for this message
Scott Moser (smoser) wrote :

verified as per sru template description.

description: updated
tags: added: verification-done
removed: verification-needed
Revision history for this message
Launchpad Janitor (janitor) wrote :
Download full text (3.9 KiB)

This bug was fixed in the package cloud-init - 0.7.8-1-g3705bb5-0ubuntu1~16.04.1

---------------
cloud-init (0.7.8-1-g3705bb5-0ubuntu1~16.04.1) xenial-proposed; urgency=medium

  * New upstream release 0.7.8.
  * New upstream snapshot.
    - systemd: put cloud-init.target After multi-user.target (LP: #1623868)

cloud-init (0.7.7-31-g65ace7b-0ubuntu1~16.04.2) xenial-proposed; urgency=medium

  * debian/control: add Breaks of older versions of walinuxagent (LP: #1623570)

cloud-init (0.7.7-31-g65ace7b-0ubuntu1~16.04.1) xenial-proposed; urgency=medium

  * debian/control: fix missing dependency on python3-serial,
    and make SmartOS datasource work.
  * debian/cloud-init.templates fix capitalisation in template so
    dpkg-reconfigure works to select OpenStack. (LP: #1575727)
  * d/README.source, d/control, d/new-upstream-snapshot, d/rules: sync
    with yakkety for changes due to move to git.
  * d/rules: change PYVER=python3 to PYVER=3 to adjust to upstream change.
  * debian/rules, debian/cloud-init.install: remove install file
    to ensure expected files are collected into cloud-init deb.
    (LP: #1615745)
  * debian/dirs: remove obsolete / unused file.
  * upstream move from bzr to git.
  * New upstream snapshot.
    - Allow link type of null in network_data.json [Jon Grimm] (LP: #1621968)
    - DataSourceOVF: fix user-data as base64 with python3 (LP: #1619394)
    - remove obsolete .bzrignore
    - systemd: Better support package and upgrade. (LP: #1576692, #1621336)
    - tests: cleanup tempdirs in apt_source tests
    - apt config conversion: treat empty string as not provided. (LP: #1621180)
    - Fix typo in default keys for phone_home [Roland Sommer] (LP: #1607810)
    - salt minion: update default pki directory for newer salt minion.
      (LP: #1609899)
    - bddeb: add --release flag to specify the release in changelog.
    - apt-config: allow both old and new format to be present.
      [Christian Ehrhardt] (LP: #1616831)
    - python2.6: fix dict comprehension usage in _lsb_release. [Joshua Harlow]
    - Add a module that can configure spacewalk. [Joshua Harlow]
    - add install option for openrc [Matthew Thode]
    - Generate a dummy bond name for OpenStack (LP: #1605749)
    - network: fix get_interface_mac for bond slave, read_sys_net for ENOTDIR
    - azure dhclient-hook cleanups
    - Minor cleanups to atomic_helper and add unit tests.
    - Fix Gentoo net config generation [Matthew Thode]
    - distros: fix get_primary_arch method use of os.uname [Andrew Jorgensen]
    - Apt: add new apt configuration format [Christian Ehrhardt]
    - Get Azure endpoint server from DHCP client [Brent Baude]
    - DigitalOcean: use the v1.json endpoint [Ben Howard]
    - MAAS: add vendor-data support (LP: #1612313)
    - Upgrade to a configobj package new enough to work [Joshua Harlow]
    - ConfigDrive: recognize 'tap' as a link type. (LP: #1610784)
    - NoCloud: fix bug providing network-interfaces via meta-data.
      (LP: 1577982)
    - Add distro tags on config modules that should have it [Joshua Harlow]
    - ChangeLog: update changelog for previous commit.
    - add ntp config module [Ryan Harper]
    - SmartOS: more improvement...

Read more...

Changed in cloud-init (Ubuntu Xenial):
status: Fix Committed → Fix Released
Revision history for this message
Chris J Arges (arges) wrote : Update 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.

Revision history for this message
James Falcon (falcojr) wrote :
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.