X-Git-Url: https://code.grnet.gr/git/snf-image-creator/blobdiff_plain/663f5f807b6685a8af18b539f0802683575103d5..5756c277d37278acc102b64d4493c040aabf38e1:/image_creator/main.py diff --git a/image_creator/main.py b/image_creator/main.py index 3161bb5..8fecf1b 100644 --- a/image_creator/main.py +++ b/image_creator/main.py @@ -1,5 +1,6 @@ #!/usr/bin/env python - +# -*- coding: utf-8 -*- +# # Copyright 2012 GRNET S.A. All rights reserved. # # Redistribution and use in source and binary forms, with or @@ -33,19 +34,22 @@ # interpreted as representing official policies, either expressed # or implied, of GRNET S.A. +"""This module is the entrance point for the non-interactive version of the +snf-image-creator program. +""" + from image_creator import __version__ as version -from image_creator import util from image_creator.disk import Disk 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 import StringIO import signal +import json def check_writable_dir(option, opt_str, value, parser): @@ -64,11 +68,6 @@ def parse_options(input_args): usage = "Usage: %prog [options] " parser = optparse.OptionParser(version=version, usage=usage) - account = os.environ["OKEANOS_USER"] if "OKEANOS_USER" in os.environ \ - else None - 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", @@ -79,30 +78,35 @@ def parse_options(input_args): help="overwrite output files if they exist") parser.add_option("-s", "--silent", dest="silent", default=False, - help="silent mode, only output errors", + 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", + help="upload the image to the cloud with name FILENAME", metavar="FILENAME") parser.add_option("-r", "--register", dest="register", type="string", default=False, - help="register the image with ~okeanos as IMAGENAME", + help="register the image with a cloud as IMAGENAME", metavar="IMAGENAME") - parser.add_option("-a", "--account", dest="account", type="string", - default=account, help="Use this ACCOUNT when " - "uploading/registering images [Default: %s]" % account) - parser.add_option("-m", "--metadata", dest="metadata", default=[], - help="Add custom KEY=VALUE metadata to the image", + 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 token when " - "uploading/registering images [Default: %s]" % token) + default=None, help="use this authentication token when " + "uploading/registering images") + + parser.add_option("-a", "--authentication-url", dest="url", type="string", + default=None, help="use this authentication URL when " + "uploading/registering images") + + parser.add_option("-c", "--cloud", dest="cloud", type="string", + default=None, help="use this saved cloud account to " + "authenticate against a cloud when " + "uploading/registering images") parser.add_option("--print-sysprep", dest="print_sysprep", default=False, help="print the enabled and disabled system preparation " @@ -117,13 +121,29 @@ def parse_options(input_args): "input media", default=[], action="append", metavar="SYSPREP") + parser.add_option("--print-sysprep-params", dest="print_sysprep_params", + default=False, help="print the needed sysprep parameters" + " for this input media", action="store_true") + + parser.add_option("--sysprep-param", dest="sysprep_params", default=[], + help="Add KEY=VALUE system preparation parameter", + action="append") + parser.add_option("--no-sysprep", dest="sysprep", default=True, - help="don't perform system preparation", + 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", action="store_false") + parser.add_option("--public", dest="public", default=False, + help="register image with the cloud as public", + 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: @@ -136,25 +156,38 @@ def parse_options(input_args): 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.account is None: - raise FatalError("Image uploading cannot be performed. No ~okeanos " - "account name is specified. Use -a to set an account " - "name.") + if options.upload and (options.token is None or options.url is None) and \ + options.cloud is None: + + err = "You need to either specify an authentication URL and token " \ + "pair or an available cloud name." - if options.upload and options.token is None: - raise FatalError("Image uploading cannot be performed. No ~okeanos " - "token is specified. User -t to set a token.") + raise FatalError("Image uploading cannot be performed. %s" % err) + + 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) + raise FatalError("Metadata option: `%s' is not in KEY=VALUE " + "format." % m) meta[key] = value options.metadata = meta + sysprep_params = {} + for p in options.sysprep_params: + try: + key, value = p.split('=', 1) + except ValueError: + raise FatalError("Sysprep parameter optiont: `%s' is not in " + "KEY=VALUE format." % p) + sysprep_params[key] = value + options.sysprep_params = sysprep_params + return options @@ -162,9 +195,9 @@ 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") + options.print_sysprep and not options.print_sysprep_params: + raise FatalError("At least one of `-o', `-u', `--print-sysprep' or " + "`--print-sysprep-params' must be set") if options.silent: out = SilentOutput() @@ -184,10 +217,51 @@ def image_creator(): for extension in ('', '.meta', '.md5sum'): filename = "%s%s" % (options.outfile, extension) if os.path.exists(filename): - raise FatalError("Output file %s exists " + raise FatalError("Output file `%s' exists " "(use --force to overwrite it)." % filename) - disk = Disk(options.source, out) + # Check if the authentication info is valid. The earlier the better + if options.token is not None and options.url is not None: + try: + account = Kamaki.create_account(options.url, options.token) + if account is None: + raise FatalError("The authentication token and/or URL you " + "provided is not valid!") + else: + kamaki = Kamaki(account, out) + except ClientError as e: + raise FatalError("Astakos client: %d %s" % (e.status, e.message)) + elif options.cloud: + avail_clouds = Kamaki.get_clouds() + if options.cloud not in avail_clouds.keys(): + raise FatalError( + "Cloud: `%s' does not exist.\n\nAvailable clouds:\n\n\t%s\n" + % (options.cloud, "\n\t".join(avail_clouds.keys()))) + try: + account = Kamaki.get_account(options.cloud) + if account is None: + raise FatalError( + "Cloud: `$s' exists but is not valid!" % options.cloud) + else: + kamaki = Kamaki(account, out) + except ClientError as e: + raise FatalError("Astakos client: %d %s" % (e.status, e.message)) + + if options.upload and not options.force: + if kamaki.object_exists(options.upload): + raise FatalError("Remote storage service object: `%s' exists " + "(use --force to overwrite it)." % options.upload) + if kamaki.object_exists("%s.md5sum" % options.upload): + raise FatalError("Remote storage service object: `%s.md5sum' " + "exists (use --force to overwrite it)." % + options.upload) + + if options.register and not options.force: + if kamaki.object_exists("%s.meta" % options.upload): + raise FatalError("Remote storage service object `%s.meta' exists " + "(use --force to overwrite it)." % options.upload) + + disk = Disk(options.source, out, options.tmp) def signal_handler(signum, frame): disk.cleanup() @@ -197,51 +271,45 @@ def image_creator(): 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() + image = disk.get_image(snapshot, sysprep_params=options.sysprep_params) for sysprep in options.disabled_syspreps: - image_os.disable_sysprep(image_os.get_sysprep_by_name(sysprep)) + image.os.disable_sysprep(image.os.get_sysprep_by_name(sysprep)) for sysprep in options.enabled_syspreps: - image_os.enable_sysprep(image_os.get_sysprep_by_name(sysprep)) + image.os.enable_sysprep(image.os.get_sysprep_by_name(sysprep)) if options.print_sysprep: - image_os.print_syspreps() + image.os.print_syspreps() + out.output() + + if options.print_sysprep_params: + image.os.print_sysprep_params() out.output() if options.outfile is None and not options.upload: return 0 if options.sysprep: - image_os.do_sysprep() + image.os.do_sysprep() - metadata = image_os.meta - dev.umount() + metadata = image.os.meta - size = options.shrink and dev.shrink() or dev.size - metadata.update(dev.meta) + size = options.shrink and image.shrink() or image.size + metadata.update(image.meta) # Add command line metadata to the collected ones... metadata.update(options.metadata) md5 = MD5(out) - checksum = md5.compute(snapshot, size) + checksum = md5.compute(image.device, size) - metastring = '\n'.join( - ['%s=%s' % (key, value) for (key, value) in metadata.items()]) - metastring += '\n' + metastring = unicode(json.dumps( + {'properties': metadata, + 'disk-format': 'diskdump'}, ensure_ascii=False)) if options.outfile is not None: - dev.dump(options.outfile) + image.dump(options.outfile) out.output('Dumping metadata file ...', False) with open('%s.%s' % (options.outfile, 'meta'), 'w') as f: @@ -254,28 +322,20 @@ def image_creator(): os.path.basename(options.outfile))) out.success('done') - # Destroy the device. We only need the snapshot from now on - disk.destroy_device(dev) + # Destroy the image instance. We only need the snapshot from now on + disk.destroy_image(image) out.output() try: uploaded_obj = "" if options.upload: - out.output("Uploading image to pithos:") - kamaki = Kamaki(options.account, options.token, out) + out.output("Uploading image to the storage service:") 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) + uploaded_obj = kamaki.upload( + f, size, options.upload, + "(1/3) Calculating block hashes", + "(2/3) Uploading missing blocks") + out.output("(3/3) Uploading md5sum file ...", False) md5sumstr = '%s %s\n' % (checksum, os.path.basename(options.upload)) kamaki.upload(StringIO.StringIO(md5sumstr), @@ -285,15 +345,32 @@ def image_creator(): out.output() if options.register: - out.output('Registering image with ~okeanos ...', False) - kamaki.register(options.register, uploaded_obj, metadata) + img_type = 'public' if options.public else 'private' + out.output('Registering %s image with the compute service ...' + % img_type, False) + result = kamaki.register(options.register, uploaded_obj, + metadata, options.public) out.success('done') + out.output("Uploading metadata file ...", False) + metastring = unicode(json.dumps(result, ensure_ascii=False)) + kamaki.upload(StringIO.StringIO(metastring), + size=len(metastring), + remote_path="%s.%s" % (options.upload, 'meta')) + out.success('done') + if options.public: + out.output("Sharing md5sum file ...", False) + kamaki.share("%s.md5sum" % options.upload) + out.success('done') + out.output("Sharing metadata file ...", False) + kamaki.share("%s.meta" % options.upload) + out.success('done') + out.output() except ClientError as e: - raise FatalError("Pithos client: %d %s" % (e.status, e.message)) + raise FatalError("Service client: %d %s" % (e.status, e.message)) finally: - out.output('cleaning up...') + out.output('cleaning up ...') disk.cleanup() out.success("snf-image-creator exited without errors")