root / image_creator / main.py @ cf5c6de5
History | View | Annotate | Download (11.7 kB)
1 |
#!/usr/bin/env python
|
---|---|
2 |
|
3 |
# Copyright 2012 GRNET S.A. All rights reserved.
|
4 |
#
|
5 |
# Redistribution and use in source and binary forms, with or
|
6 |
# without modification, are permitted provided that the following
|
7 |
# conditions are met:
|
8 |
#
|
9 |
# 1. Redistributions of source code must retain the above
|
10 |
# copyright notice, this list of conditions and the following
|
11 |
# disclaimer.
|
12 |
#
|
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.
|
17 |
#
|
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.
|
30 |
#
|
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.
|
35 |
|
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, \ |
41 |
OutputWthProgress
|
42 |
from image_creator.os_type import os_cls |
43 |
from image_creator.kamaki_wrapper import Kamaki, ClientError |
44 |
import sys |
45 |
import os |
46 |
import optparse |
47 |
import StringIO |
48 |
import signal |
49 |
|
50 |
|
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) |
56 |
|
57 |
if not name: |
58 |
raise FatalError("`%s' is not a valid file name" % dirname) |
59 |
|
60 |
setattr(parser.values, option.dest, value)
|
61 |
|
62 |
|
63 |
def parse_options(input_args): |
64 |
usage = "Usage: %prog [options] <input_media>"
|
65 |
parser = optparse.OptionParser(version=version, usage=usage) |
66 |
|
67 |
account = os.environ["OKEANOS_USER"] if "OKEANOS_USER" in os.environ \ |
68 |
else None |
69 |
token = os.environ["OKEANOS_TOKEN"] if "OKEANOS_TOKEN" in os.environ \ |
70 |
else None |
71 |
|
72 |
parser.add_option("-o", "--outfile", type="string", dest="outfile", |
73 |
default=None, action="callback", |
74 |
callback=check_writable_dir, help="dump image to FILE",
|
75 |
metavar="FILE")
|
76 |
|
77 |
parser.add_option("-f", "--force", dest="force", default=False, |
78 |
action="store_true",
|
79 |
help="overwrite output files if they exist")
|
80 |
|
81 |
parser.add_option("-s", "--silent", dest="silent", default=False, |
82 |
help="silent mode, only output errors",
|
83 |
action="store_true")
|
84 |
|
85 |
parser.add_option("-u", "--upload", dest="upload", type="string", |
86 |
default=False,
|
87 |
help="upload the image to pithos with name FILENAME",
|
88 |
metavar="FILENAME")
|
89 |
|
90 |
parser.add_option("-r", "--register", dest="register", type="string", |
91 |
default=False,
|
92 |
help="register the image with ~okeanos as IMAGENAME",
|
93 |
metavar="IMAGENAME")
|
94 |
|
95 |
parser.add_option("-a", "--account", dest="account", type="string", |
96 |
default=account, help="Use this ACCOUNT when "
|
97 |
"uploading/registering images [Default: %s]" % account)
|
98 |
|
99 |
parser.add_option("-m", "--metadata", dest="metadata", default=[], |
100 |
help="Add custom KEY=VALUE metadata to the image",
|
101 |
action="append", metavar="KEY=VALUE") |
102 |
|
103 |
parser.add_option("-t", "--token", dest="token", type="string", |
104 |
default=token, help="Use this token when "
|
105 |
"uploading/registering images [Default: %s]" % token)
|
106 |
|
107 |
parser.add_option("--print-sysprep", dest="print_sysprep", default=False, |
108 |
help="print the enabled and disabled system preparation "
|
109 |
"operations for this input media", action="store_true") |
110 |
|
111 |
parser.add_option("--enable-sysprep", dest="enabled_syspreps", default=[], |
112 |
help="run SYSPREP operation on the input media",
|
113 |
action="append", metavar="SYSPREP") |
114 |
|
115 |
parser.add_option("--disable-sysprep", dest="disabled_syspreps", |
116 |
help="prevent SYSPREP operation from running on the "
|
117 |
"input media", default=[], action="append", |
118 |
metavar="SYSPREP")
|
119 |
|
120 |
parser.add_option("--no-sysprep", dest="sysprep", default=True, |
121 |
help="don't perform system preparation",
|
122 |
action="store_false")
|
123 |
|
124 |
parser.add_option("--no-shrink", dest="shrink", default=True, |
125 |
help="don't shrink any partition", action="store_false") |
126 |
|
127 |
options, args = parser.parse_args(input_args) |
128 |
|
129 |
if len(args) != 1: |
130 |
parser.error('Wrong number of arguments')
|
131 |
|
132 |
options.source = args[0]
|
133 |
if not os.path.exists(options.source): |
134 |
raise FatalError("Input media `%s' is not accessible" % options.source) |
135 |
|
136 |
if options.register and not options.upload: |
137 |
raise FatalError("You also need to set -u when -r option is set") |
138 |
|
139 |
if options.upload and options.account is None: |
140 |
raise FatalError("Image uploading cannot be performed. No ~okeanos " |
141 |
"account name is specified. Use -a to set an account "
|
142 |
"name.")
|
143 |
|
144 |
if options.upload and options.token is None: |
145 |
raise FatalError("Image uploading cannot be performed. No ~okeanos " |
146 |
"token is specified. User -t to set a token.")
|
147 |
|
148 |
meta = {} |
149 |
for m in options.metadata: |
150 |
try:
|
151 |
key, value = m.split('=', 1) |
152 |
except ValueError: |
153 |
raise FatalError("Metadata option: `%s' is not in " |
154 |
"KEY=VALUE format." % m)
|
155 |
meta[key] = value |
156 |
options.metadata = meta |
157 |
|
158 |
return options
|
159 |
|
160 |
|
161 |
def image_creator(): |
162 |
options = parse_options(sys.argv[1:])
|
163 |
|
164 |
if options.outfile is None and not options.upload and not \ |
165 |
options.print_sysprep: |
166 |
raise FatalError("At least one of `-o', `-u' or `--print-sysprep' " |
167 |
"must be set")
|
168 |
|
169 |
if options.silent:
|
170 |
out = SilentOutput() |
171 |
else:
|
172 |
out = OutputWthProgress(True) if sys.stderr.isatty() else \ |
173 |
SimpleOutput(False)
|
174 |
|
175 |
title = 'snf-image-creator %s' % version
|
176 |
out.output(title) |
177 |
out.output('=' * len(title)) |
178 |
|
179 |
if os.geteuid() != 0: |
180 |
raise FatalError("You must run %s as root" |
181 |
% os.path.basename(sys.argv[0]))
|
182 |
|
183 |
if not options.force and options.outfile is not None: |
184 |
for extension in ('', '.meta', '.md5sum'): |
185 |
filename = "%s%s" % (options.outfile, extension)
|
186 |
if os.path.exists(filename):
|
187 |
raise FatalError("Output file %s exists " |
188 |
"(use --force to overwrite it)." % filename)
|
189 |
|
190 |
disk = Disk(options.source, out) |
191 |
|
192 |
def signal_handler(signum, frame): |
193 |
disk.cleanup() |
194 |
|
195 |
signal.signal(signal.SIGINT, signal_handler) |
196 |
signal.signal(signal.SIGTERM, signal_handler) |
197 |
try:
|
198 |
snapshot = disk.snapshot() |
199 |
|
200 |
dev = disk.get_device(snapshot) |
201 |
|
202 |
# If no customization is to be applied, the image should be mounted ro
|
203 |
readonly = (not (options.sysprep or options.shrink) or |
204 |
options.print_sysprep) |
205 |
dev.mount(readonly) |
206 |
|
207 |
cls = os_cls(dev.distro, dev.ostype) |
208 |
image_os = cls(dev.root, dev.g, out) |
209 |
out.output() |
210 |
|
211 |
for sysprep in options.disabled_syspreps: |
212 |
image_os.disable_sysprep(image_os.get_sysprep_by_name(sysprep)) |
213 |
|
214 |
for sysprep in options.enabled_syspreps: |
215 |
image_os.enable_sysprep(image_os.get_sysprep_by_name(sysprep)) |
216 |
|
217 |
if options.print_sysprep:
|
218 |
image_os.print_syspreps() |
219 |
out.output() |
220 |
|
221 |
if options.outfile is None and not options.upload: |
222 |
return 0 |
223 |
|
224 |
if options.sysprep:
|
225 |
image_os.do_sysprep() |
226 |
|
227 |
metadata = image_os.meta |
228 |
dev.umount() |
229 |
|
230 |
size = options.shrink and dev.shrink() or dev.size |
231 |
metadata.update(dev.meta) |
232 |
|
233 |
# Add command line metadata to the collected ones...
|
234 |
metadata.update(options.metadata) |
235 |
|
236 |
md5 = MD5(out) |
237 |
checksum = md5.compute(snapshot, size) |
238 |
|
239 |
metastring = '\n'.join(
|
240 |
['%s=%s' % (key, value) for (key, value) in metadata.items()]) |
241 |
metastring += '\n'
|
242 |
|
243 |
if options.outfile is not None: |
244 |
dev.dump(options.outfile) |
245 |
|
246 |
out.output('Dumping metadata file...', False) |
247 |
with open('%s.%s' % (options.outfile, 'meta'), 'w') as f: |
248 |
f.write(metastring) |
249 |
out.success('done')
|
250 |
|
251 |
out.output('Dumping md5sum file...', False) |
252 |
with open('%s.%s' % (options.outfile, 'md5sum'), 'w') as f: |
253 |
f.write('%s %s\n' % (checksum,
|
254 |
os.path.basename(options.outfile))) |
255 |
out.success('done')
|
256 |
|
257 |
# Destroy the device. We only need the snapshot from now on
|
258 |
disk.destroy_device(dev) |
259 |
|
260 |
out.output() |
261 |
try:
|
262 |
uploaded_obj = ""
|
263 |
if options.upload:
|
264 |
out.output("Uploading image to pithos:")
|
265 |
kamaki = Kamaki(options.account, options.token, out) |
266 |
with open(snapshot, 'rb') as f: |
267 |
uploaded_obj = kamaki.upload(f, size, options.upload, |
268 |
"(1/4) Calculating block "
|
269 |
"hashes",
|
270 |
"(2/4) Uploading missing "
|
271 |
"blocks")
|
272 |
|
273 |
out.output("(3/4) Uploading metadata file...", False) |
274 |
kamaki.upload(StringIO.StringIO(metastring), |
275 |
size=len(metastring),
|
276 |
remote_path="%s.%s" % (options.upload, 'meta')) |
277 |
out.success('done')
|
278 |
out.output("(4/4) Uploading md5sum file...", False) |
279 |
md5sumstr = '%s %s\n' % (checksum,
|
280 |
os.path.basename(options.upload)) |
281 |
kamaki.upload(StringIO.StringIO(md5sumstr), |
282 |
size=len(md5sumstr),
|
283 |
remote_path="%s.%s" % (options.upload, 'md5sum')) |
284 |
out.success('done')
|
285 |
out.output() |
286 |
|
287 |
if options.register:
|
288 |
out.output('Registering image with ~okeanos...', False) |
289 |
kamaki.register(options.register, uploaded_obj, metadata) |
290 |
out.success('done')
|
291 |
out.output() |
292 |
except ClientError as e: |
293 |
raise FatalError("Pithos client: %d %s" % (e.status, e.message)) |
294 |
|
295 |
finally:
|
296 |
out.output('cleaning up...')
|
297 |
disk.cleanup() |
298 |
|
299 |
out.success("snf-image-creator exited without errors")
|
300 |
|
301 |
return 0 |
302 |
|
303 |
|
304 |
def main(): |
305 |
try:
|
306 |
ret = image_creator() |
307 |
sys.exit(ret) |
308 |
except FatalError as e: |
309 |
colored = sys.stderr.isatty() |
310 |
SimpleOutput(colored).error(e) |
311 |
sys.exit(1)
|
312 |
|
313 |
if __name__ == '__main__': |
314 |
main() |
315 |
|
316 |
# vim: set sta sts=4 shiftwidth=4 sw=4 et ai :
|