3 # Copyright 2011 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 get_command, FatalError, MD5
40 from image_creator.output import Output, Output_with_progress, Silent, error
41 from image_creator.os_type import get_os_class
42 from image_creator.kamaki_wrapper import Kamaki
49 def check_writable_dir(option, opt_str, value, parser):
50 dirname = os.path.dirname(value)
51 name = os.path.basename(value)
52 if dirname and not os.path.isdir(dirname):
53 raise FatalError("`%s' is not an existing directory" % dirname)
56 raise FatalError("`%s' is not a valid file name" % dirname)
58 setattr(parser.values, option.dest, value)
61 def parse_options(input_args):
62 usage = "Usage: %prog [options] <input_media>"
63 parser = optparse.OptionParser(version=version, usage=usage)
65 account = os.environ["OKEANOS_USER"] if "OKEANOS_USER" in os.environ \
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", callback=check_writable_dir,
72 help="dump image to FILE", metavar="FILE")
74 parser.add_option("-f", "--force", dest="force", default=False,
75 action="store_true", help="overwrite output files if they exist")
77 parser.add_option("-s", "--silent", dest="silent", default=False,
78 help="silent mode, only output errors", action="store_true")
80 parser.add_option("-u", "--upload", dest="upload", type="string",
81 default=False, help="upload the image to pithos with name FILENAME",
84 parser.add_option("-r", "--register", dest="register", type="string",
85 default=False, help="register the image to ~okeanos as IMAGENAME",
88 parser.add_option("-a", "--account", dest="account", type="string",
90 help="Use this ACCOUNT when uploading/registring images [Default: %s]"\
93 parser.add_option("-m", "--metadata", dest="metadata", default=[],
94 help="Add custom KEY=VALUE metadata to the image", action="append",
97 parser.add_option("-t", "--token", dest="token", type="string",
99 help="Use this token when uploading/registring images [Default: %s]"\
102 parser.add_option("--print-sysprep", dest="print_sysprep", default=False,
103 help="print the enabled and disabled system preparation operations "
104 "for this input media", action="store_true")
106 parser.add_option("--enable-sysprep", dest="enabled_syspreps", default=[],
107 help="run SYSPREP operation on the input media",
108 action="append", metavar="SYSPREP")
110 parser.add_option("--disable-sysprep", dest="disabled_syspreps",
111 help="prevent SYSPREP operation from running on the input media",
112 default=[], action="append", metavar="SYSPREP")
114 parser.add_option("--no-sysprep", dest="sysprep", default=True,
115 help="don't perform system preperation", action="store_false")
117 parser.add_option("--no-shrink", dest="shrink", default=True,
118 help="don't shrink any partition", action="store_false")
120 options, args = parser.parse_args(input_args)
123 parser.error('Wrong number of arguments')
125 options.source = args[0]
126 if not os.path.exists(options.source):
127 raise FatalError("Input media `%s' is not accessible" % options.source)
129 if options.register and options.upload == False:
130 raise FatalError("You also need to set -u when -r option is set")
132 if options.upload and options.account is None:
133 raise FatalError("Image uploading cannot be performed. No ~okeanos "
134 "account name is specified. Use -a to set an account name.")
136 if options.upload and options.token is None:
137 raise FatalError("Image uploading cannot be performed. No ~okeanos "
138 "token is specified. User -t to set a token.")
141 for m in options.metadata:
143 key, value = m.split('=', 1)
145 raise FatalError("Metadata option: `%s' is not in "\
146 "KEY=VALUE format." % m)
148 options.metadata = meta
154 options = parse_options(sys.argv[1:])
156 if options.outfile is None and not options.upload \
157 and not options.print_sysprep:
158 raise FatalError("At least one of `-o', `-u' or `--print-sysprep' " \
164 out = Output_with_progress()
166 title = 'snf-image-creator %s' % version
168 out.output('=' * len(title))
170 if os.geteuid() != 0:
171 raise FatalError("You must run %s as root" \
172 % os.path.basename(sys.argv[0]))
174 if not options.force and options.outfile is not None:
175 for extension in ('', '.meta', '.md5sum'):
176 filename = "%s%s" % (options.outfile, extension)
177 if os.path.exists(filename):
178 raise FatalError("Output file %s exists "
179 "(use --force to overwrite it)." % filename)
181 disk = Disk(options.source, out)
183 snapshot = disk.snapshot()
185 dev = disk.get_device(snapshot)
188 osclass = get_os_class(dev.distro, dev.ostype)
189 image_os = osclass(dev.root, dev.g, out)
192 for sysprep in options.disabled_syspreps:
193 image_os.disable_sysprep(sysprep)
195 for sysprep in options.enabled_syspreps:
196 image_os.enable_sysprep(sysprep)
198 if options.print_sysprep:
199 image_os.print_syspreps()
202 if options.outfile is None and not options.upload:
206 image_os.do_sysprep()
208 metadata = image_os.meta
211 size = options.shrink and dev.shrink() or dev.meta['SIZE']
212 metadata.update(dev.meta)
214 # Add command line metadata to the collected ones...
215 metadata.update(options.metadata)
218 checksum = md5.compute(snapshot, size)
220 metastring = '\n'.join(
221 ['%s=%s' % (key, value) for (key, value) in metadata.items()])
224 if options.outfile is not None:
225 dev.dump(options.outfile)
227 out.output('Dumping metadata file...', False)
228 with open('%s.%s' % (options.outfile, 'meta'), 'w') as f:
232 out.output('Dumping md5sum file...', False)
233 with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f:
234 f.write('%s %s\n' % (checksum, \
235 os.path.basename(options.outfile)))
238 # Destroy the device. We only need the snapshot from now on
239 disk.destroy_device(dev)
245 out.output("Uploading image to pithos:")
246 kamaki = Kamaki(options.account, options.token, out)
247 with open(snapshot) as f:
248 uploaded_obj = kamaki.upload(f, size, options.upload,
249 "(1/4) Calculating block hashes",
250 "(2/4) Uploading missing blocks")
252 out.output("(3/4) Uploading metadata file...", False)
253 kamaki.upload(StringIO.StringIO(metastring), size=len(metastring),
254 remote_path="%s.%s" % (options.upload, 'meta'))
256 out.output("(4/4) Uploading md5sum file...", False)
257 md5sumstr = '%s %s\n' % (
258 checksum, os.path.basename(options.upload))
259 kamaki.upload(StringIO.StringIO(md5sumstr), size=len(md5sumstr),
260 remote_path="%s.%s" % (options.upload, 'md5sum'))
265 out.output('Registring image to ~okeanos...', False)
266 kamaki.register(options.register, uploaded_obj, metadata)
271 out.output('cleaning up...')
274 out.success("snf-image-creator exited without errors")
281 ret = image_creator()
283 except FatalError as e:
288 if __name__ == '__main__':
291 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :