X-Git-Url: https://code.grnet.gr/git/snf-image-creator/blobdiff_plain/ae48a082b638284012de78a30c8374ba689eb0b7..aa486e935452c7120582057caf9db0c77b88d68a:/image_creator/main.py diff --git a/image_creator/main.py b/image_creator/main.py old mode 100755 new mode 100644 index a225579..567e4c3 --- a/image_creator/main.py +++ b/image_creator/main.py @@ -1,6 +1,6 @@ #!/usr/bin/env python -# Copyright 2011 GRNET S.A. All rights reserved. +# Copyright 2012 GRNET S.A. All rights reserved. # # Redistribution and use in source and binary forms, with or # without modification, are permitted provided that the following @@ -33,27 +33,29 @@ # interpreted as representing official policies, either expressed # or implied, of GRNET S.A. -from image_creator import get_os_class from image_creator import __version__ as version -from image_creator import FatalError +from image_creator import util from image_creator.disk import Disk -from image_creator.util import get_command - +from image_creator.util import FatalError, MD5 +from image_creator.output.cli import SilentOutput, SimpleOutput, \ + OutputWthProgress +from image_creator.os_type import os_cls +from image_creator.kamaki_wrapper import Kamaki, ClientError import sys import os import optparse - -dd = get_command('dd') +import StringIO +import signal def check_writable_dir(option, opt_str, value, parser): dirname = os.path.dirname(value) name = os.path.basename(value) if dirname and not os.path.isdir(dirname): - parser.error("`%s' is not an existing directory" % dirname) + raise FatalError("`%s' is not an existing directory" % dirname) if not name: - parser.error("`%s' is not a valid file name" % dirname) + raise FatalError("`%s' is not a valid file name" % dirname) setattr(parser.values, option.dest, value) @@ -62,126 +64,265 @@ def parse_options(input_args): usage = "Usage: %prog [options] " parser = optparse.OptionParser(version=version, usage=usage) + token = os.environ["OKEANOS_TOKEN"] if "OKEANOS_TOKEN" in os.environ \ + else None + + parser.add_option("-o", "--outfile", type="string", dest="outfile", + default=None, action="callback", + callback=check_writable_dir, help="dump image to FILE", + metavar="FILE") + parser.add_option("-f", "--force", dest="force", default=False, - action="store_true", help="Overwrite output files if they exist") + action="store_true", + help="overwrite output files if they exist") + + parser.add_option("-s", "--silent", dest="silent", default=False, + help="output only errors", + action="store_true") + + parser.add_option("-u", "--upload", dest="upload", type="string", + default=False, + help="upload the image to pithos with name FILENAME", + metavar="FILENAME") + + parser.add_option("-r", "--register", dest="register", type="string", + default=False, + help="register the image with ~okeanos as IMAGENAME", + metavar="IMAGENAME") + + parser.add_option("-m", "--metadata", dest="metadata", default=[], + help="add custom KEY=VALUE metadata to the image", + action="append", metavar="KEY=VALUE") + + parser.add_option("-t", "--token", dest="token", type="string", + default=token, help="use this authentication token when " + "uploading/registering images [Default: %s]" % token) - parser.add_option("--no-cleanup", dest="cleanup", default=True, - help="Don't cleanup sensitive data before extracting the image", - action="store_false") + parser.add_option("--print-sysprep", dest="print_sysprep", default=False, + help="print the enabled and disabled system preparation " + "operations for this input media", action="store_true") + + parser.add_option("--enable-sysprep", dest="enabled_syspreps", default=[], + help="run SYSPREP operation on the input media", + action="append", metavar="SYSPREP") + + parser.add_option("--disable-sysprep", dest="disabled_syspreps", + help="prevent SYSPREP operation from running on the " + "input media", default=[], action="append", + metavar="SYSPREP") parser.add_option("--no-sysprep", dest="sysprep", default=True, - help="Don't perform system preperation before extracting the image", - action="store_false") + help="don't perform any system preparation operation", + action="store_false") parser.add_option("--no-shrink", dest="shrink", default=True, - help="Don't shrink any partition before extracting the image", - action="store_false") + help="don't shrink any partition", action="store_false") - parser.add_option("-o", "--outfile", type="string", dest="outfile", - default=None, action="callback", callback=check_writable_dir, - help="Output image file", - metavar="FILE") + parser.add_option("--public", dest="public", default=False, + help="register image with cyclades as public", + action="store_true") - parser.add_option("-u", "--upload", dest="upload", default=False, - help="Upload image to a pithos repository using kamaki", - action="store_true") - - parser.add_option("-r", "--register", dest="register", default=False, - help="Register image to okeanos using kamaki", action="store_true") + parser.add_option("--tmpdir", dest="tmp", type="string", default=None, + help="create large temporary image files under DIR", + metavar="DIR") options, args = parser.parse_args(input_args) if len(args) != 1: parser.error('Wrong number of arguments') + options.source = args[0] if not os.path.exists(options.source): - parser.error('input media is not accessible') - - if options.register: - options.upload = True - - if options.outfile is None and not options.upload: - parser.error('either outfile (-o) or upload (-u) must be set.') + raise FatalError("Input media `%s' is not accessible" % options.source) + + if options.register and not options.upload: + raise FatalError("You also need to set -u when -r option is set") + + if options.upload and options.token is None: + raise FatalError( + "Image uploading cannot be performed. " + "No authentication token is specified. Use -t to set a token") + + if options.tmp is not None and not os.path.isdir(options.tmp): + raise FatalError("The directory `%s' specified with --tmpdir is not " + "valid" % options.tmp) + + meta = {} + for m in options.metadata: + try: + key, value = m.split('=', 1) + except ValueError: + raise FatalError("Metadata option: `%s' is not in KEY=VALUE " + "format." % m) + meta[key] = value + options.metadata = meta return options def image_creator(): - options = parse_options(sys.argv[1:]) + if options.outfile is None and not options.upload and not \ + options.print_sysprep: + raise FatalError("At least one of `-o', `-u' or `--print-sysprep' " + "must be set") + + if options.silent: + out = SilentOutput() + else: + out = OutputWthProgress(True) if sys.stderr.isatty() else \ + SimpleOutput(False) + + title = 'snf-image-creator %s' % version + out.output(title) + out.output('=' * len(title)) + if os.geteuid() != 0: - raise FatalError("You must run %s as root" \ - % os.path.basename(sys.argv[0])) + raise FatalError("You must run %s as root" + % os.path.basename(sys.argv[0])) - if not options.force: - for extension in ('', '.meta'): + if not options.force and options.outfile is not None: + for extension in ('', '.meta', '.md5sum'): filename = "%s%s" % (options.outfile, extension) if os.path.exists(filename): raise FatalError("Output file %s exists " - "(use --force to overwrite it)." % filename) + "(use --force to overwrite it)" % filename) - disk = Disk(options.source) + # Check if the authentication token is valid. The earlier the better try: - dev = disk.get_device() - dev.mount() - osclass = get_os_class(dev.distro, dev.ostype) - image_os = osclass(dev.root, dev.g) - metadata = image_os.get_metadata() + account = Kamaki.get_account(options.token) + if account is None: + raise FatalError("The authentication token you provided is not " + "valid!") + except ClientError as e: + raise FatalError("Astakos client: %d %s" % (e.status, e.message)) - if options.sysprep: - image_os.sysprep() + disk = Disk(options.source, out, options.tmp) + + def signal_handler(signum, frame): + disk.cleanup() + + signal.signal(signal.SIGINT, signal_handler) + signal.signal(signal.SIGTERM, signal_handler) + try: + snapshot = disk.snapshot() + + dev = disk.get_device(snapshot) + + # If no customization is to be applied, the image should be mounted ro + readonly = (not (options.sysprep or options.shrink) or + options.print_sysprep) + dev.mount(readonly) + + cls = os_cls(dev.distro, dev.ostype) + image_os = cls(dev.root, dev.g, out) + out.output() + + for sysprep in options.disabled_syspreps: + image_os.disable_sysprep(image_os.get_sysprep_by_name(sysprep)) - if options.cleanup: - image_os.data_cleanup() + for sysprep in options.enabled_syspreps: + image_os.enable_sysprep(image_os.get_sysprep_by_name(sysprep)) + if options.print_sysprep: + image_os.print_syspreps() + out.output() + + if options.outfile is None and not options.upload: + return 0 + + if options.sysprep: + image_os.do_sysprep() + + metadata = image_os.meta dev.umount() - size = options.shrink and dev.shrink() or dev.size() - metadata['size'] = str(size // 2 ** 20) + size = options.shrink and dev.shrink() or dev.size + metadata.update(dev.meta) + + # Add command line metadata to the collected ones... + metadata.update(options.metadata) + + md5 = MD5(out) + checksum = md5.compute(snapshot, size) + + metastring = '\n'.join( + ['%s=%s' % (key, value) for (key, value) in metadata.items()]) + metastring += '\n' - outfile = "" if options.outfile is not None: - outfile = options.outfile - f = open('%s.%s' % (options.outfile, 'meta'), 'w') - try: - for key in metadata.keys(): - f.write("%s=%s\n" % (key, metadata[key])) - finally: - f.close() - else: - outfd, outfile = tmpfile.mkstemp() - os.close(outfd) - - dd('if=%s' % dev.device, - 'of=%s' % outfile, - 'bs=4M', 'count=%d' % ((size + 1) // 2 ** 22)) + dev.dump(options.outfile) + + out.output('Dumping metadata file ...', False) + with open('%s.%s' % (options.outfile, 'meta'), 'w') as f: + f.write(metastring) + out.success('done') + + out.output('Dumping md5sum file ...', False) + with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f: + f.write('%s %s\n' % (checksum, + os.path.basename(options.outfile))) + out.success('done') + + # Destroy the device. We only need the snapshot from now on + disk.destroy_device(dev) + + out.output() + try: + uploaded_obj = "" + if options.upload: + out.output("Uploading image to pithos:") + kamaki = Kamaki(account, out) + with open(snapshot, 'rb') as f: + uploaded_obj = kamaki.upload( + f, size, options.upload, + "(1/4) Calculating block hashes", + "(2/4) Uploading missing blocks") + + out.output("(3/4) Uploading metadata file ...", False) + kamaki.upload(StringIO.StringIO(metastring), + size=len(metastring), + remote_path="%s.%s" % (options.upload, 'meta')) + out.success('done') + out.output("(4/4) Uploading md5sum file ...", False) + md5sumstr = '%s %s\n' % (checksum, + os.path.basename(options.upload)) + kamaki.upload(StringIO.StringIO(md5sumstr), + size=len(md5sumstr), + remote_path="%s.%s" % (options.upload, 'md5sum')) + out.success('done') + out.output() + + if options.register: + img_type = 'public' if options.public else 'private' + out.output('Registering %s image with ~okeanos ...' % img_type, + False) + kamaki.register(options.register, uploaded_obj, metadata, + options.public) + out.success('done') + out.output() + except ClientError as e: + raise FatalError("Pithos client: %d %s" % (e.status, e.message)) finally: + out.output('cleaning up ...') disk.cleanup() - #The image is ready, lets call kamaki if necessary - if options.upload: - pass - - if options.outfile is None: - os.unlink(outfile) + out.success("snf-image-creator exited without errors") return 0 -COLOR_BLACK = "\033[00m" -COLOR_RED = "\033[1;31m" - def main(): try: ret = image_creator() sys.exit(ret) except FatalError as e: - print >> sys.stderr, "\n%sError: %s%s\n" % (COLOR_RED, e, COLOR_BLACK) + colored = sys.stderr.isatty() + SimpleOutput(colored).error(e) sys.exit(1) - if __name__ == '__main__': main()