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