vmdebootstrap

   1 #!/usr/bin/python
   2 # Copyright 2011-2013  Lars Wirzenius
   3 # Copyright 2012  Codethink Limited
   4 #
   5 # This program is free software: you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation, either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 import cliapp
  19 import crypt
  20 import logging
  21 import os
  22 import re
  23 import shutil
  24 import subprocess
  25 import tempfile
  26 import time
  27
  28
  29 __version__ = '0.3'
  30
  31
  32 class VmDebootstrap(cliapp.Application):
  33
  34     def add_settings(self):
  35         default_arch = 'amd64'
  36
  37         self.settings.boolean(['verbose'], 'report what is going on')
  38         self.settings.string(['image'], 'put created disk image in FILE',
  39                              metavar='FILE')
  40         self.settings.bytesize(['size'],
  41                                'create a disk image of size SIZE (%default)',
  42                                metavar='SIZE',
  43                                default='1G')
  44         self.settings.bytesize(['bootsize'],
  45                                'create boot partition of size SIZE (%default)',
  46                                metavar='BOOTSIZE',
  47                                default='0%')
  48         self.settings.string(['boottype'],
  49                              'specify file system type for /boot/',
  50                              default='ext2')
  51         self.settings.string(['foreign'],
  52                              'set up foreign debootstrap environment using provided program (ie binfmt handler)')
  53         self.settings.string(['variant'],
  54                              'select debootstrap variant it not using the default')
  55         self.settings.boolean(
  56             ['extlinux'],
  57             'install extlinux?',
  58             default=True)
  59         self.settings.string(['tarball'], "tar up the disk's contents in FILE",
  60                              metavar='FILE')
  61         self.settings.string(['mirror'],
  62                              'use MIRROR as package source (%default)',
  63                              metavar='URL',
  64                              default='http://cdn.debian.net/debian/')
  65         self.settings.string(['arch'], 'architecture to use (%default)',
  66                              metavar='ARCH',
  67                              default=default_arch)
  68         self.settings.string(['distribution'],
  69                              'release to use (%default)',
  70                              metavar='NAME',
  71                              default='stable')
  72         self.settings.string_list(['package'], 'install PACKAGE onto system')
  73         self.settings.string_list(['custom-package'],
  74                                   'install package in DEB file onto system '
  75                                     '(not from mirror)',
  76                                   metavar='DEB')
  77         self.settings.boolean(['no-kernel'], 'do not install a linux package')
  78         self.settings.boolean(['enable-dhcp'], 'enable DHCP on eth0')
  79         self.settings.string(['root-password'], 'set root password',
  80                              metavar='PASSWORD')
  81         self.settings.boolean(['lock-root-password'],
  82                               'lock root account so they cannot login?')
  83         self.settings.string(['customize'],
  84                              'run SCRIPT after setting up system',
  85                              metavar='SCRIPT')
  86         self.settings.string(['hostname'],
  87                              'set name to HOSTNAME (%default)',
  88                              metavar='HOSTNAME',
  89                              default='debian')
  90         self.settings.string_list(['user'],
  91                                   'create USER with PASSWORD',
  92                                   metavar='USER/PASSWORD')
  93         self.settings.boolean(['serial-console'],
  94                               'configure image to use a serial console')
  95         self.settings.string(['serial-console-command'],
  96                              'command to manage the serial console, appended '
  97                                'to /etc/inittab (%default)',
  98                              metavar='COMMAND',
  99                              default='/sbin/getty -L ttyS0 115200 vt100')
 100         self.settings.boolean(['sudo'],
 101                               'install sudo, and if user is created, add them '
 102                                 'to sudo group')
 103         self.settings.string(['owner'],
 104                              'the user who will own the image when the build '
 105                                'is complete.')
 106
 107     def process_args(self, args):
 108         if not self.settings['image'] and not self.settings['tarball']:
 109             raise cliapp.AppException('You must give disk image filename, '
 110                                       'or tarball filename')
 111         if self.settings['image'] and not self.settings['size']:
 112             raise cliapp.AppException('If disk image is specified, '
 113                                       'You must give image size.')
 114
 115         self.remove_dirs = []
 116         self.mount_points = []
 117
 118         try:
 119             rootdev = None
 120             roottype = 'ext4'
 121             bootdev = None
 122             boottype = None
 123             if self.settings['image']:
 124                 self.create_empty_image()
 125                 self.partition_image()
 126                 self.install_mbr()
 127                 (rootdev,bootdev) = self.setup_kpartx()
 128                 self.mkfs(rootdev, type=roottype)
 129                 rootdir = self.mount(rootdev)
 130                 if bootdev:
 131                     if self.settings['boottype']:
 132                         boottype = self.settings['boottype']
 133                     else:
 134                         boottype = 'ext2'
 135                     self.mkfs(bootdev, type=boottype)
 136                     bootdir = '%s/%s' % (rootdir, 'boot/')
 137                     os.mkdir(bootdir)
 138                     bootdir = self.mount(bootdev, bootdir)
 139             else:
 140                 rootdir = self.mkdtemp()
 141             self.debootstrap(rootdir)
 142             self.set_hostname(rootdir)
 143             self.create_fstab(rootdir, rootdev, roottype, bootdev, boottype)
 144             self.install_debs(rootdir)
 145             self.cleanup_apt_cache(rootdir)
 146             self.set_root_password(rootdir)
 147             self.create_users(rootdir)
 148             self.remove_udev_persistent_rules(rootdir)
 149             self.setup_networking(rootdir)
 150             self.customize(rootdir)
 151             if self.settings['image']:
 152                 if self.settings['extlinux']:
 153                     self.install_extlinux(rootdev, rootdir)
 154                 self.append_serial_console(rootdir)
 155                 self.optimize_image(rootdir)
 156
 157             if self.settings['foreign']:
 158                 os.unlink('%s/usr/bin/%s' %
 159                           (rootdir, os.path.basename(self.settings['foreign'])))
 160
 161             if self.settings['tarball']:
 162                 self.create_tarball(rootdir)
 163
 164             if self.settings['owner']:
 165                 self.chown(rootdir)
 166         except BaseException, e:
 167             self.message('EEEK! Something bad happened...')
 168             self.message(e)
 169             self.cleanup_system()
 170             raise
 171         else:
 172             self.cleanup_system()
 173
 174     def message(self, msg):
 175         logging.info(msg)
 176         if self.settings['verbose']:
 177             print msg
 178
 179     def runcmd(self, argv, stdin='', ignore_fail=False, **kwargs):
 180         logging.debug('runcmd: %s %s' % (argv, kwargs))
 181         p = subprocess.Popen(argv, stdin=subprocess.PIPE,
 182                              stdout=subprocess.PIPE, stderr=subprocess.PIPE,
 183                              **kwargs)
 184         out, err = p.communicate(stdin)
 185         if p.returncode != 0:
 186             msg = 'command failed: %s\n%s\n%s' % (argv, out, err)
 187             logging.error(msg)
 188             if not ignore_fail:
 189                 raise cliapp.AppException(msg)
 190         return out
 191
 192     def mkdtemp(self):
 193         dirname = tempfile.mkdtemp()
 194         self.remove_dirs.append(dirname)
 195         logging.debug('mkdir %s' % dirname)
 196         return dirname
 197
 198     def mount(self, device, path=None):
 199         if not path:
 200             mount_point = self.mkdtemp()
 201         else:
 202             mount_point = path
 203         self.message('Mounting %s on %s' % (device,mount_point))
 204         self.runcmd(['mount', device, mount_point])
 205         self.mount_points.append(mount_point)
 206         logging.debug('mounted %s on %s' % (device, mount_point))
 207         return mount_point
 208
 209     def create_empty_image(self):
 210         self.message('Creating disk image')
 211         self.runcmd(['qemu-img', 'create', '-f', 'raw',
 212                      self.settings['image'],
 213                      str(self.settings['size'])])
 214
 215     def partition_image(self):
 216         self.message('Creating partitions')
 217         self.runcmd(['parted', '-s', self.settings['image'],
 218                      'mklabel', 'msdos'])
 219         if self.settings['bootsize'] and self.settings['bootsize'] is not '0%':
 220             bootsize=str(self.settings['bootsize']/(1024*1024))
 221             self.runcmd(['parted', '-s', self.settings['image'],
 222                          'mkpart', 'primary', 'fat16', '0', bootsize])
 223         else:
 224             bootsize='0%'
 225         self.runcmd(['parted', '-s', self.settings['image'],
 226                      'mkpart', 'primary', bootsize, '100%'])
 227         self.runcmd(['parted', '-s', self.settings['image'],
 228                      'set', '1', 'boot', 'on'])
 229
 230     def install_mbr(self):
 231         self.message('Installing MBR')
 232         self.runcmd(['install-mbr', self.settings['image']])
 233
 234     def setup_kpartx(self):
 235         out = self.runcmd(['kpartx', '-avs', self.settings['image']])
 236         if self.settings['bootsize']:
 237             bootindex = 0
 238             rootindex = 1
 239             parts = 2
 240         else:
 241             rootindex = 0
 242             parts = 1
 243             boot = None
 244         devices = [line.split()[2]
 245                    for line in out.splitlines()
 246                    if line.startswith('add map ')]
 247         if len(devices) != parts:
 248             raise cliapp.AppException('Surprising number of partitions')
 249         root = '/dev/mapper/%s' % devices[rootindex]
 250         if self.settings['bootsize']:
 251             boot = '/dev/mapper/%s' % devices[bootindex]
 252         return (root,boot)
 253
 254     def mkfs(self, device, type):
 255         self.message('Creating filesystem %s' % type)
 256         self.runcmd(['mkfs', '-t', type, device])
 257
 258     def debootstrap(self, rootdir):
 259         self.message('Debootstrapping')
 260
 261         if self.settings['foreign']:
 262             necessary_packages = []
 263         else:
 264             necessary_packages = ['acpid']
 265
 266         include = self.settings['package']
 267
 268         if not self.settings['no-kernel']:
 269             if self.settings['arch'] == 'i386':
 270                 kernel_arch = '486'
 271             else:
 272                 kernel_arch = self.settings['arch']
 273             kernel_image = 'linux-image-%s' % kernel_arch
 274             include.append(kernel_image)
 275
 276         if self.settings['sudo'] and 'sudo' not in include:
 277             include.append('sudo')
 278
 279         args = ['debootstrap', '--arch=%s' % self.settings['arch']]
 280         args.append(
 281             '--include=%s' % ','.join(necessary_packages + include))
 282         if self.settings['foreign']:
 283             args.append('--foreign')
 284         if self.settings['variant']:
 285             args.append('--variant')
 286             args.append(self.settings['variant'])
 287         args += [self.settings['distribution'],
 288                  rootdir, self.settings['mirror']]
 289         self.runcmd(args)
 290         if self.settings['foreign']:
 291             # First copy the binfmt handler over
 292             shutil.copy(self.settings['foreign'], '%s/usr/bin/' % rootdir)
 293             # Next, run the package install scripts etc.
 294             self.runcmd(['chroot', rootdir,
 295                          '/debootstrap/debootstrap', '--second-stage'])
 296
 297     def set_hostname(self, rootdir):
 298         hostname = self.settings['hostname']
 299         with open(os.path.join(rootdir, 'etc', 'hostname'), 'w') as f:
 300             f.write('%s\n' % hostname)
 301
 302         etc_hosts = os.path.join(rootdir, 'etc', 'hosts')
 303         try:
 304             with open(etc_hosts, 'r') as f:
 305                 data = f.read()
 306             with open(etc_hosts, 'w') as f:
 307                 for line in data.splitlines():
 308                     if line.startswith('127.0.0.1'):
 309                         line += ' %s' % hostname
 310                     f.write('%s\n' % line)
 311         except IOError, e:
 312             pass
 313
 314     def create_fstab(self, rootdir, rootdev, roottype, bootdev, boottype):
 315         def fsuuid(device):
 316             out = self.runcmd(['blkid', '-c', '/dev/null', '-o', 'value',
 317                                '-s', 'UUID', device])
 318             return out.splitlines()[0].strip()
 319
 320         if rootdev:
 321             rootdevstr = 'UUID=%s' % fsuuid(rootdev)
 322         else:
 323             rootdevstr = '/dev/sda1'
 324
 325         if bootdev:
 326             bootdevstr = 'UUID=%s' % fsuuid(bootdev)
 327         else:
 328             bootdevstr = None
 329
 330         fstab = os.path.join(rootdir, 'etc', 'fstab')
 331         with open(fstab, 'w') as f:
 332             f.write('proc /proc proc defaults 0 0\n')
 333             f.write('%s / %s errors=remount-ro 0 1\n' % (rootdevstr, roottype))
 334             if bootdevstr:
 335                 f.write('%s /boot %s errors=remount-ro 0 2\n' % (bootdevstr, boottype))
 336
 337     def install_debs(self, rootdir):
 338         if not self.settings['custom-package']:
 339             return
 340         self.message('Installing custom packages')
 341         tmp = os.path.join(rootdir, 'tmp', 'install_debs')
 342         os.mkdir(tmp)
 343         for deb in self.settings['custom-package']:
 344             shutil.copy(deb, tmp)
 345         filenames = [os.path.join('/tmp/install_debs', os.path.basename(deb))
 346                      for deb in self.settings['custom-package']]
 347         out, err, exit = \
 348             self.runcmd_unchecked(['chroot', rootdir, 'dpkg', '-i'] + filenames)
 349         logging.debug('stdout:\n%s' % out)
 350         logging.debug('stderr:\n%s' % err)
 351         out = self.runcmd(['chroot', rootdir,
 352                      'apt-get', '-f', '--no-remove', 'install'])
 353         logging.debug('stdout:\n%s' % out)
 354         shutil.rmtree(tmp)
 355
 356     def cleanup_apt_cache(self, rootdir):
 357         out = self.runcmd(['chroot', rootdir, 'apt-get', 'clean'])
 358         logging.debug('stdout:\n%s' % out)
 359
 360     def set_root_password(self, rootdir):
 361         if self.settings['root-password']:
 362             self.message('Setting root password')
 363             self.set_password(rootdir, 'root', self.settings['root-password'])
 364         elif self.settings['lock-root-password']:
 365             self.message('Locking root password')
 366             self.runcmd(['chroot', rootdir, 'passwd', '-l', 'root'])
 367         else:
 368             self.message('Give root an empty password')
 369             self.delete_password(rootdir, 'root')
 370
 371     def create_users(self, rootdir):
 372         def create_user(user):
 373             self.runcmd(['chroot', rootdir, 'adduser', '--gecos', user,
 374                          '--disabled-password', user])
 375             if self.settings['sudo']:
 376                 self.runcmd(['chroot', rootdir, 'adduser', user, 'sudo'])
 377
 378         for userpass in self.settings['user']:
 379             if '/' in userpass:
 380                 user, password = userpass.split('/', 1)
 381                 create_user(user)
 382                 self.set_password(rootdir, user, password)
 383             else:
 384                 create_user(userpass)
 385                 self.delete_password(rootdir, userpass)
 386
 387     def set_password(self, rootdir, user, password):
 388         encrypted = crypt.crypt(password, '..')
 389         self.runcmd(['chroot', rootdir, 'usermod', '-p', encrypted, user])
 390
 391     def delete_password(self, rootdir, user):
 392         self.runcmd(['chroot', rootdir, 'passwd', '-d', user])
 393
 394     def remove_udev_persistent_rules(self, rootdir):
 395         self.message('Removing udev persistent cd and net rules')
 396         for x in ['70-persistent-cd.rules', '70-persistent-net.rules']:
 397             pathname = os.path.join(rootdir, 'etc', 'udev', 'rules.d', x)
 398             if os.path.exists(pathname):
 399                 logging.debug('rm %s' % pathname)
 400                 os.remove(pathname)
 401             else:
 402                 logging.debug('not removing non-existent %s' % pathname)
 403
 404     def setup_networking(self, rootdir):
 405         self.message('Setting up networking')
 406
 407         f = open(os.path.join(rootdir, 'etc', 'network', 'interfaces'), 'w')
 408         f.write('auto lo\n')
 409         f.write('iface lo inet loopback\n')
 410
 411         if self.settings['enable-dhcp']:
 412             f.write('\n')
 413             f.write('auto eth0\n')
 414             f.write('iface eth0 inet dhcp\n')
 415
 416         f.close()
 417
 418     def append_serial_console(self, rootdir):
 419         if self.settings['serial-console']:
 420             serial_command = self.settings['serial-console-command']
 421             logging.debug('adding getty to serial console')
 422             inittab = os.path.join(rootdir, 'etc/inittab')
 423             with open(inittab, 'a') as f:
 424                 f.write('\nS0:23:respawn:%s\n' % serial_command)
 425
 426     def install_extlinux(self, rootdev, rootdir):
 427         self.message('Installing extlinux')
 428
 429         def find(pattern):
 430             dirname = os.path.join(rootdir, 'boot')
 431             basenames = os.listdir(dirname)
 432             logging.debug('find: %s' % basenames)
 433             for basename in basenames:
 434                 if re.search(pattern, basename):
 435                     return os.path.join('boot', basename)
 436             raise cliapp.AppException('Cannot find match: %s' % pattern)
 437
 438         kernel_image = find('vmlinuz-.*')
 439         initrd_image = find('initrd.img-.*')
 440
 441         out = self.runcmd(['blkid', '-c', '/dev/null', '-o', 'value',
 442                            '-s', 'UUID', rootdev])
 443         uuid = out.splitlines()[0].strip()
 444
 445         conf = os.path.join(rootdir, 'extlinux.conf')
 446         logging.debug('configure extlinux %s' % conf)
 447         f = open(conf, 'w')
 448         f.write('''
 449 default linux
 450 timeout 1
 451
 452 label linux
 453 kernel %(kernel)s
 454 append initrd=%(initrd)s root=UUID=%(uuid)s ro %(kserial)s
 455 %(extserial)s
 456 ''' % {
 457     'kernel': kernel_image,
 458     'initrd': initrd_image,
 459     'uuid': uuid,
 460     'kserial':
 461         'console=ttyS0,115200' if self.settings['serial-console'] else '',
 462     'extserial': 'serial 0 115200' if self.settings['serial-console'] else '',
 463 })
 464         f.close()
 465
 466         self.runcmd(['extlinux', '--install', rootdir])
 467         self.runcmd(['sync'])
 468         import time; time.sleep(2)
 469
 470     def optimize_image(self, rootdir):
 471         """
 472         Filing up the image with zeros will increase its compression rate
 473         """
 474         zeros = os.path.join(rootdir, 'ZEROS')
 475         self.runcmd_unchecked(['dd', 'if=/dev/zero', 'of=' + zeros, 'bs=1M'])
 476         self.runcmd(['rm', '-f', zeros])
 477
 478
 479     def cleanup_system(self):
 480         # Clean up after any errors.
 481
 482         self.message('Cleaning up')
 483
 484         # Umount in the reverse mount order
 485         if self.settings['image']:
 486             for i in xrange(len(self.mount_points) - 1, -1, -1):
 487                 mount_point = self.mount_points[i]
 488                 try:
 489                     self.runcmd(['umount', mount_point], ignore_fail=False)
 490                 except cliapp.AppException:
 491                     logging.debug("umount failed, sleeping and trying again")
 492                     time.sleep(5)
 493                     self.runcmd(['umount', mount_point], ignore_fail=False)
 494
 495             self.runcmd(['kpartx', '-d', self.settings['image']], ignore_fail=True)
 496
 497         for dirname in self.remove_dirs:
 498             shutil.rmtree(dirname)
 499
 500     def customize(self, rootdir):
 501         script = self.settings['customize']
 502         if script:
 503             self.message('Running customize script %s' % script)
 504             with open('/dev/tty', 'w') as tty:
 505                 cliapp.runcmd([script, rootdir], stdout=tty, stderr=tty)
 506
 507     def create_tarball(self, rootdir):
 508         # Create a tarball of the disk's contents
 509         # shell out to runcmd since it more easily handles rootdir
 510         self.message('Creating tarball of disk contents')
 511         self.runcmd(['tar', '-cf', self.settings['tarball'], '-C', rootdir, '.'])
 512
 513     def chown(self, rootdir):
 514         # Change image owner after completed build
 515         self.message("Changing owner to %s" % self.settings["owner"])
 516         subprocess.call(["chown",
 517                          self.settings["owner"],
 518                          self.settings["image"]])
 519
 520
 521 if __name__ == '__main__':
 522     VmDebootstrap(version=__version__).run()
 523