Statistics
| Branch: | Tag: | Revision:

root / image_creator / main.py @ d415dda2

History | View | Annotate | Download (14.9 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-sysprep", dest="print_sysprep", 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("--sysprep-param", dest="sysprep_params", default=[],
125
                      help="Add KEY=VALUE system preparation parameter",
126
                      action="append")
127

    
128
    parser.add_option("--no-sysprep", dest="sysprep", default=True,
129
                      help="don't perform any system preparation operation",
130
                      action="store_false")
131

    
132
    parser.add_option("--no-shrink", dest="shrink", default=True,
133
                      help="don't shrink any partition", action="store_false")
134

    
135
    parser.add_option("--public", dest="public", default=False,
136
                      help="register image with the cloud as public",
137
                      action="store_true")
138

    
139
    parser.add_option("--tmpdir", dest="tmp", type="string", default=None,
140
                      help="create large temporary image files under DIR",
141
                      metavar="DIR")
142

    
143
    options, args = parser.parse_args(input_args)
144

    
145
    if len(args) != 1:
146
        parser.error('Wrong number of arguments')
147

    
148
    options.source = args[0]
149
    if not os.path.exists(options.source):
150
        raise FatalError("Input media `%s' is not accessible" % options.source)
151

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

    
155
    if options.upload and (options.token is None or options.url is None) and \
156
            options.cloud is None:
157

    
158
        err = "You need to either specify an authentication URL and token " \
159
              "pair or an available cloud name."
160

    
161
        raise FatalError("Image uploading cannot be performed. %s" % err)
162

    
163
    if options.tmp is not None and not os.path.isdir(options.tmp):
164
        raise FatalError("The directory `%s' specified with --tmpdir is not "
165
                         "valid" % options.tmp)
166

    
167
    meta = {}
168
    for m in options.metadata:
169
        try:
170
            key, value = m.split('=', 1)
171
        except ValueError:
172
            raise FatalError("Metadata option: `%s' is not in KEY=VALUE "
173
                             "format." % m)
174
        meta[key] = value
175
    options.metadata = meta
176

    
177
    sysprep_params = {}
178
    for p in options.sysprep_params:
179
        try:
180
            key, value = p.split('=', 1)
181
        except ValueError:
182
            raise FatalError("Sysprep parameter optiont: `%s' is not in "
183
                             "KEY=VALUE format." % p)
184
        sysprep_params[key] = value
185
    options.sysprep_params = sysprep_params
186

    
187
    return options
188

    
189

    
190
def image_creator():
191
    options = parse_options(sys.argv[1:])
192

    
193
    if options.outfile is None and not options.upload and not \
194
            options.print_sysprep:
195
        raise FatalError("At least one of `-o', `-u' or `--print-sysprep' "
196
                         "must be set")
197

    
198
    if options.silent:
199
        out = SilentOutput()
200
    else:
201
        out = OutputWthProgress(True) if sys.stderr.isatty() else \
202
            SimpleOutput(False)
203

    
204
    title = 'snf-image-creator %s' % version
205
    out.output(title)
206
    out.output('=' * len(title))
207

    
208
    if os.geteuid() != 0:
209
        raise FatalError("You must run %s as root"
210
                         % os.path.basename(sys.argv[0]))
211

    
212
    if not options.force and options.outfile is not None:
213
        for extension in ('', '.meta', '.md5sum'):
214
            filename = "%s%s" % (options.outfile, extension)
215
            if os.path.exists(filename):
216
                raise FatalError("Output file `%s' exists "
217
                                 "(use --force to overwrite it)." % filename)
218

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

    
246
    if options.upload and not options.force:
247
        if kamaki.object_exists(options.upload):
248
            raise FatalError("Remote storage service object: `%s' exists "
249
                             "(use --force to overwrite it)." % options.upload)
250
        if kamaki.object_exists("%s.md5sum" % options.upload):
251
            raise FatalError("Remote storage service object: `%s.md5sum' "
252
                             "exists (use --force to overwrite it)." %
253
                             options.upload)
254

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

    
260
    disk = Disk(options.source, out, options.tmp)
261

    
262
    def signal_handler(signum, frame):
263
        disk.cleanup()
264

    
265
    signal.signal(signal.SIGINT, signal_handler)
266
    signal.signal(signal.SIGTERM, signal_handler)
267
    try:
268
        snapshot = disk.snapshot()
269

    
270
        image = disk.get_image(snapshot, sysprep_params=options.sysprep_params)
271

    
272
        for sysprep in options.disabled_syspreps:
273
            image.os.disable_sysprep(image.os.get_sysprep_by_name(sysprep))
274

    
275
        for sysprep in options.enabled_syspreps:
276
            image.os.enable_sysprep(image.os.get_sysprep_by_name(sysprep))
277

    
278
        if options.print_sysprep:
279
            image.os.print_syspreps()
280
            out.output()
281

    
282
        if options.outfile is None and not options.upload:
283
            return 0
284

    
285
        if options.sysprep:
286
            image.os.do_sysprep()
287

    
288
        metadata = image.os.meta
289

    
290
        size = options.shrink and image.shrink() or image.size
291
        metadata.update(image.meta)
292

    
293
        # Add command line metadata to the collected ones...
294
        metadata.update(options.metadata)
295

    
296
        md5 = MD5(out)
297
        checksum = md5.compute(image.device, size)
298

    
299
        metastring = unicode(json.dumps(
300
            {'properties': metadata,
301
             'disk-format': 'diskdump'}, ensure_ascii=False))
302

    
303
        if options.outfile is not None:
304
            image.dump(options.outfile)
305

    
306
            out.output('Dumping metadata file ...', False)
307
            with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
308
                f.write(metastring)
309
            out.success('done')
310

    
311
            out.output('Dumping md5sum file ...', False)
312
            with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
313
                f.write('%s %s\n' % (checksum,
314
                                     os.path.basename(options.outfile)))
315
            out.success('done')
316

    
317
        # Destroy the image instance. We only need the snapshot from now on
318
        disk.destroy_image(image)
319

    
320
        out.output()
321
        try:
322
            uploaded_obj = ""
323
            if options.upload:
324
                out.output("Uploading image to the storage service:")
325
                with open(snapshot, 'rb') as f:
326
                    uploaded_obj = kamaki.upload(
327
                        f, size, options.upload,
328
                        "(1/3)  Calculating block hashes",
329
                        "(2/3)  Uploading missing blocks")
330
                out.output("(3/3)  Uploading md5sum file ...", False)
331
                md5sumstr = '%s %s\n' % (checksum,
332
                                         os.path.basename(options.upload))
333
                kamaki.upload(StringIO.StringIO(md5sumstr),
334
                              size=len(md5sumstr),
335
                              remote_path="%s.%s" % (options.upload, 'md5sum'))
336
                out.success('done')
337
                out.output()
338

    
339
            if options.register:
340
                img_type = 'public' if options.public else 'private'
341
                out.output('Registering %s image with the compute service ...'
342
                           % img_type, False)
343
                result = kamaki.register(options.register, uploaded_obj,
344
                                         metadata, options.public)
345
                out.success('done')
346
                out.output("Uploading metadata file ...", False)
347
                metastring = unicode(json.dumps(result, ensure_ascii=False))
348
                kamaki.upload(StringIO.StringIO(metastring),
349
                              size=len(metastring),
350
                              remote_path="%s.%s" % (options.upload, 'meta'))
351
                out.success('done')
352
                if options.public:
353
                    out.output("Sharing md5sum file ...", False)
354
                    kamaki.share("%s.md5sum" % options.upload)
355
                    out.success('done')
356
                    out.output("Sharing metadata file ...", False)
357
                    kamaki.share("%s.meta" % options.upload)
358
                    out.success('done')
359

    
360
                out.output()
361
        except ClientError as e:
362
            raise FatalError("Service client: %d %s" % (e.status, e.message))
363

    
364
    finally:
365
        out.output('cleaning up ...')
366
        disk.cleanup()
367

    
368
    out.success("snf-image-creator exited without errors")
369

    
370
    return 0
371

    
372

    
373
def main():
374
    try:
375
        ret = image_creator()
376
        sys.exit(ret)
377
    except FatalError as e:
378
        colored = sys.stderr.isatty()
379
        SimpleOutput(colored).error(e)
380
        sys.exit(1)
381

    
382
if __name__ == '__main__':
383
    main()
384

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