#!/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
# 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.disk import Disk
from image_creator.util import FatalError, MD5
import optparse
import StringIO
import signal
+import json
+import textwrap
def check_writable_dir(option, opt_str, value, parser):
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("-m", "--metadata", dest="metadata", default=[],
default=None, help="use this authentication token when "
"uploading/registering images")
- parser.add_option("--print-sysprep", dest="print_sysprep", default=False,
+ 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-syspreps", dest="print_syspreps", default=False,
help="print the enabled and disabled system preparation "
"operations for this input media", action="store_true")
"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 any system preparation operation",
action="store_false")
help="don't shrink any partition", action="store_false")
parser.add_option("--public", dest="public", default=False,
- help="register image with cyclades as public",
+ help="register image with the cloud as public",
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("--tmpdir", dest="tmp", type="string", default=None,
help="create large temporary image files under DIR",
metavar="DIR")
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.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."
+
+ 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 "
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
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_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()
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 token is valid. The earlier the better
- if options.token is not None:
+ # 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.get_account(options.token)
+ account = Kamaki.create_account(options.url, options.token)
if account is None:
- raise FatalError("The authentication token you provided is not"
- " valid!")
+ 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)
try:
snapshot = disk.snapshot()
- image = disk.get_image(snapshot)
+ image = disk.get_image(snapshot, sysprep_params=options.sysprep_params)
- # If no customization is to be applied, the image should be mounted ro
- ro = (not (options.sysprep or options.shrink) or options.print_sysprep)
- image.mount(ro)
- try:
- for sysprep in options.disabled_syspreps:
- image.os.disable_sysprep(image.os.get_sysprep_by_name(sysprep))
+ 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.enabled_syspreps:
- image.os.enable_sysprep(image.os.get_sysprep_by_name(sysprep))
+ for sysprep in options.disabled_syspreps:
+ image.os.disable_sysprep(image.os.get_sysprep_by_name(sysprep))
- if options.print_sysprep:
- image.os.print_syspreps()
- out.output()
+ for sysprep in options.enabled_syspreps:
+ image.os.enable_sysprep(image.os.get_sysprep_by_name(sysprep))
- if options.outfile is None and not options.upload:
- return 0
+ if options.print_syspreps:
+ image.os.print_syspreps()
+ out.output()
- if options.sysprep:
- err_msg = "Unable to apply the system preparation tasks."
- if not image.mounted:
- raise FatalError("%s Couldn't mount the media." % err_msg)
- elif image.mounted_ro:
- raise FatalError("%s Couldn't mount the media read-write."
- % err_msg)
- image.os.do_sysprep()
+ if options.print_sysprep_params:
+ image.os.print_sysprep_params()
+ out.output()
- metadata = image.os.meta
- finally:
- image.umount()
+ if options.outfile is None and not options.upload:
+ return 0
+
+ if options.sysprep:
+ image.os.do_sysprep()
+
+ metadata = image.os.meta
size = options.shrink and image.shrink() or image.size
metadata.update(image.meta)
+ if image.is_unsupported():
+ metadata['EXCLUDE_ALL_TASKS'] = "yes"
+
# Add command line metadata to the collected ones...
metadata.update(options.metadata)
md5 = MD5(out)
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:
image.dump(options.outfile)
try:
uploaded_obj = ""
if options.upload:
- out.output("Uploading image to pithos:")
- kamaki = Kamaki(account, 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)
+ "(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),
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.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 ...')
sys.exit(ret)
except FatalError as 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)