Statistics
| Branch: | Tag: | Revision:

root / image_creator / main.py @ ffc64d7c

History | View | Annotate | Download (14.4 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("--no-sysprep", dest="sysprep", default=True,
125
                      help="don't perform any system preparation operation",
126
                      action="store_false")
127

    
128
    parser.add_option("--no-shrink", dest="shrink", default=True,
129
                      help="don't shrink any partition", action="store_false")
130

    
131
    parser.add_option("--public", dest="public", default=False,
132
                      help="register image with the cloud as public",
133
                      action="store_true")
134

    
135
    parser.add_option("--tmpdir", dest="tmp", type="string", default=None,
136
                      help="create large temporary image files under DIR",
137
                      metavar="DIR")
138

    
139
    options, args = parser.parse_args(input_args)
140

    
141
    if len(args) != 1:
142
        parser.error('Wrong number of arguments')
143

    
144
    options.source = args[0]
145
    if not os.path.exists(options.source):
146
        raise FatalError("Input media `%s' is not accessible" % options.source)
147

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

    
151
    if options.upload and (options.token is None or options.url is None) and \
152
            options.cloud is None:
153

    
154
        err = "You need to either specify an authentication URL and token " \
155
              "pair or an available cloud name."
156

    
157
        raise FatalError("Image uploading cannot be performed. %s" % err)
158

    
159
    if options.tmp is not None and not os.path.isdir(options.tmp):
160
        raise FatalError("The directory `%s' specified with --tmpdir is not "
161
                         "valid" % options.tmp)
162

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

    
173
    return options
174

    
175

    
176
def image_creator():
177
    options = parse_options(sys.argv[1:])
178

    
179
    if options.outfile is None and not options.upload and not \
180
            options.print_sysprep:
181
        raise FatalError("At least one of `-o', `-u' or `--print-sysprep' "
182
                         "must be set")
183

    
184
    if options.silent:
185
        out = SilentOutput()
186
    else:
187
        out = OutputWthProgress(True) if sys.stderr.isatty() else \
188
            SimpleOutput(False)
189

    
190
    title = 'snf-image-creator %s' % version
191
    out.output(title)
192
    out.output('=' * len(title))
193

    
194
    if os.geteuid() != 0:
195
        raise FatalError("You must run %s as root"
196
                         % os.path.basename(sys.argv[0]))
197

    
198
    if not options.force and options.outfile is not None:
199
        for extension in ('', '.meta', '.md5sum'):
200
            filename = "%s%s" % (options.outfile, extension)
201
            if os.path.exists(filename):
202
                raise FatalError("Output file `%s' exists "
203
                                 "(use --force to overwrite it)." % filename)
204

    
205
    # Check if the authentication info is valid. The earlier the better
206
    if options.token is not None and options.url is not None:
207
        try:
208
            account = Kamaki.create_account(options.url, options.token)
209
            if account is None:
210
                raise FatalError("The authentication token and/or URL you "
211
                                 "provided is not valid!")
212
            else:
213
                kamaki = Kamaki(account, out)
214
        except ClientError as e:
215
            raise FatalError("Astakos client: %d %s" % (e.status, e.message))
216
    elif options.cloud:
217
        avail_clouds = Kamaki.get_clouds()
218
        if options.cloud not in avail_clouds.keys():
219
            raise FatalError(
220
                "Cloud: `%s' does not exist.\n\nAvailable clouds:\n\n\t%s\n"
221
                % (options.cloud, "\n\t".join(avail_clouds.keys())))
222
        try:
223
            account = Kamaki.get_account(options.cloud)
224
            if account is None:
225
                raise FatalError(
226
                    "Cloud: `$s' exists but is not valid!" % options.cloud)
227
            else:
228
                kamaki = Kamaki(account, out)
229
        except ClientError as e:
230
            raise FatalError("Astakos client: %d %s" % (e.status, e.message))
231

    
232
    if options.upload and not options.force:
233
        if kamaki.object_exists(options.upload):
234
            raise FatalError("Remote storage service object: `%s' exists "
235
                             "(use --force to overwrite it)." % options.upload)
236
        if kamaki.object_exists("%s.md5sum" % options.upload):
237
            raise FatalError("Remote storage service object: `%s.md5sum' "
238
                             "exists (use --force to overwrite it)." %
239
                             options.upload)
240

    
241
    if options.register and not options.force:
242
        if kamaki.object_exists("%s.meta" % options.upload):
243
            raise FatalError("Remote storage service object `%s.meta' exists "
244
                             "(use --force to overwrite it)." % options.upload)
245

    
246
    disk = Disk(options.source, out, options.tmp)
247

    
248
    def signal_handler(signum, frame):
249
        disk.cleanup()
250

    
251
    signal.signal(signal.SIGINT, signal_handler)
252
    signal.signal(signal.SIGTERM, signal_handler)
253
    try:
254
        snapshot = disk.snapshot()
255

    
256
        image = disk.get_image(snapshot)
257

    
258
        for sysprep in options.disabled_syspreps:
259
            image.os.disable_sysprep(image.os.get_sysprep_by_name(sysprep))
260

    
261
        for sysprep in options.enabled_syspreps:
262
            image.os.enable_sysprep(image.os.get_sysprep_by_name(sysprep))
263

    
264
        if options.print_sysprep:
265
            image.os.print_syspreps()
266
            out.output()
267

    
268
        if options.outfile is None and not options.upload:
269
            return 0
270

    
271
        if options.sysprep:
272
            image.os.do_sysprep()
273

    
274
        metadata = image.os.meta
275

    
276
        size = options.shrink and image.shrink() or image.size
277
        metadata.update(image.meta)
278

    
279
        # Add command line metadata to the collected ones...
280
        metadata.update(options.metadata)
281

    
282
        md5 = MD5(out)
283
        checksum = md5.compute(image.device, size)
284

    
285
        metastring = unicode(json.dumps(
286
            {'properties': metadata,
287
             'disk-format': 'diskdump'}, ensure_ascii=False))
288

    
289
        if options.outfile is not None:
290
            image.dump(options.outfile)
291

    
292
            out.output('Dumping metadata file ...', False)
293
            with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
294
                f.write(metastring)
295
            out.success('done')
296

    
297
            out.output('Dumping md5sum file ...', False)
298
            with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
299
                f.write('%s %s\n' % (checksum,
300
                                     os.path.basename(options.outfile)))
301
            out.success('done')
302

    
303
        # Destroy the image instance. We only need the snapshot from now on
304
        disk.destroy_image(image)
305

    
306
        out.output()
307
        try:
308
            uploaded_obj = ""
309
            if options.upload:
310
                out.output("Uploading image to the storage service:")
311
                with open(snapshot, 'rb') as f:
312
                    uploaded_obj = kamaki.upload(
313
                        f, size, options.upload,
314
                        "(1/3)  Calculating block hashes",
315
                        "(2/3)  Uploading missing blocks")
316
                out.output("(3/3)  Uploading md5sum file ...", False)
317
                md5sumstr = '%s %s\n' % (checksum,
318
                                         os.path.basename(options.upload))
319
                kamaki.upload(StringIO.StringIO(md5sumstr),
320
                              size=len(md5sumstr),
321
                              remote_path="%s.%s" % (options.upload, 'md5sum'))
322
                out.success('done')
323
                out.output()
324

    
325
            if options.register:
326
                img_type = 'public' if options.public else 'private'
327
                out.output('Registering %s image with the compute service ...'
328
                           % img_type, False)
329
                result = kamaki.register(options.register, uploaded_obj,
330
                                         metadata, options.public)
331
                out.success('done')
332
                out.output("Uploading metadata file ...", False)
333
                metastring = unicode(json.dumps(result, ensure_ascii=False))
334
                kamaki.upload(StringIO.StringIO(metastring),
335
                              size=len(metastring),
336
                              remote_path="%s.%s" % (options.upload, 'meta'))
337
                out.success('done')
338
                if options.public:
339
                    out.output("Sharing md5sum file ...", False)
340
                    kamaki.share("%s.md5sum" % options.upload)
341
                    out.success('done')
342
                    out.output("Sharing metadata file ...", False)
343
                    kamaki.share("%s.meta" % options.upload)
344
                    out.success('done')
345

    
346
                out.output()
347
        except ClientError as e:
348
            raise FatalError("Service client: %d %s" % (e.status, e.message))
349

    
350
    finally:
351
        out.output('cleaning up ...')
352
        disk.cleanup()
353

    
354
    out.success("snf-image-creator exited without errors")
355

    
356
    return 0
357

    
358

    
359
def main():
360
    try:
361
        ret = image_creator()
362
        sys.exit(ret)
363
    except FatalError as e:
364
        colored = sys.stderr.isatty()
365
        SimpleOutput(colored).error(e)
366
        sys.exit(1)
367

    
368
if __name__ == '__main__':
369
    main()
370

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