vmdebootstrap

   1 #!/usr/bin/python
   2 # Copyright 2011  Lars Wirzenius
   3 #
   4 # This program is free software: you can redistribute it and/or modify
   5 # it under the terms of the GNU General Public License as published by
   6 # the Free Software Foundation, either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 import cliapp
  18 import crypt
  19 import logging
  20 import os
  21 import re
  22 import shutil
  23 import subprocess
  24 import tempfile
  25
  26
  27 class VmDebootstrap(cliapp.Application):
  28
  29     def add_settings(self):
  30         default_arch = 'amd64'
  31
  32         self.settings.add_boolean_setting(['verbose'],
  33                                           'report what is going on')
  34         self.settings.add_string_setting(['image'],
  35                                          'put created disk image in FILE',
  36                                          metavar='FILE')
  37         self.settings.add_bytesize_setting(['size'],
  38                                            'create a disk image of size SIZE '
  39                                             '(%default)',
  40                                            metavar='SIZE',
  41                                            default='1G')
  42         self.settings.add_string_setting(['mirror'],
  43                                          'use MIRROR as package source '
  44                                             '(%default)',
  45                                          metavar='URL',
  46                                      default='http://cdn.debian.net/debian/')
  47         self.settings.add_string_setting(['arch'],
  48                                          'architecture to use '
  49                                             '(%default)',
  50                                          metavar='ARCH',
  51                                          default=default_arch)
  52         self.settings.add_string_setting(['distribution'],
  53                                          'release to use (%default)',
  54                                          metavar='NAME',
  55                                          default='stable')
  56         self.settings.add_string_list_setting(['package'],
  57                                               'install PACKAGE onto system')
  58         self.settings.add_boolean_setting(['enable-dhcp'],
  59                                           'enable DHCP on eth0')
  60         self.settings.add_string_setting(['root-password'],
  61                                          'set root password',
  62                                          metavar='PASSWORD')
  63         self.settings.add_string_setting(['customize'],
  64                                          'run SCRIPT after setting up system',
  65                                          metavar='SCRIPT')
  66
  67     def process_args(self, args):
  68         if not self.settings['image']:
  69             raise cliapp.AppException('You must give image filename.')
  70         if not self.settings['size']:
  71             raise cliapp.AppException('You must give image size.')
  72
  73         self.remove_dirs = []
  74         self.mount_points = []
  75
  76         try:
  77             self.create_empty_image()
  78             self.partition_image()
  79             self.install_mbr()
  80             rootdev = self.setup_kpartx()
  81             self.mkfs(rootdev)
  82             rootdir = self.mount(rootdev)
  83             self.debootstrap(rootdir)
  84             self.set_root_password(rootdir)
  85             self.remove_udev_persistent_rules(rootdir)
  86             self.setup_networking(rootdir)
  87             self.install_extlinux(rootdev, rootdir)
  88             self.customize(rootdir)
  89         except:
  90             self.cleanup()
  91             raise
  92         else:
  93             self.cleanup()
  94
  95     def message(self, msg):
  96         if self.settings['verbose']:
  97             print msg
  98
  99     def runcmd(self, argv, stdin='', ignore_fail=False, **kwargs):
 100         logging.debug('runcmd: %s %s' % (argv, kwargs))
 101         p = subprocess.Popen(argv, stdin=subprocess.PIPE,
 102                              stdout=subprocess.PIPE, stderr=subprocess.PIPE,
 103                              **kwargs)
 104         out, err = p.communicate(stdin)
 105         if p.returncode != 0:
 106             msg = 'command failed: %s\n%s\n%s' % (argv, out, err)
 107             logging.error(msg)
 108             if not ignore_fail:
 109                 raise cliapp.AppException(msg)
 110         return out
 111
 112     def mkdtemp(self):
 113         dirname = tempfile.mkdtemp()
 114         self.remove_dirs.append(dirname)
 115         logging.debug('mkdir %s' % dirname)
 116         return dirname
 117
 118     def mount(self, device):
 119         self.message('Mounting %s' % device)
 120         mount_point = self.mkdtemp()
 121         self.runcmd(['mount', device, mount_point])
 122         self.mount_points.append(mount_point)
 123         logging.debug('mounted %s on %s' % (device, mount_point))
 124         return mount_point
 125
 126     def create_empty_image(self):
 127         self.message('Creating disk image')
 128         self.runcmd(['qemu-img', 'create', '-f', 'raw',
 129                      self.settings['image'],
 130                      str(self.settings['size'])])
 131
 132     def partition_image(self):
 133         self.message('Creating partitions')
 134         self.runcmd(['parted', '-s', self.settings['image'],
 135                      'mklabel', 'msdos'])
 136         self.runcmd(['parted', '-s', self.settings['image'],
 137                      'mkpart', 'primary', '0%', '100%'])
 138         self.runcmd(['parted', '-s', self.settings['image'],
 139                      'set', '1', 'boot', 'on'])
 140
 141     def install_mbr(self):
 142         self.message('Installing MBR')
 143         self.runcmd(['install-mbr', self.settings['image']])
 144
 145     def setup_kpartx(self):
 146         out = self.runcmd(['kpartx', '-av', self.settings['image']])
 147         devices = [line.split()[2]
 148                    for line in out.splitlines()
 149                    if line.startswith('add map ')]
 150         if len(devices) != 1:
 151             raise cliapp.AppException('Surprising number of partitions')
 152         return '/dev/mapper/%s' % devices[0]
 153
 154     def mkfs(self, device):
 155         self.message('Creating filesystem')
 156         self.runcmd(['mkfs', '-t', 'ext2', device])
 157
 158     def debootstrap(self, rootdir):
 159         self.message('Debootstrapping')
 160
 161         if self.settings['arch'] == 'i386':
 162             kernel_arch = 'i686'
 163         else:
 164             kernel_arch = self.settings['arch']
 165         kernel_image = 'linux-image-2.6-%s' % kernel_arch
 166
 167         include = [kernel_image] + self.settings['package']
 168
 169         self.runcmd(['debootstrap',
 170                      '--arch=%s' % self.settings['arch'],
 171                      '--include=%s' % ','.join(include),
 172                      self.settings['distribution'],
 173                      rootdir,
 174                      self.settings['mirror']])
 175
 176     def set_root_password(self, rootdir):
 177         if self.settings['root-password']:
 178             self.message('Setting root password')
 179             encrypted = crypt.crypt(self.settings['root-password'], '..')
 180             self.runcmd(['chroot', rootdir, 'usermod', '-p', encrypted,
 181                          'root'])
 182         else:
 183             self.message('Locking root password')
 184             self.runcmd(['chroot', rootdir, 'passwd', '-l', 'root'])
 185
 186     def remove_udev_persistent_rules(self, rootdir):
 187         self.message('Removing udev persistent cd and net rules')
 188         for x in ['70-persistent-cd.rules', '70-persistent-net.rules']:
 189             pathname = os.path.join(rootdir, 'etc', 'udev', 'rules.d', x)
 190             if os.path.exists(pathname):
 191                 logging.debug('rm %s' % pathname)
 192                 os.remove(pathname)
 193             else:
 194                 logging.debug('not removing non-existent %s' % pathname)
 195
 196     def setup_networking(self, rootdir):
 197         self.message('Setting up networking')
 198
 199         f = open(os.path.join(rootdir, 'etc', 'network', 'interfaces'), 'w')
 200         f.write('auto lo\n')
 201         f.write('iface lo inet loopback\n')
 202
 203         if self.settings['enable-dhcp']:
 204             f.write('\n')
 205             f.write('allow-hotplug eth0\n')
 206             f.write('iface eth0 inet dhcp\n')
 207
 208         f.close()
 209
 210     def install_extlinux(self, rootdev, rootdir):
 211         self.message('Installing extlinux')
 212
 213         def find(pattern):
 214             dirname = os.path.join(rootdir, 'boot')
 215             basenames = os.listdir(dirname)
 216             logging.debug('find: %s' % basenames)
 217             for basename in basenames:
 218                 if re.search(pattern, basename):
 219                     return os.path.join('boot', basename)
 220             raise cliapp.AppException('Cannot find match: %s' % pattern)
 221
 222         kernel_image = find('vmlinuz-.*')
 223         initrd_image = find('initrd.img-.*')
 224
 225         out = self.runcmd(['blkid', '-c', '/dev/null', '-o', 'value',
 226                            '-s', 'UUID', rootdev])
 227         uuid = out.splitlines()[0].strip()
 228
 229         conf = os.path.join(rootdir, 'extlinux.conf')
 230         logging.debug('configure extlinux %s' % conf)
 231         f = open(conf, 'w')
 232         f.write('''
 233 default linux
 234 timeout 1
 235
 236 label linux
 237 kernel %(kernel)s
 238 append initrd=%(initrd)s root=UUID=%(uuid)s ro quiet
 239 ''' % {
 240     'kernel': kernel_image,
 241     'initrd': initrd_image,
 242     'uuid': uuid,
 243 })
 244         f.close()
 245
 246         self.runcmd(['extlinux', '--install', rootdir])
 247         self.runcmd(['sync'])
 248         import time; time.sleep(2)
 249
 250     def cleanup(self):
 251         # Clean up after any errors.
 252
 253         self.message('Cleaning up')
 254
 255         for mount_point in self.mount_points:
 256             self.runcmd(['umount', mount_point], ignore_fail=True)
 257
 258         self.runcmd(['kpartx', '-d', self.settings['image']], ignore_fail=True)
 259
 260         for dirname in self.remove_dirs:
 261             shutil.rmtree(dirname)
 262
 263     def customize(self, rootdir):
 264         script = self.settings['customize']
 265         if script:
 266             self.message('Running customize script %s' % script)
 267             self.runcmd([script, rootdir])
 268
 269
 270 if __name__ == '__main__':
 271     VmDebootstrap().run()
 272