Merge lp:~smoser/cloud-init/trunk.disable-clouddinit into lp:~cloud-init-dev/cloud-init/trunk

[Scott Moser]

systemd: Add cloud-init generator and allow disabling of cloud-init

This adds a generator that enables cloud-init if it is not found to
be disabled. It can be disabled via either the kernel command line
(/proc/cmdline with cloud-init=disabled) or presense of
/etc/cloud/cloud-init.disabled.

Also each of the service files now Wants the cloud-init target, making
them more of a group.

[Scott Moser (smoser)]

This still needs doc, and probably need to review the kernel command line with other parts of cloud-init consumption for consistency, but the general implementation seems to work.

[Ryan Harper (raharper)]

Do you expect this to run pre-systemd (precise or trusty)?

[lp:~smoser/cloud-init/trunk.disable-clouddinit]

1173. By Scott Moser on 2016-03-03

consume KERNEL_CMDLINE even if set to "". explain 'container'

[Scott Moser (smoser)]

should still work.
The upstart jobs are still there.

[lp:~smoser/cloud-init/trunk.disable-clouddinit]

1174. By Scott Moser on 2016-03-03

merge with trunk

1175. By Scott Moser on 2016-03-03

do not duplicate '-generator' in log ame

1176. By Scott Moser on 2016-03-03

generator: be more clear on where kernel cmdline came from

1177. By Scott Moser on 2016-03-03

cloud-init.target should not do anything

no wants or after or before.

1178. By Scott Moser on 2016-03-04

merge with trunk

1179. By Scott Moser on 2016-03-04

support nocheck in building.

1180. By Scott Moser on 2016-03-04

packages/bddeb: copy all files in packages/debian/

just copy all the files that are there. makes adding files easier.

1181. By Scott Moser on 2016-03-04

mention link path in generator

1182. By Scott Moser on 2016-03-04

postinst/preinst: cleanup old multi-user.target enabled files

also, actually enable the services.
now this will have them enabled in the cloud-init.target.

=== modified file 'packages/bddeb'
--- packages/bddeb	2015-02-10 20:32:32 +0000
+++ packages/bddeb	2016-03-04 05:04:21 +0000
@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 
+import glob
 import os
 import shutil
 import sys
@@ -105,11 +106,11 @@
                              util.abs_join(deb_dir, 'rules'),
                              params={'python': python, 'pyver': pyver})
 
-    # Just copy the following directly
-    for base_fn in ['dirs', 'copyright', 'compat']:
-        shutil.copy(util.abs_join(find_root(),
-                                  'packages', 'debian', base_fn),
-                    util.abs_join(deb_dir, base_fn))
+    # Just copy any other files directly (including .in)
+    pdeb_d = util.abs_join(find_root(), 'packages', 'debian')
+    for f in [os.path.join(pdeb_d, f) for f in os.listdir(pdeb_d)]:
+        if os.path.isfile(f):
+            shutil.copy(f, util.abs_join(deb_dir, os.path.basename(f)))
 
 
 def main():

=== added file 'packages/debian/cloud-init.postinst'
--- packages/debian/cloud-init.postinst	1970-01-01 00:00:00 +0000
+++ packages/debian/cloud-init.postinst	2016-03-04 05:04:21 +0000
@@ -0,0 +1,17 @@
+#!/bin/sh
+set -x
+cleanup_lp1552999() {
+    local oldver="$1" last_bad_ver="0.7.7~bzr1178"
+    dpkg --compare-versions "$oldver" le "$last_bad_ver" || return 0
+    local edir="/etc/systemd/system/multi-user.target.wants"
+    rm -f "$edir/cloud-config.service" "$edir/cloud-final.service" \
+        "$edir/cloud-init-local.service" "$edir/cloud-init.service"
+}
+
+
+#DEBHELPER#
+
+if [ "$1" = "configure" ]; then
+   oldver="$2"
+   cleanup_lp1552999 "$oldver"
+fi

=== added file 'packages/debian/cloud-init.preinst'
--- packages/debian/cloud-init.preinst	1970-01-01 00:00:00 +0000
+++ packages/debian/cloud-init.preinst	2016-03-04 05:04:21 +0000
@@ -0,0 +1,22 @@
+#!/bin/sh
+# vi: ts=4 expandtab
+
+set -x
+cleanup_lp1552999() {
+    local oldver="$1" last_bad_ver="0.7.7~bzr1178"
+    dpkg --compare-versions "$oldver" le "$last_bad_ver" || return 0
+    local hdir="/var/lib/systemd/deb-systemd-helper-enabled"
+    hdir="$hdir/multi-user.target.wants" 
+    local edir="/etc/systemd/system/multi-user.target.wants"
+    rm -f "$hdir/cloud-config.service" "$hdir/cloud-final.service" \
+        "$hdir/cloud-init-local.service" "$hdir/cloud-init.service"
+}
+
+
+if [ "$1" = "upgrade" ]; then
+   oldver="$2"
+   cleanup_lp1552999 "$oldver"
+fi
+set +x
+
+#DEBHELPER#

=== modified file 'packages/debian/rules.in'
--- packages/debian/rules.in	2016-03-04 00:10:18 +0000
+++ packages/debian/rules.in	2016-03-04 05:04:21 +0000
@@ -12,8 +12,10 @@
 	install -d debian/cloud-init/etc/rsyslog.d
 	cp tools/21-cloudinit.conf debian/cloud-init/etc/rsyslog.d/21-cloudinit.conf
 
+ifeq (,$(findstring nocheck,$(DEB_BUILD_OPTIONS)))
 override_dh_auto_test:
-	http_proxy= make check
+   http_proxy= make check
+endif
 
 override_dh_systemd_start:
 	dh_systemd_start --no-restart-on-upgrade --no-start

=== modified file 'setup.py'
--- setup.py	2015-07-21 12:06:11 +0000
+++ setup.py	2016-03-04 05:04:21 +0000
@@ -45,39 +45,50 @@
         stdout = None
         stderr = None
     sp = subprocess.Popen(cmd, stdout=stdout,
-                    stderr=stderr, stdin=None,
-                    universal_newlines=True)
+                          stderr=stderr, stdin=None,
+                          universal_newlines=True)
     (out, err) = sp.communicate()
     ret = sp.returncode
     if ret not in [0]:
-        raise RuntimeError("Failed running %s [rc=%s] (%s, %s)"
-                            % (cmd, ret, out, err))
+        raise RuntimeError("Failed running %s [rc=%s] (%s, %s)" %
+                           (cmd, ret, out, err))
     return (out, err)
 
 
-def systemd_unitdir():
-    cmd = ['pkg-config', '--variable=systemdsystemunitdir', 'systemd']
+def pkg_config_read(library, var):
+    fallbacks = {
+       'systemd': {
+           'systemdsystemunitdir': '/lib/systemd/system',
+           'systemdsystemgeneratordir': '/lib/systemd/system-generators',
+       }
+    }
+    cmd = ['pkg-config', '--variable=%s' % var, library]
     try:
         (path, err) = tiny_p(cmd)
     except:
-        return '/lib/systemd/system'
+        return fallbacks[library][var]
     return str(path).strip()
 
+
 INITSYS_FILES = {
     'sysvinit': [f for f in glob('sysvinit/redhat/*') if is_f(f)],
     'sysvinit_freebsd': [f for f in glob('sysvinit/freebsd/*') if is_f(f)],
     'sysvinit_deb': [f for f in glob('sysvinit/debian/*') if is_f(f)],
-    'systemd': [f for f in glob('systemd/*') if is_f(f)],
+    'systemd': [f for f in (glob('systemd/*.service') +
+                            glob('systemd/*.target')) if is_f(f)],
+    'systemd.generators': [f for f in glob('systemd/*-generator') if is_f(f)],
     'upstart': [f for f in glob('upstart/*') if is_f(f)],
 }
 INITSYS_ROOTS = {
     'sysvinit': '/etc/rc.d/init.d',
     'sysvinit_freebsd': '/usr/local/etc/rc.d',
     'sysvinit_deb': '/etc/init.d',
-    'systemd': systemd_unitdir(),
+    'systemd': pkg_config_read('systemd', 'systemdsystemunitdir'),
+    'systemd.generators': pkg_config_read('systemd',
+                                          'systemdsystemgeneratordir'),
     'upstart': '/etc/init/',
 }
-INITSYS_TYPES = sorted(list(INITSYS_ROOTS.keys()))
+INITSYS_TYPES = sorted([f.partition(".")[0] for f in INITSYS_ROOTS.keys()])
 
 # Install everything in the right location and take care of Linux (default) and
 # FreeBSD systems.
@@ -122,9 +133,8 @@
     user_options = install.user_options + [
         # This will magically show up in member variable 'init_sys'
         ('init-system=', None,
-            ('init system(s) to configure (%s) [default: None]') %
-                (", ".join(INITSYS_TYPES))
-        ),
+         ('init system(s) to configure (%s) [default: None]' %
+          (", ".join(INITSYS_TYPES)))),
     ]
 
     def initialize_options(self):
@@ -138,7 +148,8 @@
             self.init_system = self.init_system.split(",")
 
         if len(self.init_system) == 0:
-            raise DistutilsArgError(("You must specify one of (%s) when"
+            raise DistutilsArgError(
+                ("You must specify one of (%s) when"
                  " specifying init system(s)!") % (", ".join(INITSYS_TYPES)))
 
         bad = [f for f in self.init_system if f not in INITSYS_TYPES]
@@ -147,8 +158,12 @@
                 "Invalid --init-system: %s" % (','.join(bad)))
 
         for system in self.init_system:
-            self.distribution.data_files.append(
-                (INITSYS_ROOTS[system], INITSYS_FILES[system]))
+            # add data files for anything that starts with '<system>.'
+            datakeys = [k for k in INITSYS_ROOTS
+                        if k.partition(".")[0] == system]
+            for k in datakeys:
+                self.distribution.data_files.append(
+                    (INITSYS_ROOTS[k], INITSYS_FILES[k]))
         # Force that command to reinitalize (with new file list)
         self.distribution.reinitialize_command('install_data', True)
 
@@ -182,18 +197,18 @@
     requirements.append('cheetah')
 
 
-setuptools.setup(name='cloud-init',
-      version=get_version(),
-      description='EC2 initialisation magic',
-      author='Scott Moser',
-      author_email='[e-mail]',
-      url='http://launchpad.net/cloud-init/',
-      packages=setuptools.find_packages(exclude=['tests']),
-      scripts=['bin/cloud-init',
-               'tools/cloud-init-per',
-               ],
-      license='GPLv3',
-      data_files=data_files,
-      install_requires=requirements,
-      cmdclass=cmdclass,
-      )
+setuptools.setup(
+    name='cloud-init',
+    version=get_version(),
+    description='EC2 initialisation magic',
+    author='Scott Moser',
+    author_email='[e-mail]',
+    url='http://launchpad.net/cloud-init/',
+    packages=setuptools.find_packages(exclude=['tests']),
+    scripts=['bin/cloud-init',
+             'tools/cloud-init-per'],
+    license='GPLv3',
+    data_files=data_files,
+    install_requires=requirements,
+    cmdclass=cmdclass,
+    )

=== modified file 'systemd/cloud-config.service'
--- systemd/cloud-config.service	2015-04-09 15:54:01 +0000
+++ systemd/cloud-config.service	2016-03-04 05:04:21 +0000
@@ -13,4 +13,4 @@
 StandardOutput=journal+console
 
 [Install]
-WantedBy=multi-user.target
+WantedBy=cloud-init.target

=== modified file 'systemd/cloud-final.service'
--- systemd/cloud-final.service	2015-11-30 20:33:28 +0000
+++ systemd/cloud-final.service	2016-03-04 05:04:21 +0000
@@ -14,4 +14,4 @@
 StandardOutput=journal+console
 
 [Install]
-WantedBy=multi-user.target
+WantedBy=cloud-init.target

=== added file 'systemd/cloud-init-generator'
--- systemd/cloud-init-generator	1970-01-01 00:00:00 +0000
+++ systemd/cloud-init-generator	2016-03-04 05:04:21 +0000
@@ -0,0 +1,128 @@
+#!/bin/sh
+set -f
+
+LOG=""
+DEBUG_LEVEL=1
+LOG_D="/run"
+ENABLE="enabled"
+DISABLE="disabled"
+CLOUD_SYSTEM_TARGET="/lib/systemd/system/cloud-init.target"
+CLOUD_TARGET_NAME="cloud-init.target"
+# lxc sets 'container', but lets make that explicitly a global
+CONTAINER="${container}"
+
+debug() {
+    local lvl="$1"
+    shift
+    [ "$lvl" -gt "$DEBUG_LEVEL" ] && return
+    if [ -z "$LOG" ]; then
+        local log="$LOG_D/${0##*/}.log"
+        { : > "$log"; } >/dev/null 2>&1 && LOG="$log" ||
+            LOG="/dev/kmsg"
+    fi
+    echo "$@" >> "$LOG"
+}
+
+etc_file() {
+    local pprefix="${1:-/etc/cloud/cloud-init.}"
+    _RET="unset"
+    [ -f "${pprefix}$ENABLE" ] && _RET="$ENABLE" && return 0
+    [ -f "${pprefix}$DISABLE" ] && _RET="$DISABLE" && return 0
+    return 0
+}
+
+read_proc_cmdline() {
+    if [ "$CONTAINER" = "lxc" ]; then
+        _RET_MSG="ignored: \$container=$CONTAINER"
+        _RET=""
+        return 0
+    fi
+
+    if systemd-detect-virt --container --quiet; then
+        _RET_MSG="ignored: detect-virt is container"
+        _RET=""
+        return 0
+    fi
+
+    _RET_MSG="/proc/cmdline"
+    read _RET < /proc/cmdline
+}
+
+kernel_cmdline() {
+    local cmdline="" tok=""
+    if [ -n "${KERNEL_CMDLINE+x}" ]; then
+        # use KERNEL_CMDLINE if present in environment even if empty
+        cmdline=${KERNEL_CMDLINE}
+        debug 1 "kernel command line from env KERNEL_CMDLINE: $cmdline"
+    elif read_proc_cmdline; then
+        read_proc_cmdline && cmdline="$_RET"
+        debug 1 "kernel command line ($_RET_MSG): $cmdline"
+    fi
+    _RET="unset"
+    cmdline=" $cmdline "
+    tok=${cmdline##* cloud-init=}
+    [ "$tok" = "$cmdline" ] && _RET="unset"
+    tok=${tok%% *}
+    [ "$tok" = "$ENABLE" -o "$tok" = "$DISABLE" ] && _RET="$tok"
+    return 0
+}
+
+default() {
+    _RET="$ENABLE"
+}
+
+main() {
+    local normal_d="$1" early_d="$2" late_d="$3"
+    local target_name="multi-user.target" gen_d="$early_d"
+    local link_path="$gen_d/${target_name}.wants/${CLOUD_TARGET_NAME}"
+
+    debug 1 "$0 normal=$normal_d early=$early_d late=$late_d"
+    debug 2 "$0 $*"
+
+    local search result="error" ret=""
+    for search in kernel_cmdline etc_file default; do
+        if $search; then
+            debug 1 "$search found $_RET"
+            [ "$_RET" = "$ENABLE" -o "$_RET" = "$DISABLE" ] &&
+                result=$_RET && break
+        else
+            ret=$?
+            debug 0 "search $search returned $ret"
+        fi
+    done
+    
+    if [ "$result" = "$ENABLE" ]; then
+        if [ -e "$link_path" ]; then
+                debug 1 "already enabled: no change needed"
+        else
+            [ -d "${link_path%/*}" ] || mkdir -p "${link_path%/*}" ||
+                debug 0 "failed to make dir $link_path"
+            if ln -snf "$CLOUD_SYSTEM_TARGET" "$link_path"; then
+                debug 1 "enabled via $link_path -> $CLOUD_SYSTEM_TARGET"
+            else
+                ret=$?
+                debug 0 "[$ret] enable failed:" \
+                    "ln $CLOUD_SYSTEM_TARGET $link_path"
+            fi
+        fi
+    elif [ "$result" = "$DISABLE" ]; then
+        if [ -f "$link_path" ]; then
+            if rm -f "$link_path"; then
+                debug 1 "disabled. removed existing $link_path"
+            else
+                ret=$?
+                debug 0 "[$ret] disable failed, remove $link_path"
+            fi
+        else
+            debug 1 "already disabled: no change needed [no $link_path]"
+        fi
+    else
+        debug 0 "unexpected result '$result'"
+        ret=3
+    fi
+    return $ret
+}
+
+main "$@"
+
+# vi: ts=4 expandtab

=== modified file 'systemd/cloud-init-local.service'
--- systemd/cloud-init-local.service	2013-09-20 23:04:49 +0000
+++ systemd/cloud-init-local.service	2016-03-04 05:04:21 +0000
@@ -13,4 +13,4 @@
 StandardOutput=journal+console
 
 [Install]
-WantedBy=multi-user.target
+WantedBy=cloud-init.target

=== modified file 'systemd/cloud-init.service'
--- systemd/cloud-init.service	2015-04-09 15:54:01 +0000
+++ systemd/cloud-init.service	2016-03-04 05:04:21 +0000
@@ -15,4 +15,4 @@
 StandardOutput=journal+console
 
 [Install]
-WantedBy=multi-user.target
+WantedBy=cloud-init.target

=== added file 'systemd/cloud-init.target'
--- systemd/cloud-init.target	1970-01-01 00:00:00 +0000
+++ systemd/cloud-init.target	2016-03-04 05:04:21 +0000
@@ -0,0 +1,6 @@
+# cloud-init target is enabled by cloud-init-generator
+# To disable it you can either:
+#  a.) boot with kernel cmdline of 'cloudinit=disabled'
+#  b.) touch a file /etc/cloud/cloud-init.disabled
+[Unit]
+Description=Cloud-init target