duck-installer 0.2.1

data/README

@@ -0,0 +1,35 @@
+duck
+----
+
+A minimalist installer system generator.
+
+about
+-----
+
+Duck will help you generate installer system images setup as an initrd, similar
+to how debian-installer works.
+
+There are however a few goals with duck that are different.
+
+* No memory restrictions (debian-installer is geared towards 32M)
+* Less rigorous space restrictions
+  - No special packaging necessary, but encouraged: http://www.emdebian.org/
+  - No library stripping.
+
+All in all, you get a slightly bigger installer image, but a lot more
+flexibility.
+
+usage
+-----
+
+Duck has two steps in creating an initrd.
+
+setup - Setup base configuration.
+
+build - Build the base system.
+pack - Pack the resulting initrd.gz
+
+For testing/tweaking there are two other commands available.
+
+enter - Enter the chroot that is used to build the initrd.
+qemu - Run the resulting initrd in a qemu-based virtual environment.

data/bin/duck

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+if __FILE__ == $0
+    lib = File.expand_path File.join('..', '..', 'lib'), $0
+    $:.insert 0, lib if File.file? File.join(lib, 'duck.rb')
+end
+
+require 'duck'
+exit Duck::main(ARGV)

data/duck.yaml

@@ -0,0 +1,93 @@
+---
+sources:
+  - url: "http://www.emdebian.org/grip"
+    suite: squeeze
+    components:
+      - main
+  - url: "http://ftp.se.debian.org/debian"
+    suite: squeeze
+    components:
+      - main
+
+packages:
+  - binutils
+  - python-argparse
+  - python
+  - grub2
+  - iproute
+  - bind9-host
+  - isc-dhcp-client
+  - net-tools
+  - openssh-server
+  - pciutils
+  - psutils
+  - syslog-ng
+  - udev
+  - vim-tiny
+  - less
+  - strace
+
+files:
+# init file
+  - from: /*
+    to: /
+  - from: /sbin/*
+    to: /sbin/
+    mode: 0755
+# configuration files
+  - from: /etc/*
+    to: /etc/
+  - from: /etc/dhclient-exit-hooks.d/*
+    to: /etc/dhcp/dhclient-exit-hooks.d/
+    mode: 0755
+# installer library
+  - from: /lib/libduck.sh
+    to: /lib/
+  - from: /lib/python-duck/duck/*
+    to: /lib/python-duck/duck/
+# installation steps
+  - from: /lib/duck.d/*
+    to: /lib/duck.d/
+    mode: 0755
+# hooks
+  - from: /lib/duck-hooks.d/*
+    to: /lib/duck-hooks.d/
+    mode: 0755
+
+fixes:
+  # file contains scripts that should be run to fix the target environment.
+  # scripts are located under <out>/fixes
+  - squeeze-fix
+  # disable initrd generation and grub setup for installed kernels.
+  - kernel-boot-fix
+  # remove persistent udev rules.
+  - clear-persistent-udev
+
+services:
+  - name: hostname.sh
+    start: '00 S'
+  - name: mountkernfs.sh
+    start: '00 S'
+  - name: mountdevsubfs.sh
+    start: '00 S'
+  - name: udev
+    start: '00 S'
+  - name: syslog-ng
+    start: '00 2 3 4 5'
+    stop: '00 0 1 6'
+
+keyring:
+  keyserver: "subkeys.pgp.net"
+  keys:
+# debian archive keys
+    - "473041FA"
+    - "B98321F9"
+# puppetlabs
+    - "4BD6EC30"
+# other debian keys for older archives
+    - "30E974EE"
+    - "46925553"
+    - "55BE302B"
+    - "65FFB764"
+    - "6D849617"
+    - "97BB3B58"

data/files/etc/dhclient-exit-hooks.d/hostname

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+if [ "$reason" != BOUND ] && [ "$reason" != RENEW ] \
+   && [ "$reason" != REBIND ] && [ "$reason" != REBOOT ]
+then
+        return
+fi
+
+hostname=$(host $new_ip_address | cut -d ' ' -f 5)
+hostname=${hostname%*.}
+echo $hostname > /etc/hostname
+
+# update the hostname
+hostname $hostname
+
+# restart syslog to use the correct hostname.
+invoke-rc.d syslog-ng restart

data/files/etc/fstab

@@ -0,0 +1 @@
+# empty fstab

data/files/etc/hostname

@@ -0,0 +1 @@
+duck

data/files/etc/hosts

@@ -0,0 +1,2 @@
+127.0.0.1 localhost duckinstall
+::1 localhost

data/files/etc/inittab

@@ -0,0 +1,25 @@
+# The default runlevel.
+id:2:initdefault:
+# Boot-time system configuration/initialization script.
+# This is run first except when booting in emergency (-b) mode.
+si::sysinit:/etc/init.d/rcS
+# What to do in single-user mode.
+~~:S:wait:/sbin/sulogin
+
+l0:0:wait:/etc/init.d/rc 0
+l1:1:wait:/etc/init.d/rc 1
+l2:2:wait:/etc/init.d/rc 2
+l6:6:wait:/etc/init.d/rc 6
+# Normally not reached, but fallthrough in case of emergency.
+z6:6:respawn:/sbin/sulogin
+# What to do when CTRL-ALT-DEL is pressed.
+ca:12345:ctrlaltdel:/sbin/shutdown -t1 -a -r now
+# What to do when the power fails/returns.
+pf::powerwait:/etc/init.d/powerfail start
+pn::powerfailnow:/etc/init.d/powerfail now
+po::powerokwait:/etc/init.d/powerfail stop
+
+1:23:respawn:/sbin/agetty -n -l /sbin/duckinstall 38400 tty1
+2:23:respawn:/sbin/agetty -n -l /sbin/ducklogin 38400 tty2
+3:23:respawn:/sbin/agetty -n -l /sbin/ducklogin 38400 tty3
+4:23:respawn:/sbin/agetty -n -l /sbin/ducklogin 38400 tty4

data/files/etc/mtab

@@ -0,0 +1 @@
+# empty mtab

data/files/init

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+echo "Invocing INIT"
+
+exec /sbin/init
+
+# this will only be run if init cannot be run for some reason.
+echo "System init failed, starting /bin/sh"
+exec /bin/sh

data/files/lib/duck.d/00-splash

@@ -0,0 +1,36 @@
+#!/bin/bash
+. /lib/libduck.sh
+
+cat - <<ENDL
+               _              
+            .-' '-.           
+          .'       '.         
+         :-._o) (o_.-:        
+        (    /   \    )       
+         '-.'     '.-'        
+           '.   .'            
+             i\ /i            
+       .    :  '  :    .      
+        "\. :     : ./"       
+          \\|     |//         
+         .' :     : '.        
+      .-'  :       :  '-.     
+     : i .'         '. i :    
+    :   :             :   :   
+    :  .'             '.  :   
+     :/                 \:    
+      '.               .'     
+        '-._________.-'       
+                              
+      | You are Ducked! |     
+
+ENDL
+
+echo "Installation starting in..."
+echo "3,"
+sleep 1
+echo "2,"
+sleep 1
+echo "1,"
+sleep 1
+echo "NOW"

data/files/lib/duck.d/02-setup-network

@@ -0,0 +1,30 @@
+#!/bin/bash
+. /lib/libduck.sh
+
+if [[ "$DUCK_MODE" == "testing" ]]; then
+    warning "Skipping network configuration, duck/mode=testing"
+    exit 0
+fi
+
+info "network: Setting up loopback interface"
+
+info "network: lo: address"
+ip addr add 127.0.0.1/8 dev lo || true
+info "network: lo: route"
+ip route add 127.0.0.0/8 dev lo || true
+info "network: lo: link up"
+ip link set lo up
+
+info "network: eth0: Configuring using dhcp"
+
+if ! dhclient eth0; then
+    error "Network setup failed"
+    exit 1
+fi
+
+info "network: eth0: link up"
+
+# Set hostname from DHCP
+a_set hostname $(hostname)
+
+exit 0

data/files/lib/duck.d/40-debootstrap

@@ -0,0 +1,16 @@
+#!/bin/bash
+. /lib/libduck.sh
+a_get_into target duck/target
+a_get_into suite debootstrap/suite
+a_get_into mirror debootstrap/mirror
+
+if [[ ! -d $target ]]; then
+    error "Target does not exist: $target"
+    exit 1
+fi
+
+debootstrap $suite $target $mirror
+
+mount --bind /dev $target/dev
+mount -t proc none $target/proc
+mount -t sysfs none $target/sys

data/files/lib/duck.d/41-add-policy-rc.d

@@ -0,0 +1,14 @@
+#!/bin/bash
+# vim: filetype=sh
+. /lib/libduck.sh
+a_get_into target duck/target
+
+policy_rcd=$target/usr/sbin/policy-rc.d
+
+(
+    set -e
+    echo "#!/bin/bash"
+    echo "exit 101"
+) > $policy_rcd
+
+chmod +x $policy_rcd

data/files/lib/duck.d/41-update-hostname

@@ -0,0 +1,9 @@
+#!/bin/bash
+. /lib/libduck.sh
+a_get_into hostname hostname
+a_get_into target duck/target
+
+info "duckdb: Setting hostname in target"
+echo $hostname > $target/etc/hostname
+
+exit 0

data/files/lib/duck.d/98-remove-policy-rc.d

@@ -0,0 +1,9 @@
+#!/bin/bash
+# vim: filetype=sh
+. /lib/libduck.sh
+a_get_into target duck/target
+
+info "Removing policy-rc.d"
+
+policy_rcd=$target/usr/sbin/policy-rc.d
+rm -f $policy_rcd

data/files/lib/duck.d/99-reboot

@@ -0,0 +1,18 @@
+#!/bin/bash
+. /lib/libduck.sh
+a_get_into reboot_enabled "reboot/enabled" "True"
+
+if [[ "$DUCK_MODE" == "testing" ]]; then
+    warning "Not rebooting, duck/mode=testing"
+    exit 0
+fi
+
+info "Installation done, rebooting!"
+
+if [[ "$reboot_enabled" == "True" ]]; then
+    reboot
+else
+    info "Not rebooting, reboot/enabled=$reboot_enabled"
+fi
+
+exit 0

data/files/lib/libduck.sh

@@ -0,0 +1,152 @@
+#!/bin/bash
+set -e
+
+# static variables
+export DUCK_VERSION="0.1"
+export DUCKDB_CONF="/duckdb.conf"
+export DUCKDB_JSON="/duckdb.json"
+# if this file exists, the installation loop should not run.
+export INSTALLER_STATUS="/.installer_status"
+# default logging location.
+export DEFAULT_LOG="/var/log/duckinstall.log"
+export DUCK_LOGIN="/sbin/ducklogin"
+export DUCK_HOOKS="/lib/duck-hooks.d"
+export DUCK_PYTHONLIB="/lib/python-duck"
+export PYTHONPATH="$DUCK_PYTHONLIB"
+
+invoke_hook() {
+  name=$1
+  shift
+  path=$DUCK_HOOKS/$name
+  [[ -x $path ]] && ( $path "$@" || true )
+}
+
+info()    {
+  echo "INFO : $@";
+  invoke_hook log info "$@"
+}
+
+warning() {
+  echo "WARNING : $@";
+  invoke_hook log warning "$@"
+}
+
+error()   {
+  echo "ERROR : $@";
+  invoke_hook log error "$@"
+}
+
+setup_duckdb() {
+    info "duckdb: Loading Static Variables"
+
+    if [[ -f $DUCKDB_CONF ]]; then
+      info "duckdb: Loading $DUCKDB_CONF"
+      duckdb url file://$DUCKDB_CONF
+    fi
+
+    if [[ -f $DUCKDB_JSON ]]; then
+      info "duckdb: Loading $DUCKDB_JSON"
+      duckdb url --json file://$DUCKDB_JSON
+    fi
+
+    info "duckdb: Loading /proc/cmdline"
+
+    if ! duckdb url --cmdline file:///proc/cmdline; then
+        error "duckdb: Failed to load kernel arguments"
+        return 1
+    fi
+
+    # Time to enable hooks.
+    duckdb set --json duck/hooks-enabled true
+    duckdb set --json duck/log-hook-enabled true
+}
+
+run_installer() {
+    if ! setup_duckdb; then
+        return 1
+    fi
+
+    for script in /lib/duck.d/[0-9][0-9]-*; do
+        [[ ! -x $script ]] && continue
+
+        info "Running: $script"
+        logger -t installer "running: $script"
+
+        if ! $script; then
+            error "Failed: $script"
+            return 1
+        fi
+    done
+
+    return 0
+}
+
+# Run a command in the target environment.
+# required duckdb variables:
+#  - duck/target
+in_target() {
+    # run chroot invocation inside of a subshell
+    # this allows us to override some useful environment variables
+    # at leisure.
+
+    a_get_into target duck/target
+
+    command="$@"
+
+    info "in-target: $command"
+
+    (
+        export DEBIAN_FRONTEND=noninteractive
+        export DEBCONF_NONINTERACTIVE_SEEN=true
+        export LC_ALL=C
+        export LANGUAGE=C
+        export LANG=C
+        exec chroot $target $command
+    )
+
+    return $?
+}
+
+
+# get single duckdb variable
+# exports the RET variable containing the value of the requested variable
+# or invokes 'exit 1' if it was unable to fetch the value from duckdb.
+#
+# a_get duck/mode
+# duck_mode="$RET"
+#
+# duckdb supprts the notion of default values, in that case, two arguments
+# should be provided, as follows.
+#
+# a_get duck/mode testing
+# duck_mode="$RET"
+a_get() {
+    export DUCK_RETURN=""
+    export DUCK_OK="no"
+
+    eval $(duckdb get --sh "$@")
+
+    if [[ "$DUCK_OK" != "yes" ]]; then
+        error "Missing required duckdb variable: $1"
+        exit 1
+    fi
+
+    export RET=$DUCK_RETURN
+}
+
+# This function was introduced because the common idiom of assigning RET
+# resulted in code which was error prone.
+a_get_into() {
+    name=$1
+    shift
+    a_get "$@"
+    export "$name"="$RET"
+}
+
+# set single duckdb variable
+a_set() {
+    eval $(duckdb set "$@");
+}
+
+# Dynamic Variables
+a_get_into DUCK_MODE duck/mode "testing"