3 # Copyright 2012 GRNET S.A. All rights reserved.
5 # Redistribution and use in source and binary forms, with or
6 # without modification, are permitted provided that the following
9 # 1. Redistributions of source code must retain the above
10 # copyright notice, this list of conditions and the following
13 # 2. Redistributions in binary form must reproduce the above
14 # copyright notice, this list of conditions and the following
15 # disclaimer in the documentation and/or other materials
16 # provided with the distribution.
18 # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
19 # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
22 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
25 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 # POSSIBILITY OF SUCH DAMAGE.
31 # The views and conclusions contained in the software and
32 # documentation are those of the authors and should not be
33 # interpreted as representing official policies, either expressed
34 # or implied, of GRNET S.A.
36 from image_creator import __version__ as version
37 from image_creator import util
38 from image_creator.disk import Disk
39 from image_creator.util import FatalError, MD5
40 from image_creator.output.cli import SilentOutput, SimpleOutput, \
42 from image_creator.os_type import os_cls
43 from image_creator.kamaki_wrapper import Kamaki, ClientError
51 def check_writable_dir(option, opt_str, value, parser):
52 dirname = os.path.dirname(value)
53 name = os.path.basename(value)
54 if dirname and not os.path.isdir(dirname):
55 raise FatalError("`%s' is not an existing directory" % dirname)
58 raise FatalError("`%s' is not a valid file name" % dirname)
60 setattr(parser.values, option.dest, value)
63 def parse_options(input_args):
64 usage = "Usage: %prog [options] <input_media>"
65 parser = optparse.OptionParser(version=version, usage=usage)
67 token = os.environ["OKEANOS_TOKEN"] if "OKEANOS_TOKEN" in os.environ \
70 parser.add_option("-o", "--outfile", type="string", dest="outfile",
71 default=None, action="callback",
72 callback=check_writable_dir, help="dump image to FILE",
75 parser.add_option("-f", "--force", dest="force", default=False,
77 help="overwrite output files if they exist")
79 parser.add_option("-s", "--silent", dest="silent", default=False,
80 help="output only errors",
83 parser.add_option("-u", "--upload", dest="upload", type="string",
85 help="upload the image to pithos with name FILENAME",
88 parser.add_option("-r", "--register", dest="register", type="string",
90 help="register the image with ~okeanos as IMAGENAME",
93 parser.add_option("-m", "--metadata", dest="metadata", default=[],
94 help="add custom KEY=VALUE metadata to the image",
95 action="append", metavar="KEY=VALUE")
97 parser.add_option("-t", "--token", dest="token", type="string",
98 default=token, help="use this authentication token when "
99 "uploading/registering images [Default: %s]" % token)
101 parser.add_option("--print-sysprep", dest="print_sysprep", default=False,
102 help="print the enabled and disabled system preparation "
103 "operations for this input media", action="store_true")
105 parser.add_option("--enable-sysprep", dest="enabled_syspreps", default=[],
106 help="run SYSPREP operation on the input media",
107 action="append", metavar="SYSPREP")
109 parser.add_option("--disable-sysprep", dest="disabled_syspreps",
110 help="prevent SYSPREP operation from running on the "
111 "input media", default=[], action="append",
114 parser.add_option("--no-sysprep", dest="sysprep", default=True,
115 help="don't perform any system preparation operation",
116 action="store_false")
118 parser.add_option("--no-shrink", dest="shrink", default=True,
119 help="don't shrink any partition", action="store_false")
121 parser.add_option("--public", dest="public", default=False,
122 help="register image with cyclades as public",
125 parser.add_option("--tmpdir", dest="tmp", type="string", default=None,
126 help="create large temporary image files under DIR",
129 options, args = parser.parse_args(input_args)
132 parser.error('Wrong number of arguments')
134 options.source = args[0]
135 if not os.path.exists(options.source):
136 raise FatalError("Input media `%s' is not accessible" % options.source)
138 if options.register and not options.upload:
139 raise FatalError("You also need to set -u when -r option is set")
141 if options.upload and options.token is None:
143 "Image uploading cannot be performed. "
144 "No authentication token is specified. Use -t to set a token")
146 if options.tmp is not None and not os.path.isdir(options.tmp):
147 raise FatalError("The directory `%s' specified with --tmpdir is not "
148 "valid" % options.tmp)
151 for m in options.metadata:
153 key, value = m.split('=', 1)
155 raise FatalError("Metadata option: `%s' is not in KEY=VALUE "
158 options.metadata = meta
164 options = parse_options(sys.argv[1:])
166 if options.outfile is None and not options.upload and not \
167 options.print_sysprep:
168 raise FatalError("At least one of `-o', `-u' or `--print-sysprep' "
174 out = OutputWthProgress(True) if sys.stderr.isatty() else \
177 title = 'snf-image-creator %s' % version
179 out.output('=' * len(title))
181 if os.geteuid() != 0:
182 raise FatalError("You must run %s as root"
183 % os.path.basename(sys.argv[0]))
185 if not options.force and options.outfile is not None:
186 for extension in ('', '.meta', '.md5sum'):
187 filename = "%s%s" % (options.outfile, extension)
188 if os.path.exists(filename):
189 raise FatalError("Output file %s exists "
190 "(use --force to overwrite it)" % filename)
192 # Check if the authentication token is valid. The earlier the better
194 account = Kamaki.get_account(options.token)
196 raise FatalError("The authentication token you provided is not "
198 except ClientError as e:
199 raise FatalError("Astakos client: %d %s" % (e.status, e.message))
201 disk = Disk(options.source, out, options.tmp)
203 def signal_handler(signum, frame):
206 signal.signal(signal.SIGINT, signal_handler)
207 signal.signal(signal.SIGTERM, signal_handler)
209 snapshot = disk.snapshot()
211 dev = disk.get_device(snapshot)
213 # If no customization is to be applied, the image should be mounted ro
214 readonly = (not (options.sysprep or options.shrink) or
215 options.print_sysprep)
218 cls = os_cls(dev.distro, dev.ostype)
219 image_os = cls(dev.root, dev.g, out)
222 for sysprep in options.disabled_syspreps:
223 image_os.disable_sysprep(image_os.get_sysprep_by_name(sysprep))
225 for sysprep in options.enabled_syspreps:
226 image_os.enable_sysprep(image_os.get_sysprep_by_name(sysprep))
228 if options.print_sysprep:
229 image_os.print_syspreps()
232 if options.outfile is None and not options.upload:
236 image_os.do_sysprep()
238 metadata = image_os.meta
241 size = options.shrink and dev.shrink() or dev.size
242 metadata.update(dev.meta)
244 # Add command line metadata to the collected ones...
245 metadata.update(options.metadata)
248 checksum = md5.compute(snapshot, size)
250 metastring = '\n'.join(
251 ['%s=%s' % (key, value) for (key, value) in metadata.items()])
254 if options.outfile is not None:
255 dev.dump(options.outfile)
257 out.output('Dumping metadata file ...', False)
258 with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
262 out.output('Dumping md5sum file ...', False)
263 with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
264 f.write('%s %s\n' % (checksum,
265 os.path.basename(options.outfile)))
268 # Destroy the device. We only need the snapshot from now on
269 disk.destroy_device(dev)
275 out.output("Uploading image to pithos:")
276 kamaki = Kamaki(account, out)
277 with open(snapshot, 'rb') as f:
278 uploaded_obj = kamaki.upload(
279 f, size, options.upload,
280 "(1/4) Calculating block hashes",
281 "(2/4) Uploading missing blocks")
283 out.output("(3/4) Uploading metadata file ...", False)
284 kamaki.upload(StringIO.StringIO(metastring),
285 size=len(metastring),
286 remote_path="%s.%s" % (options.upload, 'meta'))
288 out.output("(4/4) Uploading md5sum file ...", False)
289 md5sumstr = '%s %s\n' % (checksum,
290 os.path.basename(options.upload))
291 kamaki.upload(StringIO.StringIO(md5sumstr),
293 remote_path="%s.%s" % (options.upload, 'md5sum'))
298 img_type = 'public' if options.public else 'private'
299 out.output('Registering %s image with ~okeanos ...' % img_type,
301 kamaki.register(options.register, uploaded_obj, metadata,
305 except ClientError as e:
306 raise FatalError("Pithos client: %d %s" % (e.status, e.message))
309 out.output('cleaning up ...')
312 out.success("snf-image-creator exited without errors")
319 ret = image_creator()
321 except FatalError as e:
322 colored = sys.stderr.isatty()
323 SimpleOutput(colored).error(e)
326 if __name__ == '__main__':
329 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :