#!/usr/bin/python
-# Copyright 2011, 2012 Lars Wirzenius
+# Copyright 2011-2013 Lars Wirzenius
# Copyright 2012 Codethink Limited
-#
+#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
-#
+#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
-#
+#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import logging
import os
import re
+import time
import shutil
import subprocess
import tempfile
+import time
+
+
+__version__ = '0.3'
class VmDebootstrap(cliapp.Application):
def add_settings(self):
- default_arch = 'amd64'
+ default_arch = self.runcmd(
+ ["dpkg", "--print-architecture"],
+ ignore_fail=False).strip()
self.settings.boolean(['verbose'], 'report what is going on')
self.settings.string(['image'], 'put created disk image in FILE',
'create a disk image of size SIZE (%default)',
metavar='SIZE',
default='1G')
+ self.settings.bytesize(['bootsize'],
+ 'create boot partition of size SIZE (%default)',
+ metavar='BOOTSIZE',
+ default='0%')
+ self.settings.string(['boottype'],
+ 'specify file system type for /boot/',
+ default='ext2')
+ self.settings.string(['foreign'],
+ 'set up foreign debootstrap environment using provided program (ie binfmt handler)')
+ self.settings.string(['variant'],
+ 'select debootstrap variant it not using the default')
+ self.settings.boolean(
+ ['extlinux'],
+ 'install extlinux?',
+ default=True)
+ self.settings.string(['tarball'], "tar up the disk's contents in FILE",
+ metavar='FILE')
self.settings.string(['mirror'],
'use MIRROR as package source (%default)',
metavar='URL',
self.settings.string_list(['package'], 'install PACKAGE onto system')
self.settings.string_list(['custom-package'],
'install package in DEB file onto system '
- '(not from mirror)',
+ '(not from mirror)',
metavar='DEB')
self.settings.boolean(['no-kernel'], 'do not install a linux package')
self.settings.boolean(['enable-dhcp'], 'enable DHCP on eth0')
self.settings.string(['root-password'], 'set root password',
metavar='PASSWORD')
- self.settings.boolean(['lock-root-password'],
+ self.settings.boolean(['lock-root-password'],
'lock root account so they cannot login?')
self.settings.string(['customize'],
'run SCRIPT after setting up system',
self.settings.string_list(['user'],
'create USER with PASSWORD',
metavar='USER/PASSWORD')
- self.settings.boolean(['serial-console'],
+ self.settings.boolean(['serial-console'],
'configure image to use a serial console')
- self.settings.boolean(['sudo'],
+ self.settings.string(['serial-console-command'],
+ 'command to manage the serial console, appended '
+ 'to /etc/inittab (%default)',
+ metavar='COMMAND',
+ default='/sbin/getty -L ttyS0 115200 vt100')
+ self.settings.boolean(['sudo'],
'install sudo, and if user is created, add them '
- 'to sudo group')
+ 'to sudo group')
+ self.settings.string(['owner'],
+ 'the user who will own the image when the build '
+ 'is complete.')
+ self.settings.boolean(['squash'],
+ 'use squashfs on the final image.')
+ self.settings.boolean(['configure-apt'],
+ 'Create an apt source based on the distribution '
+ 'and mirror selected.')
def process_args(self, args):
- if not self.settings['image']:
- raise cliapp.AppException('You must give image filename.')
- if not self.settings['size']:
- raise cliapp.AppException('You must give image size.')
+ if not self.settings['image'] and not self.settings['tarball']:
+ raise cliapp.AppException('You must give disk image filename, '
+ 'or tarball filename')
+ if self.settings['image'] and not self.settings['size']:
+ raise cliapp.AppException('If disk image is specified, '
+ 'You must give image size.')
self.remove_dirs = []
self.mount_points = []
try:
- self.create_empty_image()
- self.partition_image()
- self.install_mbr()
- rootdev = self.setup_kpartx()
- self.mkfs(rootdev)
- rootdir = self.mount(rootdev)
+ rootdev = None
+ roottype = 'ext4'
+ bootdev = None
+ boottype = None
+ rootdir = None
+ if self.settings['image']:
+ self.create_empty_image()
+ self.partition_image()
+ self.install_mbr()
+ (rootdev, bootdev) = self.setup_kpartx()
+ self.mkfs(rootdev, type=roottype)
+ rootdir = self.mount(rootdev)
+ if bootdev:
+ if self.settings['boottype']:
+ boottype = self.settings['boottype']
+ else:
+ boottype = 'ext2'
+ self.mkfs(bootdev, type=boottype)
+ bootdir = '%s/%s' % (rootdir, 'boot/')
+ os.mkdir(bootdir)
+ bootdir = self.mount(bootdev, bootdir)
+ else:
+ rootdir = self.mkdtemp()
self.debootstrap(rootdir)
self.set_hostname(rootdir)
- self.create_fstab(rootdir)
+ self.create_fstab(rootdir, rootdev, roottype, bootdev, boottype)
self.install_debs(rootdir)
+ self.cleanup_apt_cache(rootdir)
self.set_root_password(rootdir)
self.create_users(rootdir)
self.remove_udev_persistent_rules(rootdir)
self.setup_networking(rootdir)
+ self.configure_apt(rootdir)
self.customize(rootdir)
- self.install_extlinux(rootdev, rootdir)
+ if self.settings['image']:
+ if self.settings['extlinux']:
+ self.install_extlinux(rootdev, rootdir)
+ self.append_serial_console(rootdir)
+ self.optimize_image(rootdir)
+ if self.settings['squash']:
+ self.squash()
+
+ if self.settings['foreign']:
+ os.unlink('%s/usr/bin/%s' %
+ (rootdir, os.path.basename(self.settings['foreign'])))
+
+ if self.settings['tarball']:
+ self.create_tarball(rootdir)
+
+ if self.settings['owner']:
+ self.chown(rootdir)
except BaseException, e:
self.message('EEEK! Something bad happened...')
+ if rootdir:
+ db_log = os.path.join(rootdir, 'debootstrap', 'debootstrap.log')
+ if os.path.exists(db_log):
+ shutil.copy(db_log, os.getcwd())
+ self.message(e)
self.cleanup_system()
raise
else:
def runcmd(self, argv, stdin='', ignore_fail=False, **kwargs):
logging.debug('runcmd: %s %s' % (argv, kwargs))
- p = subprocess.Popen(argv, stdin=subprocess.PIPE,
- stdout=subprocess.PIPE, stderr=subprocess.PIPE,
+ p = subprocess.Popen(argv, stdin=subprocess.PIPE,
+ stdout=subprocess.PIPE, stderr=subprocess.PIPE,
**kwargs)
out, err = p.communicate(stdin)
if p.returncode != 0:
self.remove_dirs.append(dirname)
logging.debug('mkdir %s' % dirname)
return dirname
-
- def mount(self, device):
- self.message('Mounting %s' % device)
- mount_point = self.mkdtemp()
+
+ def mount(self, device, path=None):
+ if not path:
+ mount_point = self.mkdtemp()
+ else:
+ mount_point = path
+ self.message('Mounting %s on %s' % (device, mount_point))
self.runcmd(['mount', device, mount_point])
self.mount_points.append(mount_point)
logging.debug('mounted %s on %s' % (device, mount_point))
def create_empty_image(self):
self.message('Creating disk image')
- self.runcmd(['qemu-img', 'create', '-f', 'raw',
+ self.runcmd(['qemu-img', 'create', '-f', 'raw',
self.settings['image'],
str(self.settings['size'])])
self.message('Creating partitions')
self.runcmd(['parted', '-s', self.settings['image'],
'mklabel', 'msdos'])
+ if self.settings['bootsize'] and self.settings['bootsize'] is not '0%':
+ bootsize = str(self.settings['bootsize'] / (1024 * 1024))
+ self.runcmd(['parted', '-s', self.settings['image'],
+ 'mkpart', 'primary', 'fat16', '0', bootsize])
+ else:
+ bootsize = '0%'
self.runcmd(['parted', '-s', self.settings['image'],
- 'mkpart', 'primary', '0%', '100%'])
+ 'mkpart', 'primary', bootsize, '100%'])
self.runcmd(['parted', '-s', self.settings['image'],
'set', '1', 'boot', 'on'])
def install_mbr(self):
- self.message('Installing MBR')
- self.runcmd(['install-mbr', self.settings['image']])
+ if os.path.exists("/sbin/install-mbr"):
+ self.message('Installing MBR')
+ self.runcmd(['install-mbr', self.settings['image']])
def setup_kpartx(self):
- out = self.runcmd(['kpartx', '-av', self.settings['image']])
+ out = self.runcmd(['kpartx', '-avs', self.settings['image']])
+ if self.settings['bootsize']:
+ bootindex = 0
+ rootindex = 1
+ parts = 2
+ else:
+ rootindex = 0
+ parts = 1
+ boot = None
devices = [line.split()[2]
for line in out.splitlines()
if line.startswith('add map ')]
- if len(devices) != 1:
+ if len(devices) != parts:
raise cliapp.AppException('Surprising number of partitions')
- return '/dev/mapper/%s' % devices[0]
+ root = '/dev/mapper/%s' % devices[rootindex]
+ if self.settings['bootsize']:
+ boot = '/dev/mapper/%s' % devices[bootindex]
+ return (root, boot)
+
+ def mkfs(self, device, type):
+ self.message('Creating filesystem %s' % type)
+ self.runcmd(['mkfs', '-t', type, device])
- def mkfs(self, device):
- self.message('Creating filesystem')
- self.runcmd(['mkfs', '-t', 'ext2', device])
-
def debootstrap(self, rootdir):
self.message('Debootstrapping')
+ if self.settings['foreign']:
+ necessary_packages = []
+ else:
+ necessary_packages = ['acpid']
+
include = self.settings['package']
if not self.settings['no-kernel']:
if self.settings['arch'] == 'i386':
- kernel_arch = '686'
+ kernel_arch = '486'
else:
kernel_arch = self.settings['arch']
- kernel_image = 'linux-image-2.6-%s' % kernel_arch
+ kernel_image = 'linux-image-%s' % kernel_arch
include.append(kernel_image)
if self.settings['sudo'] and 'sudo' not in include:
include.append('sudo')
args = ['debootstrap', '--arch=%s' % self.settings['arch']]
- if include: args.append('--include=%s' % ','.join(include))
+ args.append(
+ '--include=%s' % ','.join(necessary_packages + include))
+ if self.settings['foreign']:
+ args.append('--foreign')
+ if self.settings['variant']:
+ args.append('--variant')
+ args.append(self.settings['variant'])
args += [self.settings['distribution'],
rootdir, self.settings['mirror']]
+ logging.debug(" ".join(args))
self.runcmd(args)
+ if self.settings['foreign']:
+ # First copy the binfmt handler over
+ shutil.copy(self.settings['foreign'], '%s/usr/bin/' % rootdir)
+ # Next, run the package install scripts etc.
+ self.message('Running debootstrap second stage')
+ self.runcmd(['chroot', rootdir,
+ '/debootstrap/debootstrap', '--second-stage'])
def set_hostname(self, rootdir):
hostname = self.settings['hostname']
with open(os.path.join(rootdir, 'etc', 'hostname'), 'w') as f:
f.write('%s\n' % hostname)
-
+
etc_hosts = os.path.join(rootdir, 'etc', 'hosts')
- with open(etc_hosts, 'r') as f:
- data = f.read()
- with open(etc_hosts, 'w') as f:
- for line in data.splitlines():
- if line.startswith('127.0.0.1'):
- line += ' %s' % hostname
- f.write('%s\n' % line)
-
- def create_fstab(self, rootdir):
+ try:
+ with open(etc_hosts, 'r') as f:
+ data = f.read()
+ with open(etc_hosts, 'w') as f:
+ for line in data.splitlines():
+ if line.startswith('127.0.0.1'):
+ line += ' %s' % hostname
+ f.write('%s\n' % line)
+ except IOError, e:
+ pass
+
+ def create_fstab(self, rootdir, rootdev, roottype, bootdev, boottype):
+ def fsuuid(device):
+ out = self.runcmd(['blkid', '-c', '/dev/null', '-o', 'value',
+ '-s', 'UUID', device])
+ return out.splitlines()[0].strip()
+
+ if rootdev:
+ rootdevstr = 'UUID=%s' % fsuuid(rootdev)
+ else:
+ rootdevstr = '/dev/sda1'
+
+ if bootdev:
+ bootdevstr = 'UUID=%s' % fsuuid(bootdev)
+ else:
+ bootdevstr = None
+
fstab = os.path.join(rootdir, 'etc', 'fstab')
with open(fstab, 'w') as f:
f.write('proc /proc proc defaults 0 0\n')
- f.write('/dev/sda1 / ext4 errors=remount-ro 0 1\n')
+ f.write('%s / %s errors=remount-ro 0 1\n' % (rootdevstr, roottype))
+ if bootdevstr:
+ f.write('%s /boot %s errors=remount-ro 0 2\n' % (bootdevstr, boottype))
def install_debs(self, rootdir):
if not self.settings['custom-package']:
self.runcmd_unchecked(['chroot', rootdir, 'dpkg', '-i'] + filenames)
logging.debug('stdout:\n%s' % out)
logging.debug('stderr:\n%s' % err)
- out = self.runcmd(['chroot', rootdir,
- 'apt-get', '-f', '--no-remove', 'install'])
+ out = self.runcmd(['chroot', rootdir,
+ 'apt-get', '-f', '--no-remove', 'install'])
logging.debug('stdout:\n%s' % out)
shutil.rmtree(tmp)
+ def cleanup_apt_cache(self, rootdir):
+ out = self.runcmd(['chroot', rootdir, 'apt-get', 'clean'])
+ logging.debug('stdout:\n%s' % out)
+
def set_root_password(self, rootdir):
if self.settings['root-password']:
self.message('Setting root password')
def setup_networking(self, rootdir):
self.message('Setting up networking')
-
+
f = open(os.path.join(rootdir, 'etc', 'network', 'interfaces'), 'w')
f.write('auto lo\n')
f.write('iface lo inet loopback\n')
-
+
if self.settings['enable-dhcp']:
f.write('\n')
- f.write('allow-hotplug eth0\n')
+ f.write('auto eth0\n')
f.write('iface eth0 inet dhcp\n')
-
+
f.close()
+ def append_serial_console(self, rootdir):
+ if self.settings['serial-console']:
+ serial_command = self.settings['serial-console-command']
+ logging.debug('adding getty to serial console')
+ inittab = os.path.join(rootdir, 'etc/inittab')
+ with open(inittab, 'a') as f:
+ f.write('\nS0:23:respawn:%s\n' % serial_command)
+
def install_extlinux(self, rootdev, rootdir):
+ if not os.path.exists("/usr/bin/extlinux"):
+ self.message("extlinux not installed, skipping.")
+ return
self.message('Installing extlinux')
def find(pattern):
label linux
kernel %(kernel)s
-append initrd=%(initrd)s root=UUID=%(uuid)s ro quiet %(kserial)s
+append initrd=%(initrd)s root=UUID=%(uuid)s ro %(kserial)s
%(extserial)s
''' % {
- 'kernel': kernel_image,
- 'initrd': initrd_image,
- 'uuid': uuid,
- 'kserial':
- 'console=ttyS0,115200' if self.settings['serial-console'] else '',
- 'extserial': 'serial 0 115200' if self.settings['serial-console'] else '',
-})
+ 'kernel': kernel_image,
+ 'initrd': initrd_image,
+ 'uuid': uuid,
+ 'kserial':
+ 'console=ttyS0,115200' if self.settings['serial-console'] else '',
+ 'extserial': 'serial 0 115200' if self.settings['serial-console'] else '',
+ })
f.close()
-
- if self.settings['serial-console']:
- logging.debug('adding getty to serial console')
- inittab = os.path.join(rootdir, 'etc/inittab')
- with open(inittab, 'a') as f:
- f.write('\nS0:23:respawn:/sbin/getty -L ttyS0 115200 vt100\n')
self.runcmd(['extlinux', '--install', rootdir])
self.runcmd(['sync'])
- import time; time.sleep(2)
-
+ time.sleep(2)
+
+ def optimize_image(self, rootdir):
+ """
+ Filing up the image with zeros will increase its compression rate
+ """
+ zeros = os.path.join(rootdir, 'ZEROS')
+ self.runcmd_unchecked(['dd', 'if=/dev/zero', 'of=' + zeros, 'bs=1M'])
+ self.runcmd(['rm', '-f', zeros])
+
+ def squash(self):
+ """
+ Run squashfs on the image.
+ """
+ if not os.path.exists('/usr/bin/mksquashfs'):
+ logging.warning("Squash selected but mksquashfs not found!")
+ return
+ self.message("Running mksquashfs")
+ suffixed = "%s.squashfs" % self.settings['image']
+ self.runcmd(['mksquashfs', self.settings['image'],
+ suffixed,
+ '-no-progress', '-comp', 'xz'], ignore_fail=False)
+ os.unlink(self.settings['image'])
+ self.settings['image'] = suffixed
+
def cleanup_system(self):
# Clean up after any errors.
self.message('Cleaning up')
- for mount_point in self.mount_points:
- self.runcmd(['umount', mount_point], ignore_fail=True)
+ # Umount in the reverse mount order
+ if self.settings['image']:
+ for i in xrange(len(self.mount_points) - 1, -1, -1):
+ mount_point = self.mount_points[i]
+ try:
+ self.runcmd(['umount', mount_point], ignore_fail=False)
+ except cliapp.AppException:
+ logging.debug("umount failed, sleeping and trying again")
+ time.sleep(5)
+ self.runcmd(['umount', mount_point], ignore_fail=False)
+
+ self.runcmd(['kpartx', '-d', self.settings['image']], ignore_fail=True)
- self.runcmd(['kpartx', '-d', self.settings['image']], ignore_fail=True)
-
for dirname in self.remove_dirs:
shutil.rmtree(dirname)
with open('/dev/tty', 'w') as tty:
cliapp.runcmd([script, rootdir], stdout=tty, stderr=tty)
+ def create_tarball(self, rootdir):
+ # Create a tarball of the disk's contents
+ # shell out to runcmd since it more easily handles rootdir
+ self.message('Creating tarball of disk contents')
+ self.runcmd(['tar', '-cf', self.settings['tarball'], '-C', rootdir, '.'])
+
+ def chown(self, rootdir):
+ # Change image owner after completed build
+ self.message("Changing owner to %s" % self.settings["owner"])
+ subprocess.call(["chown",
+ self.settings["owner"],
+ self.settings["image"]])
+
+ def configure_apt(self, rootdir):
+ # use the distribution and mirror to create an apt source
+ self.message("Configuring apt to use distribution and mirror")
+ conf = os.path.join(rootdir, 'etc', 'apt', 'sources.list.d', 'base.list')
+ logging.debug('configure apt %s' % conf)
+ f = open(conf, 'w')
+ f.write('''
+ deb %(mirror)s %(distribution)s main
+ #deb-src %(mirror)s %(distribution)s main
+ ''' % {
+ 'mirror': self.settings['mirror'],
+ 'distribution': self.settings['distribution']
+ })
+ f.close()
if __name__ == '__main__':
- VmDebootstrap().run()
-
+ VmDebootstrap(version=__version__).run()
projects / forks / vmdebootstrap.git / blobdiff