code.grnet.gr Git - snf-image-creator/blob - image_creator/main.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3 #
   4 # Copyright 2012 GRNET S.A. All rights reserved.
   5 #
   6 # Redistribution and use in source and binary forms, with or
   7 # without modification, are permitted provided that the following
   8 # conditions are met:
   9 #
  10 #   1. Redistributions of source code must retain the above
  11 #      copyright notice, this list of conditions and the following
  12 #      disclaimer.
  13 #
  14 #   2. Redistributions in binary form must reproduce the above
  15 #      copyright notice, this list of conditions and the following
  16 #      disclaimer in the documentation and/or other materials
  17 #      provided with the distribution.
  18 #
  19 # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
  20 # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  21 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
  23 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  26 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  27 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  29 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30 # POSSIBILITY OF SUCH DAMAGE.
  31 #
  32 # The views and conclusions contained in the software and
  33 # documentation are those of the authors and should not be
  34 # interpreted as representing official policies, either expressed
  35 # or implied, of GRNET S.A.
  36
  37 """This module is the entrance point for the non-interactive version of the
  38 snf-image-creator program.
  39 """
  40
  41 from image_creator import __version__ as version
  42 from image_creator.disk import Disk
  43 from image_creator.util import FatalError, MD5
  44 from image_creator.output.cli import SilentOutput, SimpleOutput, \
  45     OutputWthProgress
  46 from image_creator.kamaki_wrapper import Kamaki, ClientError
  47 import sys
  48 import os
  49 import optparse
  50 import StringIO
  51 import signal
  52 import json
  53
  54
  55 def check_writable_dir(option, opt_str, value, parser):
  56     dirname = os.path.dirname(value)
  57     name = os.path.basename(value)
  58     if dirname and not os.path.isdir(dirname):
  59         raise FatalError("`%s' is not an existing directory" % dirname)
  60
  61     if not name:
  62         raise FatalError("`%s' is not a valid file name" % dirname)
  63
  64     setattr(parser.values, option.dest, value)
  65
  66
  67 def parse_options(input_args):
  68     usage = "Usage: %prog [options] <input_media>"
  69     parser = optparse.OptionParser(version=version, usage=usage)
  70
  71     parser.add_option("-o", "--outfile", type="string", dest="outfile",
  72                       default=None, action="callback",
  73                       callback=check_writable_dir, help="dump image to FILE",
  74                       metavar="FILE")
  75
  76     parser.add_option("-f", "--force", dest="force", default=False,
  77                       action="store_true",
  78                       help="overwrite output files if they exist")
  79
  80     parser.add_option("-s", "--silent", dest="silent", default=False,
  81                       help="output only errors",
  82                       action="store_true")
  83
  84     parser.add_option("-u", "--upload", dest="upload", type="string",
  85                       default=False,
  86                       help="upload the image to the cloud with name FILENAME",
  87                       metavar="FILENAME")
  88
  89     parser.add_option("-r", "--register", dest="register", type="string",
  90                       default=False,
  91                       help="register the image with a cloud as IMAGENAME",
  92                       metavar="IMAGENAME")
  93
  94     parser.add_option("-m", "--metadata", dest="metadata", default=[],
  95                       help="add custom KEY=VALUE metadata to the image",
  96                       action="append", metavar="KEY=VALUE")
  97
  98     parser.add_option("-t", "--token", dest="token", type="string",
  99                       default=None, help="use this authentication token when "
 100                       "uploading/registering images")
 101
 102     parser.add_option("-a", "--authentication-url", dest="url", type="string",
 103                       default=None, help="use this authentication URL when "
 104                       "uploading/registering images")
 105
 106     parser.add_option("-c", "--cloud", dest="cloud", type="string",
 107                       default=None, help="use this saved cloud account to "
 108                       "authenticate against a cloud when "
 109                       "uploading/registering images")
 110
 111     parser.add_option("--print-syspreps", dest="print_syspreps", default=False,
 112                       help="print the enabled and disabled system preparation "
 113                       "operations for this input media", action="store_true")
 114
 115     parser.add_option("--enable-sysprep", dest="enabled_syspreps", default=[],
 116                       help="run SYSPREP operation on the input media",
 117                       action="append", metavar="SYSPREP")
 118
 119     parser.add_option("--disable-sysprep", dest="disabled_syspreps",
 120                       help="prevent SYSPREP operation from running on the "
 121                       "input media", default=[], action="append",
 122                       metavar="SYSPREP")
 123
 124     parser.add_option("--print-sysprep-params", dest="print_sysprep_params",
 125                       default=False, help="print the needed sysprep parameters"
 126                       " for this input media", action="store_true")
 127
 128     parser.add_option("--sysprep-param", dest="sysprep_params", default=[],
 129                       help="Add KEY=VALUE system preparation parameter",
 130                       action="append")
 131
 132     parser.add_option("--no-sysprep", dest="sysprep", default=True,
 133                       help="don't perform any system preparation operation",
 134                       action="store_false")
 135
 136     parser.add_option("--no-shrink", dest="shrink", default=True,
 137                       help="don't shrink any partition", action="store_false")
 138
 139     parser.add_option("--public", dest="public", default=False,
 140                       help="register image with the cloud as public",
 141                       action="store_true")
 142
 143     parser.add_option("--tmpdir", dest="tmp", type="string", default=None,
 144                       help="create large temporary image files under DIR",
 145                       metavar="DIR")
 146
 147     options, args = parser.parse_args(input_args)
 148
 149     if len(args) != 1:
 150         parser.error('Wrong number of arguments')
 151
 152     options.source = args[0]
 153     if not os.path.exists(options.source):
 154         raise FatalError("Input media `%s' is not accessible" % options.source)
 155
 156     if options.register and not options.upload:
 157         raise FatalError("You also need to set -u when -r option is set")
 158
 159     if options.upload and (options.token is None or options.url is None) and \
 160             options.cloud is None:
 161
 162         err = "You need to either specify an authentication URL and token " \
 163               "pair or an available cloud name."
 164
 165         raise FatalError("Image uploading cannot be performed. %s" % err)
 166
 167     if options.tmp is not None and not os.path.isdir(options.tmp):
 168         raise FatalError("The directory `%s' specified with --tmpdir is not "
 169                          "valid" % options.tmp)
 170
 171     meta = {}
 172     for m in options.metadata:
 173         try:
 174             key, value = m.split('=', 1)
 175         except ValueError:
 176             raise FatalError("Metadata option: `%s' is not in KEY=VALUE "
 177                              "format." % m)
 178         meta[key] = value
 179     options.metadata = meta
 180
 181     sysprep_params = {}
 182     for p in options.sysprep_params:
 183         try:
 184             key, value = p.split('=', 1)
 185         except ValueError:
 186             raise FatalError("Sysprep parameter optiont: `%s' is not in "
 187                              "KEY=VALUE format." % p)
 188         sysprep_params[key] = value
 189     options.sysprep_params = sysprep_params
 190
 191     return options
 192
 193
 194 def image_creator():
 195     options = parse_options(sys.argv[1:])
 196
 197     if options.outfile is None and not options.upload and not \
 198             options.print_syspreps and not options.print_sysprep_params:
 199         raise FatalError("At least one of `-o', `-u', `--print-syspreps' or "
 200                          "`--print-sysprep-params' must be set")
 201
 202     if options.silent:
 203         out = SilentOutput()
 204     else:
 205         out = OutputWthProgress(True) if sys.stderr.isatty() else \
 206             SimpleOutput(False)
 207
 208     title = 'snf-image-creator %s' % version
 209     out.output(title)
 210     out.output('=' * len(title))
 211
 212     if os.geteuid() != 0:
 213         raise FatalError("You must run %s as root"
 214                          % os.path.basename(sys.argv[0]))
 215
 216     if not options.force and options.outfile is not None:
 217         for extension in ('', '.meta', '.md5sum'):
 218             filename = "%s%s" % (options.outfile, extension)
 219             if os.path.exists(filename):
 220                 raise FatalError("Output file `%s' exists "
 221                                  "(use --force to overwrite it)." % filename)
 222
 223     # Check if the authentication info is valid. The earlier the better
 224     if options.token is not None and options.url is not None:
 225         try:
 226             account = Kamaki.create_account(options.url, options.token)
 227             if account is None:
 228                 raise FatalError("The authentication token and/or URL you "
 229                                  "provided is not valid!")
 230             else:
 231                 kamaki = Kamaki(account, out)
 232         except ClientError as e:
 233             raise FatalError("Astakos client: %d %s" % (e.status, e.message))
 234     elif options.cloud:
 235         avail_clouds = Kamaki.get_clouds()
 236         if options.cloud not in avail_clouds.keys():
 237             raise FatalError(
 238                 "Cloud: `%s' does not exist.\n\nAvailable clouds:\n\n\t%s\n"
 239                 % (options.cloud, "\n\t".join(avail_clouds.keys())))
 240         try:
 241             account = Kamaki.get_account(options.cloud)
 242             if account is None:
 243                 raise FatalError(
 244                     "Cloud: `$s' exists but is not valid!" % options.cloud)
 245             else:
 246                 kamaki = Kamaki(account, out)
 247         except ClientError as e:
 248             raise FatalError("Astakos client: %d %s" % (e.status, e.message))
 249
 250     if options.upload and not options.force:
 251         if kamaki.object_exists(options.upload):
 252             raise FatalError("Remote storage service object: `%s' exists "
 253                              "(use --force to overwrite it)." % options.upload)
 254         if kamaki.object_exists("%s.md5sum" % options.upload):
 255             raise FatalError("Remote storage service object: `%s.md5sum' "
 256                              "exists (use --force to overwrite it)." %
 257                              options.upload)
 258
 259     if options.register and not options.force:
 260         if kamaki.object_exists("%s.meta" % options.upload):
 261             raise FatalError("Remote storage service object `%s.meta' exists "
 262                              "(use --force to overwrite it)." % options.upload)
 263
 264     disk = Disk(options.source, out, options.tmp)
 265
 266     def signal_handler(signum, frame):
 267         disk.cleanup()
 268
 269     signal.signal(signal.SIGINT, signal_handler)
 270     signal.signal(signal.SIGTERM, signal_handler)
 271     try:
 272         snapshot = disk.snapshot()
 273
 274         image = disk.get_image(snapshot, sysprep_params=options.sysprep_params)
 275
 276         for sysprep in options.disabled_syspreps:
 277             image.os.disable_sysprep(image.os.get_sysprep_by_name(sysprep))
 278
 279         for sysprep in options.enabled_syspreps:
 280             image.os.enable_sysprep(image.os.get_sysprep_by_name(sysprep))
 281
 282         if options.print_syspreps:
 283             image.os.print_syspreps()
 284             out.output()
 285
 286         if options.print_sysprep_params:
 287             image.os.print_sysprep_params()
 288             out.output()
 289
 290         if options.outfile is None and not options.upload:
 291             return 0
 292
 293         if options.sysprep:
 294             image.os.do_sysprep()
 295
 296         metadata = image.os.meta
 297
 298         size = options.shrink and image.shrink() or image.size
 299         metadata.update(image.meta)
 300
 301         # Add command line metadata to the collected ones...
 302         metadata.update(options.metadata)
 303
 304         md5 = MD5(out)
 305         checksum = md5.compute(image.device, size)
 306
 307         metastring = unicode(json.dumps(
 308             {'properties': metadata,
 309              'disk-format': 'diskdump'}, ensure_ascii=False))
 310
 311         if options.outfile is not None:
 312             image.dump(options.outfile)
 313
 314             out.output('Dumping metadata file ...', False)
 315             with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
 316                 f.write(metastring)
 317             out.success('done')
 318
 319             out.output('Dumping md5sum file ...', False)
 320             with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
 321                 f.write('%s %s\n' % (checksum,
 322                                      os.path.basename(options.outfile)))
 323             out.success('done')
 324
 325         # Destroy the image instance. We only need the snapshot from now on
 326         disk.destroy_image(image)
 327
 328         out.output()
 329         try:
 330             uploaded_obj = ""
 331             if options.upload:
 332                 out.output("Uploading image to the storage service:")
 333                 with open(snapshot, 'rb') as f:
 334                     uploaded_obj = kamaki.upload(
 335                         f, size, options.upload,
 336                         "(1/3)  Calculating block hashes",
 337                         "(2/3)  Uploading missing blocks")
 338                 out.output("(3/3)  Uploading md5sum file ...", False)
 339                 md5sumstr = '%s %s\n' % (checksum,
 340                                          os.path.basename(options.upload))
 341                 kamaki.upload(StringIO.StringIO(md5sumstr),
 342                               size=len(md5sumstr),
 343                               remote_path="%s.%s" % (options.upload, 'md5sum'))
 344                 out.success('done')
 345                 out.output()
 346
 347             if options.register:
 348                 img_type = 'public' if options.public else 'private'
 349                 out.output('Registering %s image with the compute service ...'
 350                            % img_type, False)
 351                 result = kamaki.register(options.register, uploaded_obj,
 352                                          metadata, options.public)
 353                 out.success('done')
 354                 out.output("Uploading metadata file ...", False)
 355                 metastring = unicode(json.dumps(result, ensure_ascii=False))
 356                 kamaki.upload(StringIO.StringIO(metastring),
 357                               size=len(metastring),
 358                               remote_path="%s.%s" % (options.upload, 'meta'))
 359                 out.success('done')
 360                 if options.public:
 361                     out.output("Sharing md5sum file ...", False)
 362                     kamaki.share("%s.md5sum" % options.upload)
 363                     out.success('done')
 364                     out.output("Sharing metadata file ...", False)
 365                     kamaki.share("%s.meta" % options.upload)
 366                     out.success('done')
 367
 368                 out.output()
 369         except ClientError as e:
 370             raise FatalError("Service client: %d %s" % (e.status, e.message))
 371
 372     finally:
 373         out.output('cleaning up ...')
 374         disk.cleanup()
 375
 376     out.success("snf-image-creator exited without errors")
 377
 378     return 0
 379
 380
 381 def main():
 382     try:
 383         ret = image_creator()
 384         sys.exit(ret)
 385     except FatalError as e:
 386         colored = sys.stderr.isatty()
 387         SimpleOutput(colored).error(e)
 388         sys.exit(1)
 389
 390 if __name__ == '__main__':
 391     main()
 392
 393 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :