4 # template script for generating ubuntu container for LXC
6 # This script consolidates and extends the existing lxc ubuntu scripts
9 # Copyright © 2011 Serge Hallyn <serge.hallyn@canonical.com>
10 # Copyright © 2010 Wilhelm Meier
11 # Author: Wilhelm Meier <wilhelm.meier@fh-kl.de>
13 # This program is free software; you can redistribute it and/or modify
14 # it under the terms of the GNU General Public License version 2, as
15 # published by the Free Software Foundation.
17 # This program is distributed in the hope that it will be useful,
18 # but WITHOUT ANY WARRANTY; without even the implied warranty of
19 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 # GNU General Public License for more details.
22 # You should have received a copy of the GNU General Public License along
23 # with this program; if not, write to the Free Software Foundation, Inc.,
24 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
29 if [ -r /etc/default/lxc ]; then
39 # configure the network using the dhcp
40 cat <<EOF > $rootfs/etc/network/interfaces
41 # This file describes the network interfaces available on your system
42 # and how to activate them. For more information, see interfaces(5).
44 # The loopback network interface
46 iface lo inet loopback
53 cat <<EOF > $rootfs/etc/hostname
57 cat <<EOF > $rootfs/etc/hosts
61 # The following lines are desirable for IPv6 capable hosts
62 ::1 ip6-localhost ip6-loopback
64 ff00::0 ip6-mcastprefix
66 ff02::2 ip6-allrouters
69 if [ ! -f $rootfs/etc/init/container-detect.conf ]; then
70 # suppress log level output for udev
71 sed -i "s/=\"err\"/=0/" $rootfs/etc/udev/udev.conf
73 # remove jobs for consoles 5 and 6 since we only create 4 consoles in
75 rm -f $rootfs/etc/init/tty{5,6}.conf
78 if [ -z "$bindhome" ]; then
79 chroot $rootfs useradd --create-home -s /bin/bash ubuntu
80 echo "ubuntu:ubuntu" | chroot $rootfs chpasswd
86 # finish setting up the user in the container by injecting ssh key and
87 # adding sudo group membership.
88 # passed-in user is either 'ubuntu' or the user to bind in from host.
93 sudo_version=$(chroot $rootfs dpkg-query -W -f='${Version}' sudo)
95 if chroot $rootfs dpkg --compare-versions $sudo_version gt "1.8.3p1-1"; then
101 for group in $groups; do
102 chroot $rootfs groupadd --system $group >/dev/null 2>&1 || true
103 chroot $rootfs adduser ${user} $group >/dev/null 2>&1 || true
106 if [ -n "$auth_key" -a -f "$auth_key" ]; then
107 u_path="/home/${user}/.ssh"
108 root_u_path="$rootfs/$u_path"
110 mkdir -p $root_u_path
111 cp $auth_key "$root_u_path/authorized_keys"
112 chroot $rootfs chown -R ${user}: "$u_path"
114 echo "Inserted SSH public key from $auth_key into /home/${user}/.ssh/authorized_keys"
121 # $1 => path to the rootfs
122 # $2 => architecture we want to add
123 # $3 => whether to use the multi-arch syntax or not
127 MIRROR=${MIRROR:-http://archive.ubuntu.com/ubuntu}
128 SECURITY_MIRROR=${SECURITY_MIRROR:-http://security.ubuntu.com/ubuntu}
131 MIRROR=${MIRROR:-http://ports.ubuntu.com/ubuntu-ports}
132 SECURITY_MIRROR=${SECURITY_MIRROR:-http://ports.ubuntu.com/ubuntu-ports}
136 cat >> "$1/etc/apt/sources.list" << EOF
137 deb [arch=$2] $MIRROR ${release} main restricted universe multiverse
138 deb [arch=$2] $MIRROR ${release}-updates main restricted universe multiverse
139 deb [arch=$2] $SECURITY_MIRROR ${release}-security main restricted universe multiverse
142 cat >> "$1/etc/apt/sources.list" << EOF
143 deb $MIRROR ${release} main restricted universe multiverse
144 deb $MIRROR ${release}-updates main restricted universe multiverse
145 deb $SECURITY_MIRROR ${release}-security main restricted universe multiverse
157 echo "installing packages: $packages"
159 # check the mini ubuntu was not already downloaded
160 mkdir -p "$cache/partial-$arch"
161 if [ $? -ne 0 ]; then
162 echo "Failed to create '$cache/partial-$arch' directory"
166 # download a mini ubuntu into a cache
167 echo "Downloading ubuntu $release minimal ..."
168 if [ -n "$(which qemu-debootstrap)" ]; then
169 qemu-debootstrap --verbose --components=main,universe --arch=$arch --include=$packages $release $cache/partial-$arch $MIRROR
171 debootstrap --verbose --components=main,universe --arch=$arch --include=$packages $release $cache/partial-$arch $MIRROR
174 if [ $? -ne 0 ]; then
175 echo "Failed to download the rootfs, aborting."
179 # Serge isn't sure whether we should avoid doing this when
180 # $release == `distro-info -d`
181 echo "Installing updates"
182 > $cache/partial-$arch/etc/apt/sources.list
183 write_sourceslist $cache/partial-$arch/ $arch
185 chroot "$1/partial-${arch}" apt-get update
186 if [ $? -ne 0 ]; then
187 echo "Failed to update the apt cache"
190 cat > "$1/partial-${arch}"/usr/sbin/policy-rc.d << EOF
194 chmod +x "$1/partial-${arch}"/usr/sbin/policy-rc.d
196 lxc-unshare -s MOUNT -- chroot "$1/partial-${arch}" apt-get dist-upgrade -y
198 rm -f "$1/partial-${arch}"/usr/sbin/policy-rc.d
200 if [ $ret -ne 0 ]; then
201 echo "Failed to upgrade the cache"
205 mv "$1/partial-$arch" "$1/rootfs-$arch"
206 echo "Download complete"
216 # make a local copy of the miniubuntu
217 echo "Copying rootfs to $rootfs ..."
219 rsync -a $cache/rootfs-$arch/ $rootfs/ || return 1
228 cache="/var/cache/lxc/$release"
229 mkdir -p /var/lock/subsys/
233 if [ $? -ne 0 ]; then
234 echo "Cache repository is busy."
239 if [ $flushcache -eq 1 ]; then
240 echo "Flushing cache..."
241 rm -rf "$cache/partial-$arch"
242 rm -rf "$cache/rootfs-$arch"
245 echo "Checking cache download in $cache/rootfs-$arch ... "
246 if [ ! -e "$cache/rootfs-$arch" ]; then
247 download_ubuntu $cache $arch $release
248 if [ $? -ne 0 ]; then
249 echo "Failed to download 'ubuntu $release base'"
254 echo "Copy $cache/rootfs-$arch to $rootfs ... "
255 copy_ubuntu $cache $arch $rootfs
256 if [ $? -ne 0 ]; then
257 echo "Failed to copy rootfs"
263 ) 200>/var/lock/subsys/lxc
276 if [ $arch = "i386" ]; then
281 if [ -f $rootfs/etc/init/container-detect.conf ]; then
285 # if there is exactly one veth network entry, make sure it has an
287 nics=`grep -e '^lxc\.network\.type[ \t]*=[ \t]*veth' $path/config | wc -l`
288 if [ $nics -eq 1 ]; then
289 grep -q "^lxc.network.hwaddr" $path/config || cat <<EOF >> $path/config
290 lxc.network.hwaddr = 00:16:3e:$(openssl rand -hex 3| sed 's/\(..\)/\1:/g; s/.$//')
294 cat <<EOF >> $path/config
297 lxc.devttydir =$ttydir
301 lxc.mount = $path/fstab
303 lxc.cap.drop = sys_module mac_admin
304 lxc.pivotdir = lxc_putold
306 # uncomment the next line to run the container unconfined:
307 #lxc.aa_profile = unconfined
309 lxc.cgroup.devices.deny = a
310 # Allow any mknod (but not using the node)
311 lxc.cgroup.devices.allow = c *:* m
312 lxc.cgroup.devices.allow = b *:* m
314 lxc.cgroup.devices.allow = c 1:3 rwm
315 lxc.cgroup.devices.allow = c 1:5 rwm
317 lxc.cgroup.devices.allow = c 5:1 rwm
318 lxc.cgroup.devices.allow = c 5:0 rwm
319 #lxc.cgroup.devices.allow = c 4:0 rwm
320 #lxc.cgroup.devices.allow = c 4:1 rwm
322 lxc.cgroup.devices.allow = c 1:9 rwm
323 lxc.cgroup.devices.allow = c 1:8 rwm
324 lxc.cgroup.devices.allow = c 136:* rwm
325 lxc.cgroup.devices.allow = c 5:2 rwm
327 lxc.cgroup.devices.allow = c 254:0 rwm
329 lxc.cgroup.devices.allow = c 10:229 rwm
331 lxc.cgroup.devices.allow = c 10:200 rwm
333 lxc.cgroup.devices.allow = c 1:7 rwm
335 lxc.cgroup.devices.allow = c 10:228 rwm
337 lxc.cgroup.devices.allow = c 10:232 rwm
340 cat <<EOF > $path/fstab
341 proc proc proc nodev,noexec,nosuid 0 0
342 sysfs sys sysfs defaults 0 0
345 if [ $? -ne 0 ]; then
346 echo "Failed to add configuration"
358 # provide the lxc service
359 cat <<EOF > $rootfs/etc/init/lxc.conf
360 # fake some events needed for correct startup other services
362 description "Container Upstart"
367 rm -rf /var/run/*.pid
368 rm -rf /var/run/network/*
369 /sbin/initctl emit stopped JOB=udevtrigger --no-wait
370 /sbin/initctl emit started JOB=udev --no-wait
374 # fix buggus runlevel with sshd
375 cat <<EOF > $rootfs/etc/init/ssh.conf
376 # ssh - OpenBSD Secure Shell server
378 # The OpenSSH server provides secure shell access to the system.
380 description "OpenSSH server"
383 stop on runlevel [!2345]
389 # replaces SSHD_OOM_ADJUST in /etc/default/ssh
393 test -x /usr/sbin/sshd || { stop; exit 0; }
394 test -e /etc/ssh/sshd_not_to_be_run && { stop; exit 0; }
395 test -c /dev/null || { stop; exit 0; }
397 mkdir -p -m0755 /var/run/sshd
400 # if you used to set SSHD_OPTS in /etc/default/ssh, you can change the
401 # 'exec' line here instead
405 cat <<EOF > $rootfs/etc/init/console.conf
408 # This service maintains a console on tty1 from the point the system is
409 # started until it is shut down again.
411 start on stopped rc RUNLEVEL=[2345]
412 stop on runlevel [!2345]
415 exec /sbin/getty -8 38400 /dev/console
418 cat <<EOF > $rootfs/lib/init/fstab
419 # /lib/init/fstab: cleared out for bare-bones lxc
422 # reconfigure some services
423 if [ -z "$LANG" ]; then
424 chroot $rootfs locale-gen en_US.UTF-8
425 chroot $rootfs update-locale LANG=en_US.UTF-8
427 chroot $rootfs locale-gen $LANG
428 chroot $rootfs update-locale LANG=$LANG
431 # remove pointless services in a container
432 chroot $rootfs /usr/sbin/update-rc.d -f ondemand remove
434 chroot $rootfs /bin/bash -c 'cd /etc/init; for f in $(ls u*.conf); do mv $f $f.orig; done'
435 chroot $rootfs /bin/bash -c 'cd /etc/init; for f in $(ls tty[2-9].conf); do mv $f $f.orig; done'
436 chroot $rootfs /bin/bash -c 'cd /etc/init; for f in $(ls plymouth*.conf); do mv $f $f.orig; done'
437 chroot $rootfs /bin/bash -c 'cd /etc/init; for f in $(ls hwclock*.conf); do mv $f $f.orig; done'
438 chroot $rootfs /bin/bash -c 'cd /etc/init; for f in $(ls module*.conf); do mv $f $f.orig; done'
440 # if this isn't lucid, then we need to twiddle the network upstart bits :(
441 if [ $release != "lucid" ]; then
442 sed -i 's/^.*emission handled.*$/echo Emitting lo/' $rootfs/etc/network/if-up.d/upstart
452 if [ $trim_container -eq 1 ]; then
453 trim $rootfs $release
454 elif [ ! -f $rootfs/etc/init/container-detect.conf ]; then
455 # Make sure we have a working resolv.conf
456 cresolvonf="${rootfs}/etc/resolv.conf"
457 mv $cresolvonf ${cresolvonf}.lxcbak
458 cat /etc/resolv.conf > ${cresolvonf}
460 # for lucid, if not trimming, then add the ubuntu-virt
461 # ppa and install lxcguest
462 if [ $release = "lucid" ]; then
463 chroot $rootfs apt-get install --force-yes -y python-software-properties
464 chroot $rootfs add-apt-repository ppa:ubuntu-virt/ppa
467 chroot $rootfs apt-get update
468 chroot $rootfs apt-get install --force-yes -y lxcguest
470 # Restore old resolv.conf
472 mv ${cresolvonf}.lxcbak ${cresolvonf}
475 # If the container isn't running a native architecture, setup multiarch
476 if [ -x "$(ls -1 ${rootfs}/usr/bin/qemu-*-static 2>/dev/null)" ]; then
477 dpkg_version=$(chroot $rootfs dpkg-query -W -f='${Version}' dpkg)
478 if chroot $rootfs dpkg --compare-versions $dpkg_version ge "1.16.2"; then
479 chroot $rootfs dpkg --add-architecture ${hostarch}
481 mkdir -p ${rootfs}/etc/dpkg/dpkg.cfg.d
482 echo "foreign-architecture ${hostarch}" > ${rootfs}/etc/dpkg/dpkg.cfg.d/lxc-multiarch
485 # Save existing value of MIRROR and SECURITY_MIRROR
486 DEFAULT_MIRROR=$MIRROR
487 DEFAULT_SECURITY_MIRROR=$SECURITY_MIRROR
489 # Write a new sources.list containing both native and multiarch entries
490 > ${rootfs}/etc/apt/sources.list
491 write_sourceslist $rootfs $arch "native"
493 MIRROR=$DEFAULT_MIRROR
494 SECURITY_MIRROR=$DEFAULT_SECURITY_MIRROR
495 write_sourceslist $rootfs $hostarch "multiarch"
497 # Finally update the lists and install upstart using the host architecture
498 chroot $rootfs apt-get update
499 chroot $rootfs apt-get install --force-yes -y --no-install-recommends upstart:${hostarch} mountall:${hostarch} iproute:${hostarch} isc-dhcp-client:${hostarch}
502 # rmdir /dev/shm for containers that have /run/shm
503 # I'm afraid of doing rm -rf $rootfs/dev/shm, in case it did
504 # get bind mounted to the host's /run/shm. So try to rmdir
505 # it, and in case that fails move it out of the way.
506 if [ ! -L $rootfs/dev/shm ] && [ -d $rootfs/run/shm ] && [ -e $rootfs/dev/shm ]; then
507 mv $rootfs/dev/shm $rootfs/dev/shm.bak
508 ln -s /run/shm $rootfs/dev/shm
517 # copy /etc/passwd, /etc/shadow, and /etc/group entries into container
518 pwd=`getent passwd $user` || { echo "Failed to copy password entry for $user"; false; }
519 echo $pwd >> $rootfs/etc/passwd
521 # make sure user's shell exists in the container
522 shell=`echo $pwd | cut -d: -f 7`
523 if [ ! -x $rootfs/$shell ]; then
524 echo "shell $shell for user $user was not found in the container."
525 pkg=`dpkg -S $(readlink -m $shell) | cut -d ':' -f1`
526 echo "Installing $pkg"
527 chroot $rootfs apt-get --force-yes -y install $pkg
530 shad=`getent shadow $user`
531 echo "$shad" >> $rootfs/etc/shadow
533 # bind-mount the user's path into the container's /home
534 h=`getent passwd $user | cut -d: -f 6`
537 # use relative path in container
539 while [ ${h2:0:1} = "/" ]; do
542 echo "$h $h2 none bind 0 0" >> $path/fstab
544 # Make sure the group exists in container
545 grp=`echo $pwd | cut -d: -f 4` # group number for $user
546 grpe=`getent group $grp` || return 0 # if host doesn't define grp, ignore in container
547 chroot $rootfs getent group "$grpe" || echo "$grpe" >> $rootfs/etc/group
553 $1 -h|--help [-a|--arch] [-b|--bindhome <user>] [--trim] [-d|--debug]
554 [-F | --flush-cache] [-r|--release <release>] [ -S | --auth-key <keyfile>]
555 release: the ubuntu release (e.g. precise): defaults to host release on ubuntu, otherwise uses latest LTS
556 trim: make a minimal (faster, but not upgrade-safe) container
557 bindhome: bind <user>'s home into the container
558 The ubuntu user will not be created, and <user> will have
560 arch: the container architecture (e.g. amd64): defaults to host arch
561 auth-key: SSH Public key file to inject into container
566 options=$(getopt -o a:b:hp:r:xn:FS:d -l arch:,bindhome:,help,path:,release:,trim,name:,flush-cache,auth-key:,debug -- "$@")
567 if [ $? -ne 0 ]; then
571 eval set -- "$options"
573 release=precise # Default to the last Ubuntu LTS release for non-Ubuntu systems
574 if [ -f /etc/lsb-release ]; then
576 if [ "$DISTRIB_ID" = "Ubuntu" ]; then
577 release=$DISTRIB_CODENAME
584 # Code taken from debootstrap
585 if [ -x /usr/bin/dpkg ] && /usr/bin/dpkg --print-architecture >/dev/null 2>&1; then
586 arch=`/usr/bin/dpkg --print-architecture`
587 elif type udpkg >/dev/null 2>&1 && udpkg --print-architecture >/dev/null 2>&1; then
588 arch=`/usr/bin/udpkg --print-architecture`
591 if [ "$arch" = "i686" ]; then
593 elif [ "$arch" = "x86_64" ]; then
595 elif [ "$arch" = "armv7l" ]; then
607 -h|--help) usage $0 && exit 0;;
608 -p|--path) path=$2; shift 2;;
609 -n|--name) name=$2; shift 2;;
610 -F|--flush-cache) flushcache=1; shift 1;;
611 -r|--release) release=$2; shift 2;;
612 -b|--bindhome) bindhome=$2; shift 2;;
613 -a|--arch) arch=$2; shift 2;;
614 -x|--trim) trim_container=1; shift 1;;
615 -S|--auth-key) auth_key=$2; shift 2;;
616 -d|--debug) debug=1; shift 1;;
617 --) shift 1; break ;;
622 if [ $debug -eq 1 ]; then
626 if [ -n "$bindhome" ]; then
627 pwd=`getent passwd $bindhome`
628 if [ $? -ne 0 ]; then
629 echo "Error: no password entry found for $bindhome"
635 if [ "$arch" == "i686" ]; then
639 if [ $hostarch = "i386" -a $arch = "amd64" ]; then
640 echo "can't create amd64 container on i386"
645 if [ $? -ne 0 ]; then
646 echo "'debootstrap' command is missing"
650 if [ -z "$path" ]; then
651 echo "'path' parameter is required"
655 if [ "$(id -u)" != "0" ]; then
656 echo "This script should be run as 'root'"
662 install_ubuntu $rootfs $release $flushcache
663 if [ $? -ne 0 ]; then
664 echo "failed to install ubuntu $release"
668 configure_ubuntu $rootfs $name $release
669 if [ $? -ne 0 ]; then
670 echo "failed to configure ubuntu $release for a container"
674 copy_configuration $path $rootfs $name $arch $release
675 if [ $? -ne 0 ]; then
676 echo "failed write configuration file"
680 post_process $rootfs $release $trim_container
682 if [ -n "$bindhome" ]; then
683 do_bindhome $rootfs $bindhome
684 finalize_user $bindhome
691 echo "# The default user is 'ubuntu' with password 'ubuntu'!"
692 echo "# Use the 'sudo' command to run tasks as root in the container."