#!/usr/bin/env python
-
-# Copyright 2011 GRNET S.A. All rights reserved.
+# -*- coding: utf-8 -*-
+#
+# 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
# interpreted as representing official policies, either expressed
# or implied, of GRNET S.A.
-from image_creator import get_os_class
+"""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 FatalError
from image_creator.disk import Disk
-from image_creator.util import get_command, error, progress_generator, success
-from clint.textui import puts, indent
-from sendfile import sendfile
-
+from image_creator.util import FatalError, MD5
+from image_creator.output.cli import SilentOutput, SimpleOutput, \
+ OutputWthProgress
+from image_creator.kamaki_wrapper import Kamaki, ClientError
import sys
import os
import optparse
-
-dd = get_command('dd')
+import StringIO
+import signal
+import json
+import textwrap
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)
usage = "Usage: %prog [options] <input_media>"
parser = optparse.OptionParser(version=version, usage=usage)
+ 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 the cloud with name FILENAME",
+ metavar="FILENAME")
+
+ parser.add_option("-r", "--register", dest="register", type="string",
+ default=False,
+ help="register the image with a cloud 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=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("--no-cleanup", dest="cleanup", default=True,
- help="Don't cleanup sensitive data before extracting the image",
- action="store_false")
+ 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-syspreps", dest="print_syspreps", 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("--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 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 the cloud 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("--allow-unsupported", dest="allow_unsupported",
+ help="Proceed with the image creation even if the media "
+ "is not supported", default=False, 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')
+ raise FatalError("Input media `%s' is not accessible" % options.source)
- if options.register:
- options.upload = True
+ if options.register and not options.upload:
+ raise FatalError("You also need to set -u when -r option is set")
- if options.outfile is None and not options.upload:
- parser.error('either outfile (-o) or upload (-u) must be set.')
+ if options.upload and (options.token is None or options.url is None) and \
+ options.cloud is None:
- return options
+ err = "You need to either specify an authentication URL and token " \
+ "pair or an available cloud name."
+ raise FatalError("Image uploading cannot be performed. %s" % err)
-def extract_image(device, outfile, size):
- blocksize = 4194304 # 4MB
- progress_size = (size + 1048575) // 1048576 # in MB
- progressbar = progress_generator("Dumping image file: ",
- progress_size)
- source = open(device, "r")
- try:
- dest = open(outfile, "w")
+ 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:
- left = size
- offset = 0
- progressbar.next()
- while left > 0:
- length = min(left, blocksize)
- sent = sendfile(dest.fileno(), source.fileno(), offset, length)
- offset += sent
- left -= sent
- for i in range(4):
- progressbar.next()
- finally:
- dest.close()
- finally:
- source.close()
+ 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
+
+ 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
- success('Image file %s was successfully created' % outfile)
+ return options
def image_creator():
- puts('snf-image-creator %s\n' % version)
options = parse_options(sys.argv[1:])
+ if options.outfile is None and not options.upload and not \
+ options.print_syspreps and not options.print_sysprep_params:
+ raise FatalError("At least one of `-o', `-u', `--print-syspreps' or "
+ "`--print-sysprep-params' 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)
+ raise FatalError("Output file `%s' exists "
+ "(use --force to overwrite it)." % filename)
+
+ # 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()
- disk = Disk(options.source)
+ signal.signal(signal.SIGINT, signal_handler)
+ signal.signal(signal.SIGTERM, signal_handler)
try:
- dev = disk.get_device()
- dev.mount()
+ snapshot = disk.snapshot()
+
+ image = disk.get_image(snapshot, sysprep_params=options.sysprep_params)
+
+ if image.is_unsupported() and not options.allow_unsupported:
+ raise FatalError(
+ "The media seems to be unsupported.\n\n" +
+ textwrap.fill("To create an image from an unsupported media, "
+ "you'll need to use the`--allow-unsupported' "
+ "command line option. Using this is highly "
+ "discouraged, since the resulting image will "
+ "not be cleared out of sensitive data and will "
+ "not get customized during the deployment."))
+
+ for sysprep in options.disabled_syspreps:
+ 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))
- osclass = get_os_class(dev.distro, dev.ostype)
- image_os = osclass(dev.root, dev.g)
- metadata = image_os.get_metadata()
+ if options.print_syspreps:
+ image.os.print_syspreps()
+ out.output()
- puts()
+ 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.sysprep()
+ image.os.do_sysprep()
+
+ metadata = image.os.meta
+
+ size = options.shrink and image.shrink() or image.size
+ metadata.update(image.meta)
- if options.cleanup:
- image_os.data_cleanup()
+ if image.is_unsupported():
+ metadata['EXCLUDE_ALL_TASKS'] = "yes"
- dev.umount()
+ # Add command line metadata to the collected ones...
+ metadata.update(options.metadata)
- size = options.shrink and dev.shrink() or dev.size()
- metadata['size'] = str(size // 2 ** 20)
+ md5 = MD5(out)
+ checksum = md5.compute(image.device, size)
+
+ metastring = unicode(json.dumps(
+ {'properties': metadata,
+ 'disk-format': 'diskdump'}, ensure_ascii=False))
if options.outfile is not None:
- 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()
-
- extract_image(dev.device, options.outfile, size)
+ image.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 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 the storage service:")
+ with open(snapshot, 'rb') as f:
+ 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),
+ 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 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("Service client: %d %s" % (e.status, e.message))
+
finally:
- puts('cleaning up...')
+ out.output('cleaning up ...')
disk.cleanup()
+ out.success("snf-image-creator exited without errors")
+
return 0
ret = image_creator()
sys.exit(ret)
except FatalError as e:
- error(e)
+ colored = sys.stderr.isatty()
+ warning = \
+ "The name of the executable has changed. If you want to use the " \
+ "user-friendly dialog-based program try `snf-image-creator'"
+ SimpleOutput(colored).warn(warning)
+ SimpleOutput(colored).error(e)
sys.exit(1)
-
if __name__ == '__main__':
main()
projects / snf-image-creator / blobdiff