]> git.siccegge.de Git - forks/vmdebootstrap.git/blob - vmdebootstrap
Use simple subprocess call for default_arch to prevent early use of run_cmd causing...
[forks/vmdebootstrap.git] / 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 = subprocess.check_output(
36 ["dpkg", "--print-architecture"]).strip()
37
38 self.settings.boolean(['verbose'], 'report what is going on')
39 self.settings.string(['image'], 'put created disk image in FILE',
40 metavar='FILE')
41 self.settings.bytesize(['size'],
42 'create a disk image of size SIZE (%default)',
43 metavar='SIZE',
44 default='1G')
45 self.settings.bytesize(['bootsize'],
46 'create boot partition of size SIZE (%default)',
47 metavar='BOOTSIZE',
48 default='0%')
49 self.settings.string(['boottype'],
50 'specify file system type for /boot/',
51 default='ext2')
52 self.settings.string(['foreign'],
53 'set up foreign debootstrap environment using provided program (ie binfmt handler)')
54 self.settings.string(['variant'],
55 'select debootstrap variant it not using the default')
56 self.settings.boolean(
57 ['extlinux'],
58 'install extlinux?',
59 default=True)
60 self.settings.string(['tarball'], "tar up the disk's contents in FILE",
61 metavar='FILE')
62 self.settings.string(['mirror'],
63 'use MIRROR as package source (%default)',
64 metavar='URL',
65 default='http://cdn.debian.net/debian/')
66 self.settings.string(['arch'], 'architecture to use (%default)',
67 metavar='ARCH',
68 default=default_arch)
69 self.settings.string(['distribution'],
70 'release to use (%default)',
71 metavar='NAME',
72 default='stable')
73 self.settings.string_list(['package'], 'install PACKAGE onto system')
74 self.settings.string_list(['custom-package'],
75 'install package in DEB file onto system '
76 '(not from mirror)',
77 metavar='DEB')
78 self.settings.boolean(['no-kernel'], 'do not install a linux package')
79 self.settings.boolean(['enable-dhcp'], 'enable DHCP on eth0')
80 self.settings.string(['root-password'], 'set root password',
81 metavar='PASSWORD')
82 self.settings.boolean(['lock-root-password'],
83 'lock root account so they cannot login?')
84 self.settings.string(['customize'],
85 'run SCRIPT after setting up system',
86 metavar='SCRIPT')
87 self.settings.string(['hostname'],
88 'set name to HOSTNAME (%default)',
89 metavar='HOSTNAME',
90 default='debian')
91 self.settings.string_list(['user'],
92 'create USER with PASSWORD',
93 metavar='USER/PASSWORD')
94 self.settings.boolean(['serial-console'],
95 'configure image to use a serial console')
96 self.settings.string(['serial-console-command'],
97 'command to manage the serial console, appended '
98 'to /etc/inittab (%default)',
99 metavar='COMMAND',
100 default='/sbin/getty -L ttyS0 115200 vt100')
101 self.settings.boolean(['sudo'],
102 'install sudo, and if user is created, add them '
103 'to sudo group')
104 self.settings.string(['owner'],
105 'the user who will own the image when the build '
106 'is complete.')
107 self.settings.boolean(['squash'],
108 'use squashfs on the final image.')
109 self.settings.boolean(['configure-apt'],
110 'Create an apt source based on the distribution '
111 'and mirror selected.')
112 self.settings.boolean(['mbr'],
113 'Run install-mbr (no longer done by default)')
114 self.settings.boolean(['grub'],
115 'Install and configure grub2 - disables '
116 'extlinux.')
117
118 def process_args(self, args):
119 if not self.settings['image'] and not self.settings['tarball']:
120 raise cliapp.AppException('You must give disk image filename, '
121 'or tarball filename')
122 if self.settings['image'] and not self.settings['size']:
123 raise cliapp.AppException('If disk image is specified, '
124 'You must give image size.')
125
126 self.remove_dirs = []
127 self.mount_points = []
128
129 try:
130 rootdev = None
131 roottype = 'ext4'
132 bootdev = None
133 boottype = None
134 rootdir = None
135 if self.settings['image']:
136 self.create_empty_image()
137 self.partition_image()
138 if self.settings['mbr']:
139 self.install_mbr()
140 (rootdev, bootdev) = self.setup_kpartx()
141 self.mkfs(rootdev, type=roottype)
142 rootdir = self.mount(rootdev)
143 if bootdev:
144 if self.settings['boottype']:
145 boottype = self.settings['boottype']
146 else:
147 boottype = 'ext2'
148 self.mkfs(bootdev, type=boottype)
149 bootdir = '%s/%s' % (rootdir, 'boot/')
150 os.mkdir(bootdir)
151 bootdir = self.mount(bootdev, bootdir)
152 else:
153 rootdir = self.mkdtemp()
154 self.debootstrap(rootdir)
155 self.set_hostname(rootdir)
156 self.create_fstab(rootdir, rootdev, roottype, bootdev, boottype)
157 self.install_debs(rootdir)
158 self.cleanup_apt_cache(rootdir)
159 self.set_root_password(rootdir)
160 self.create_users(rootdir)
161 self.remove_udev_persistent_rules(rootdir)
162 self.setup_networking(rootdir)
163 if self.settings['configure-apt']:
164 self.configure_apt(rootdir)
165 self.customize(rootdir)
166 if self.settings['image']:
167 if self.settings['grub']:
168 self.install_grub2(rootdev, rootdir)
169 elif self.settings['extlinux']:
170 self.install_extlinux(rootdev, rootdir)
171 self.append_serial_console(rootdir)
172 self.optimize_image(rootdir)
173 if self.settings['squash']:
174 self.squash()
175
176 if self.settings['foreign']:
177 os.unlink('%s/usr/bin/%s' %
178 (rootdir, os.path.basename(self.settings['foreign'])))
179
180 if self.settings['tarball']:
181 self.create_tarball(rootdir)
182
183 if self.settings['owner']:
184 self.chown(rootdir)
185 except BaseException, e:
186 self.message('EEEK! Something bad happened...')
187 if rootdir:
188 db_log = os.path.join(rootdir, 'debootstrap', 'debootstrap.log')
189 if os.path.exists(db_log):
190 shutil.copy(db_log, os.getcwd())
191 self.message(e)
192 self.cleanup_system()
193 raise
194 else:
195 self.cleanup_system()
196
197 def message(self, msg):
198 logging.info(msg)
199 if self.settings['verbose']:
200 print msg
201
202 def runcmd(self, argv, stdin='', ignore_fail=False, **kwargs):
203 logging.debug('runcmd: %s %s' % (argv, kwargs))
204 p = subprocess.Popen(argv, stdin=subprocess.PIPE,
205 stdout=subprocess.PIPE, stderr=subprocess.PIPE,
206 **kwargs)
207 out, err = p.communicate(stdin)
208 if p.returncode != 0:
209 msg = 'command failed: %s\n%s\n%s' % (argv, out, err)
210 logging.error(msg)
211 if not ignore_fail:
212 raise cliapp.AppException(msg)
213 return out
214
215 def mkdtemp(self):
216 dirname = tempfile.mkdtemp()
217 self.remove_dirs.append(dirname)
218 logging.debug('mkdir %s' % dirname)
219 return dirname
220
221 def mount(self, device, path=None):
222 if not path:
223 mount_point = self.mkdtemp()
224 else:
225 mount_point = path
226 self.message('Mounting %s on %s' % (device, mount_point))
227 self.runcmd(['mount', device, mount_point])
228 self.mount_points.append(mount_point)
229 logging.debug('mounted %s on %s' % (device, mount_point))
230 return mount_point
231
232 def create_empty_image(self):
233 self.message('Creating disk image')
234 self.runcmd(['qemu-img', 'create', '-f', 'raw',
235 self.settings['image'],
236 str(self.settings['size'])])
237
238 def partition_image(self):
239 self.message('Creating partitions')
240 self.runcmd(['parted', '-s', self.settings['image'],
241 'mklabel', 'msdos'])
242 if self.settings['bootsize'] and self.settings['bootsize'] is not '0%':
243 bootsize = str(self.settings['bootsize'] / (1024 * 1024))
244 self.runcmd(['parted', '-s', self.settings['image'],
245 'mkpart', 'primary', 'fat16', '0', bootsize])
246 else:
247 bootsize = '0%'
248 self.runcmd(['parted', '-s', self.settings['image'],
249 'mkpart', 'primary', bootsize, '100%'])
250 self.runcmd(['parted', '-s', self.settings['image'],
251 'set', '1', 'boot', 'on'])
252
253 def install_mbr(self):
254 if os.path.exists("/sbin/install-mbr"):
255 self.message('Installing MBR')
256 self.runcmd(['install-mbr', self.settings['image']])
257
258 def setup_kpartx(self):
259 out = self.runcmd(['kpartx', '-avs', self.settings['image']])
260 if self.settings['bootsize']:
261 bootindex = 0
262 rootindex = 1
263 parts = 2
264 else:
265 rootindex = 0
266 parts = 1
267 boot = None
268 devices = [line.split()[2]
269 for line in out.splitlines()
270 if line.startswith('add map ')]
271 if len(devices) != parts:
272 raise cliapp.AppException('Surprising number of partitions')
273 root = '/dev/mapper/%s' % devices[rootindex]
274 if self.settings['bootsize']:
275 boot = '/dev/mapper/%s' % devices[bootindex]
276 return (root, boot)
277
278 def mkfs(self, device, type):
279 self.message('Creating filesystem %s' % type)
280 self.runcmd(['mkfs', '-t', type, device])
281
282 def debootstrap(self, rootdir):
283 self.message('Debootstrapping')
284
285 if self.settings['foreign']:
286 necessary_packages = []
287 else:
288 necessary_packages = ['acpid']
289
290 if self.settings['grub']:
291 necessary_packages.append('grub2')
292
293 include = self.settings['package']
294
295 if not self.settings['no-kernel']:
296 if self.settings['arch'] == 'i386':
297 kernel_arch = '486'
298 else:
299 kernel_arch = self.settings['arch']
300 kernel_image = 'linux-image-%s' % kernel_arch
301 include.append(kernel_image)
302
303 if self.settings['sudo'] and 'sudo' not in include:
304 include.append('sudo')
305
306 args = ['debootstrap', '--arch=%s' % self.settings['arch']]
307 args.append(
308 '--include=%s' % ','.join(necessary_packages + include))
309 if self.settings['foreign']:
310 args.append('--foreign')
311 if self.settings['variant']:
312 args.append('--variant')
313 args.append(self.settings['variant'])
314 args += [self.settings['distribution'],
315 rootdir, self.settings['mirror']]
316 logging.debug(" ".join(args))
317 self.runcmd(args)
318 if self.settings['foreign']:
319 # First copy the binfmt handler over
320 self.message('Setting up binfmt handler')
321 shutil.copy(self.settings['foreign'], '%s/usr/bin/' % rootdir)
322 # Next, run the package install scripts etc.
323 self.message('Running debootstrap second stage')
324 self.runcmd(['chroot', rootdir,
325 '/debootstrap/debootstrap', '--second-stage'])
326
327 def set_hostname(self, rootdir):
328 hostname = self.settings['hostname']
329 with open(os.path.join(rootdir, 'etc', 'hostname'), 'w') as f:
330 f.write('%s\n' % hostname)
331
332 etc_hosts = os.path.join(rootdir, 'etc', 'hosts')
333 try:
334 with open(etc_hosts, 'r') as f:
335 data = f.read()
336 with open(etc_hosts, 'w') as f:
337 for line in data.splitlines():
338 if line.startswith('127.0.0.1'):
339 line += ' %s' % hostname
340 f.write('%s\n' % line)
341 except IOError, e:
342 pass
343
344 def create_fstab(self, rootdir, rootdev, roottype, bootdev, boottype):
345 def fsuuid(device):
346 out = self.runcmd(['blkid', '-c', '/dev/null', '-o', 'value',
347 '-s', 'UUID', device])
348 return out.splitlines()[0].strip()
349
350 if rootdev:
351 rootdevstr = 'UUID=%s' % fsuuid(rootdev)
352 else:
353 rootdevstr = '/dev/sda1'
354
355 if bootdev:
356 bootdevstr = 'UUID=%s' % fsuuid(bootdev)
357 else:
358 bootdevstr = None
359
360 fstab = os.path.join(rootdir, 'etc', 'fstab')
361 with open(fstab, 'w') as f:
362 f.write('proc /proc proc defaults 0 0\n')
363 f.write('%s / %s errors=remount-ro 0 1\n' % (rootdevstr, roottype))
364 if bootdevstr:
365 f.write('%s /boot %s errors=remount-ro 0 2\n' % (bootdevstr, boottype))
366
367 def install_debs(self, rootdir):
368 if not self.settings['custom-package']:
369 return
370 self.message('Installing custom packages')
371 tmp = os.path.join(rootdir, 'tmp', 'install_debs')
372 os.mkdir(tmp)
373 for deb in self.settings['custom-package']:
374 shutil.copy(deb, tmp)
375 filenames = [os.path.join('/tmp/install_debs', os.path.basename(deb))
376 for deb in self.settings['custom-package']]
377 out, err, exit = \
378 self.runcmd_unchecked(['chroot', rootdir, 'dpkg', '-i'] + filenames)
379 logging.debug('stdout:\n%s' % out)
380 logging.debug('stderr:\n%s' % err)
381 out = self.runcmd(['chroot', rootdir,
382 'apt-get', '-f', '--no-remove', 'install'])
383 logging.debug('stdout:\n%s' % out)
384 shutil.rmtree(tmp)
385
386 def cleanup_apt_cache(self, rootdir):
387 out = self.runcmd(['chroot', rootdir, 'apt-get', 'clean'])
388 logging.debug('stdout:\n%s' % out)
389
390 def set_root_password(self, rootdir):
391 if self.settings['root-password']:
392 self.message('Setting root password')
393 self.set_password(rootdir, 'root', self.settings['root-password'])
394 elif self.settings['lock-root-password']:
395 self.message('Locking root password')
396 self.runcmd(['chroot', rootdir, 'passwd', '-l', 'root'])
397 else:
398 self.message('Give root an empty password')
399 self.delete_password(rootdir, 'root')
400
401 def create_users(self, rootdir):
402 def create_user(user):
403 self.runcmd(['chroot', rootdir, 'adduser', '--gecos', user,
404 '--disabled-password', user])
405 if self.settings['sudo']:
406 self.runcmd(['chroot', rootdir, 'adduser', user, 'sudo'])
407
408 for userpass in self.settings['user']:
409 if '/' in userpass:
410 user, password = userpass.split('/', 1)
411 create_user(user)
412 self.set_password(rootdir, user, password)
413 else:
414 create_user(userpass)
415 self.delete_password(rootdir, userpass)
416
417 def set_password(self, rootdir, user, password):
418 encrypted = crypt.crypt(password, '..')
419 self.runcmd(['chroot', rootdir, 'usermod', '-p', encrypted, user])
420
421 def delete_password(self, rootdir, user):
422 self.runcmd(['chroot', rootdir, 'passwd', '-d', user])
423
424 def remove_udev_persistent_rules(self, rootdir):
425 self.message('Removing udev persistent cd and net rules')
426 for x in ['70-persistent-cd.rules', '70-persistent-net.rules']:
427 pathname = os.path.join(rootdir, 'etc', 'udev', 'rules.d', x)
428 if os.path.exists(pathname):
429 logging.debug('rm %s' % pathname)
430 os.remove(pathname)
431 else:
432 logging.debug('not removing non-existent %s' % pathname)
433
434 def setup_networking(self, rootdir):
435 self.message('Setting up networking')
436
437 f = open(os.path.join(rootdir, 'etc', 'network', 'interfaces'), 'w')
438 f.write('auto lo\n')
439 f.write('iface lo inet loopback\n')
440
441 if self.settings['enable-dhcp']:
442 f.write('\n')
443 f.write('auto eth0\n')
444 f.write('iface eth0 inet dhcp\n')
445
446 f.close()
447
448 def append_serial_console(self, rootdir):
449 if self.settings['serial-console']:
450 serial_command = self.settings['serial-console-command']
451 logging.debug('adding getty to serial console')
452 inittab = os.path.join(rootdir, 'etc/inittab')
453 with open(inittab, 'a') as f:
454 f.write('\nS0:23:respawn:%s\n' % serial_command)
455
456 def install_grub2(self, rootdev, rootdir):
457 self.message("Configuring grub2")
458 # rely on kpartx using consistent naming to map loop0p1 to loop0
459 install_dev = os.path.join('/dev', os.path.basename(rootdev)[:-2])
460 self.runcmd(['mount', '/dev', '-t', 'devfs', '-obind',
461 '%s' % os.path.join(rootdir, 'dev')])
462 self.runcmd(['mount', '/proc', '-t', 'proc', '-obind',
463 '%s' % os.path.join(rootdir, 'proc')])
464 self.runcmd(['mount', '/sys', '-t', 'sysfs', '-obind',
465 '%s' % os.path.join(rootdir, 'sys')])
466 try:
467 self.runcmd(['chroot', rootdir, 'update-grub'])
468 self.runcmd(['chroot', rootdir, 'grub-install', install_dev])
469 except cliapp.AppException as e:
470 self.message("Failed to configure grub2. Using extlinux.")
471 self.runcmd(['umount', os.path.join(rootdir, 'sys')])
472 self.runcmd(['umount', os.path.join(rootdir, 'proc')])
473 self.runcmd(['umount', os.path.join(rootdir, 'dev')])
474 self.install_extlinux(rootdev, rootdir)
475
476 def install_extlinux(self, rootdev, rootdir):
477 if not os.path.exists("/usr/bin/extlinux"):
478 self.message("extlinux not installed, skipping.")
479 return
480 self.message('Installing extlinux')
481
482 def find(pattern):
483 dirname = os.path.join(rootdir, 'boot')
484 basenames = os.listdir(dirname)
485 logging.debug('find: %s' % basenames)
486 for basename in basenames:
487 if re.search(pattern, basename):
488 return os.path.join('boot', basename)
489 raise cliapp.AppException('Cannot find match: %s' % pattern)
490
491 kernel_image = find('vmlinuz-.*')
492 initrd_image = find('initrd.img-.*')
493
494 out = self.runcmd(['blkid', '-c', '/dev/null', '-o', 'value',
495 '-s', 'UUID', rootdev])
496 uuid = out.splitlines()[0].strip()
497
498 conf = os.path.join(rootdir, 'extlinux.conf')
499 logging.debug('configure extlinux %s' % conf)
500 f = open(conf, 'w')
501 f.write('''
502 default linux
503 timeout 1
504
505 label linux
506 kernel %(kernel)s
507 append initrd=%(initrd)s root=UUID=%(uuid)s ro %(kserial)s
508 %(extserial)s
509 ''' % {
510 'kernel': kernel_image,
511 'initrd': initrd_image,
512 'uuid': uuid,
513 'kserial':
514 'console=ttyS0,115200' if self.settings['serial-console'] else '',
515 'extserial': 'serial 0 115200' if self.settings['serial-console'] else '',
516 })
517 f.close()
518
519 self.runcmd(['extlinux', '--install', rootdir])
520 self.runcmd(['sync'])
521 time.sleep(2)
522
523 def optimize_image(self, rootdir):
524 """
525 Filing up the image with zeros will increase its compression rate
526 """
527 zeros = os.path.join(rootdir, 'ZEROS')
528 self.runcmd_unchecked(['dd', 'if=/dev/zero', 'of=' + zeros, 'bs=1M'])
529 self.runcmd(['rm', '-f', zeros])
530
531 def squash(self):
532 """
533 Run squashfs on the image.
534 """
535 if not os.path.exists('/usr/bin/mksquashfs'):
536 logging.warning("Squash selected but mksquashfs not found!")
537 return
538 self.message("Running mksquashfs")
539 suffixed = "%s.squashfs" % self.settings['image']
540 self.runcmd(['mksquashfs', self.settings['image'],
541 suffixed,
542 '-no-progress', '-comp', 'xz'], ignore_fail=False)
543 os.unlink(self.settings['image'])
544 self.settings['image'] = suffixed
545
546 def cleanup_system(self):
547 # Clean up after any errors.
548
549 self.message('Cleaning up')
550
551 # Umount in the reverse mount order
552 if self.settings['image']:
553 for i in xrange(len(self.mount_points) - 1, -1, -1):
554 mount_point = self.mount_points[i]
555 try:
556 self.runcmd(['umount', mount_point], ignore_fail=False)
557 except cliapp.AppException:
558 logging.debug("umount failed, sleeping and trying again")
559 time.sleep(5)
560 self.runcmd(['umount', mount_point], ignore_fail=False)
561
562 self.runcmd(['kpartx', '-d', self.settings['image']], ignore_fail=True)
563
564 for dirname in self.remove_dirs:
565 shutil.rmtree(dirname)
566
567 def customize(self, rootdir):
568 script = self.settings['customize']
569 if not script:
570 return
571 if not os.path.exists(script):
572 example = os.path.join("/usr/share/vmdebootstrap/examples/", script)
573 if not os.path.exists(example):
574 self.message("Unable to find %s" % script)
575 return
576 script = example
577 self.message('Running customize script %s' % script)
578 with open('/dev/tty', 'w') as tty:
579 cliapp.runcmd([script, rootdir], stdout=tty, stderr=tty)
580
581 def create_tarball(self, rootdir):
582 # Create a tarball of the disk's contents
583 # shell out to runcmd since it more easily handles rootdir
584 self.message('Creating tarball of disk contents')
585 self.runcmd(['tar', '-cf', self.settings['tarball'], '-C', rootdir, '.'])
586
587 def chown(self, rootdir):
588 # Change image owner after completed build
589 self.message("Changing owner to %s" % self.settings["owner"])
590 subprocess.call(["chown",
591 self.settings["owner"],
592 self.settings["image"]])
593
594 def configure_apt(self, rootdir):
595 # use the distribution and mirror to create an apt source
596 self.message("Configuring apt to use distribution and mirror")
597 conf = os.path.join(rootdir, 'etc', 'apt', 'sources.list.d', 'base.list')
598 logging.debug('configure apt %s' % conf)
599 f = open(conf, 'w')
600 f.write('''
601 deb %(mirror)s %(distribution)s main
602 #deb-src %(mirror)s %(distribution)s main
603 ''' % {
604 'mirror': self.settings['mirror'],
605 'distribution': self.settings['distribution']
606 })
607 f.close()
608
609 if __name__ == '__main__':
610 VmDebootstrap(version=__version__).run()