Statistics
| Branch: | Tag: | Revision:

root / image_creator / main.py @ e482b7f9

History | View | Annotate | Download (16.1 kB)

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("--allow-unsupported", dest="allow_unsupported",
144
                      help="Proceed with the image creation even if the media "
145
                      "is not supported", default=False, action="store_true")
146

    
147
    parser.add_option("--tmpdir", dest="tmp", type="string", default=None,
148
                      help="create large temporary image files under DIR",
149
                      metavar="DIR")
150

    
151
    options, args = parser.parse_args(input_args)
152

    
153
    if len(args) != 1:
154
        parser.error('Wrong number of arguments')
155

    
156
    options.source = args[0]
157
    if not os.path.exists(options.source):
158
        raise FatalError("Input media `%s' is not accessible" % options.source)
159

    
160
    if options.register and not options.upload:
161
        raise FatalError("You also need to set -u when -r option is set")
162

    
163
    if options.upload and (options.token is None or options.url is None) and \
164
            options.cloud is None:
165

    
166
        err = "You need to either specify an authentication URL and token " \
167
              "pair or an available cloud name."
168

    
169
        raise FatalError("Image uploading cannot be performed. %s" % err)
170

    
171
    if options.tmp is not None and not os.path.isdir(options.tmp):
172
        raise FatalError("The directory `%s' specified with --tmpdir is not "
173
                         "valid" % options.tmp)
174

    
175
    meta = {}
176
    for m in options.metadata:
177
        try:
178
            key, value = m.split('=', 1)
179
        except ValueError:
180
            raise FatalError("Metadata option: `%s' is not in KEY=VALUE "
181
                             "format." % m)
182
        meta[key] = value
183
    options.metadata = meta
184

    
185
    sysprep_params = {}
186
    for p in options.sysprep_params:
187
        try:
188
            key, value = p.split('=', 1)
189
        except ValueError:
190
            raise FatalError("Sysprep parameter optiont: `%s' is not in "
191
                             "KEY=VALUE format." % p)
192
        sysprep_params[key] = value
193
    options.sysprep_params = sysprep_params
194

    
195
    return options
196

    
197

    
198
def image_creator():
199
    options = parse_options(sys.argv[1:])
200

    
201
    if options.outfile is None and not options.upload and not \
202
            options.print_syspreps and not options.print_sysprep_params:
203
        raise FatalError("At least one of `-o', `-u', `--print-syspreps' or "
204
                         "`--print-sysprep-params' must be set")
205

    
206
    if options.silent:
207
        out = SilentOutput()
208
    else:
209
        out = OutputWthProgress(True) if sys.stderr.isatty() else \
210
            SimpleOutput(False)
211

    
212
    title = 'snf-image-creator %s' % version
213
    out.output(title)
214
    out.output('=' * len(title))
215

    
216
    if os.geteuid() != 0:
217
        raise FatalError("You must run %s as root"
218
                         % os.path.basename(sys.argv[0]))
219

    
220
    if not options.force and options.outfile is not None:
221
        for extension in ('', '.meta', '.md5sum'):
222
            filename = "%s%s" % (options.outfile, extension)
223
            if os.path.exists(filename):
224
                raise FatalError("Output file `%s' exists "
225
                                 "(use --force to overwrite it)." % filename)
226

    
227
    # Check if the authentication info is valid. The earlier the better
228
    if options.token is not None and options.url is not None:
229
        try:
230
            account = Kamaki.create_account(options.url, options.token)
231
            if account is None:
232
                raise FatalError("The authentication token and/or URL you "
233
                                 "provided is not valid!")
234
            else:
235
                kamaki = Kamaki(account, out)
236
        except ClientError as e:
237
            raise FatalError("Astakos client: %d %s" % (e.status, e.message))
238
    elif options.cloud:
239
        avail_clouds = Kamaki.get_clouds()
240
        if options.cloud not in avail_clouds.keys():
241
            raise FatalError(
242
                "Cloud: `%s' does not exist.\n\nAvailable clouds:\n\n\t%s\n"
243
                % (options.cloud, "\n\t".join(avail_clouds.keys())))
244
        try:
245
            account = Kamaki.get_account(options.cloud)
246
            if account is None:
247
                raise FatalError(
248
                    "Cloud: `$s' exists but is not valid!" % options.cloud)
249
            else:
250
                kamaki = Kamaki(account, out)
251
        except ClientError as e:
252
            raise FatalError("Astakos client: %d %s" % (e.status, e.message))
253

    
254
    if options.upload and not options.force:
255
        if kamaki.object_exists(options.upload):
256
            raise FatalError("Remote storage service object: `%s' exists "
257
                             "(use --force to overwrite it)." % options.upload)
258
        if kamaki.object_exists("%s.md5sum" % options.upload):
259
            raise FatalError("Remote storage service object: `%s.md5sum' "
260
                             "exists (use --force to overwrite it)." %
261
                             options.upload)
262

    
263
    if options.register and not options.force:
264
        if kamaki.object_exists("%s.meta" % options.upload):
265
            raise FatalError("Remote storage service object `%s.meta' exists "
266
                             "(use --force to overwrite it)." % options.upload)
267

    
268
    disk = Disk(options.source, out, options.tmp)
269

    
270
    def signal_handler(signum, frame):
271
        disk.cleanup()
272

    
273
    signal.signal(signal.SIGINT, signal_handler)
274
    signal.signal(signal.SIGTERM, signal_handler)
275
    try:
276
        snapshot = disk.snapshot()
277

    
278
        image = disk.get_image(snapshot, sysprep_params=options.sysprep_params)
279

    
280
        if hasattr(image, 'unsupported') and not options.allow_unsupported:
281
            raise FatalError(
282
                "The media seems to be unsupported. If you insist on creating "
283
                "an image out of it, use the `--allow-unsupported' option. "
284
                "Using this is highly discouraged, since the resulting image "
285
                "will not be cleaned up from sensitive data and will not get "
286
                "configured during the deployment")
287

    
288
        for sysprep in options.disabled_syspreps:
289
            image.os.disable_sysprep(image.os.get_sysprep_by_name(sysprep))
290

    
291
        for sysprep in options.enabled_syspreps:
292
            image.os.enable_sysprep(image.os.get_sysprep_by_name(sysprep))
293

    
294
        if options.print_syspreps:
295
            image.os.print_syspreps()
296
            out.output()
297

    
298
        if options.print_sysprep_params:
299
            image.os.print_sysprep_params()
300
            out.output()
301

    
302
        if options.outfile is None and not options.upload:
303
            return 0
304

    
305
        if options.sysprep:
306
            image.os.do_sysprep()
307

    
308
        metadata = image.os.meta
309

    
310
        size = options.shrink and image.shrink() or image.size
311
        metadata.update(image.meta)
312

    
313
        if hasattr(image, 'unsupported'):
314
            metadata['EXCLUDE_ALL_TASKS'] = "yes"
315

    
316
        # Add command line metadata to the collected ones...
317
        metadata.update(options.metadata)
318

    
319
        md5 = MD5(out)
320
        checksum = md5.compute(image.device, size)
321

    
322
        metastring = unicode(json.dumps(
323
            {'properties': metadata,
324
             'disk-format': 'diskdump'}, ensure_ascii=False))
325

    
326
        if options.outfile is not None:
327
            image.dump(options.outfile)
328

    
329
            out.output('Dumping metadata file ...', False)
330
            with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
331
                f.write(metastring)
332
            out.success('done')
333

    
334
            out.output('Dumping md5sum file ...', False)
335
            with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
336
                f.write('%s %s\n' % (checksum,
337
                                     os.path.basename(options.outfile)))
338
            out.success('done')
339

    
340
        # Destroy the image instance. We only need the snapshot from now on
341
        disk.destroy_image(image)
342

    
343
        out.output()
344
        try:
345
            uploaded_obj = ""
346
            if options.upload:
347
                out.output("Uploading image to the storage service:")
348
                with open(snapshot, 'rb') as f:
349
                    uploaded_obj = kamaki.upload(
350
                        f, size, options.upload,
351
                        "(1/3)  Calculating block hashes",
352
                        "(2/3)  Uploading missing blocks")
353
                out.output("(3/3)  Uploading md5sum file ...", False)
354
                md5sumstr = '%s %s\n' % (checksum,
355
                                         os.path.basename(options.upload))
356
                kamaki.upload(StringIO.StringIO(md5sumstr),
357
                              size=len(md5sumstr),
358
                              remote_path="%s.%s" % (options.upload, 'md5sum'))
359
                out.success('done')
360
                out.output()
361

    
362
            if options.register:
363
                img_type = 'public' if options.public else 'private'
364
                out.output('Registering %s image with the compute service ...'
365
                           % img_type, False)
366
                result = kamaki.register(options.register, uploaded_obj,
367
                                         metadata, options.public)
368
                out.success('done')
369
                out.output("Uploading metadata file ...", False)
370
                metastring = unicode(json.dumps(result, ensure_ascii=False))
371
                kamaki.upload(StringIO.StringIO(metastring),
372
                              size=len(metastring),
373
                              remote_path="%s.%s" % (options.upload, 'meta'))
374
                out.success('done')
375
                if options.public:
376
                    out.output("Sharing md5sum file ...", False)
377
                    kamaki.share("%s.md5sum" % options.upload)
378
                    out.success('done')
379
                    out.output("Sharing metadata file ...", False)
380
                    kamaki.share("%s.meta" % options.upload)
381
                    out.success('done')
382

    
383
                out.output()
384
        except ClientError as e:
385
            raise FatalError("Service client: %d %s" % (e.status, e.message))
386

    
387
    finally:
388
        out.output('cleaning up ...')
389
        disk.cleanup()
390

    
391
    out.success("snf-image-creator exited without errors")
392

    
393
    return 0
394

    
395

    
396
def main():
397
    try:
398
        ret = image_creator()
399
        sys.exit(ret)
400
    except FatalError as e:
401
        colored = sys.stderr.isatty()
402
        SimpleOutput(colored).error(e)
403
        sys.exit(1)
404

    
405
if __name__ == '__main__':
406
    main()
407

    
408
# vim: set sta sts=4 shiftwidth=4 sw=4 et ai :