1 # -*- coding: utf-8 -*-
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 """This module implements the "expert" mode of the dialog-based version of
45 from image_creator import __version__ as version
46 from image_creator.util import MD5, FatalError
47 from image_creator.output.dialog import GaugeOutput, InfoBoxOutput
48 from image_creator.kamaki_wrapper import Kamaki, ClientError
49 from image_creator.help import get_help_file
50 from image_creator.dialog_util import SMALL_WIDTH, WIDTH, \
51 update_background_title, confirm_reset, confirm_exit, Reset, \
52 extract_image, extract_metadata_string, add_cloud, edit_cloud
54 CONFIGURATION_TASKS = [
55 ("Partition table manipulation", ["FixPartitionTable"],
56 ["linux", "windows"]),
57 ("File system resize",
58 ["FilesystemResizeUnmounted", "FilesystemResizeMounted"],
59 ["linux", "windows"]),
60 ("Swap partition configuration", ["AddSwap"], ["linux"]),
61 ("SSH keys removal", ["DeleteSSHKeys"], ["linux"]),
62 ("Temporal RDP disabling", ["DisableRemoteDesktopConnections"],
64 ("SELinux relabeling at next boot", ["SELinuxAutorelabel"], ["linux"]),
65 ("Hostname/Computer Name assignment", ["AssignHostname"],
66 ["windows", "linux"]),
67 ("Password change", ["ChangePassword"], ["windows", "linux"]),
68 ("File injection", ["EnforcePersonality"], ["windows", "linux"])
72 class MetadataMonitor(object):
73 """Monitors image metadata chages"""
74 def __init__(self, session, meta):
75 self.session = session
80 for (k, v) in self.meta.items():
83 def __exit__(self, type, value, traceback):
84 d = self.session['dialog']
89 for (k, v) in self.meta.items():
92 elif self.old[k] != v:
95 if not (len(added) or len(altered)):
98 msg = "The last action has changed some image properties:\n\n"
100 msg += "New image properties:\n"
101 for (k, v) in added.items():
102 msg += ' %s: "%s"\n' % (k, v)
105 msg += "Updated image properties:\n"
106 for (k, v) in altered.items():
107 msg += ' %s: "%s" -> "%s"\n' % (k, self.old[k], v)
110 self.session['metadata'].update(added)
111 self.session['metadata'].update(altered)
112 d.msgbox(msg, title="Image Property Changes", width=SMALL_WIDTH)
115 def upload_image(session):
116 """Upload the image to the storage service"""
117 d = session["dialog"]
118 image = session['image']
119 meta = session['metadata']
122 if "account" not in session:
123 d.msgbox("You need to select a valid cloud before you can upload "
124 "images to it", width=SMALL_WIDTH)
128 if 'upload' in session:
129 init = session['upload']
131 init = "%s.diskdump" % meta['OS']
134 (code, answer) = d.inputbox("Please provide a filename:", init=init,
137 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
140 filename = answer.strip()
141 if len(filename) == 0:
142 d.msgbox("Filename cannot be empty", width=SMALL_WIDTH)
145 kamaki = Kamaki(session['account'], None)
147 for f in (filename, "%s.md5sum" % filename, "%s.meta" % filename):
148 if kamaki.object_exists(f):
151 if len(overwrite) > 0:
152 if d.yesno("The following storage service object(s) already "
153 "exist(s):\n%s\nDo you want to overwrite them?" %
154 "\n".join(overwrite), width=WIDTH, defaultno=1):
157 session['upload'] = filename
160 gauge = GaugeOutput(d, "Image Upload", "Uploading ...")
166 if 'checksum' not in session:
168 session['checksum'] = md5.compute(image.device, size)
172 with open(image.device, 'rb') as f:
173 session["pithos_uri"] = \
174 kamaki.upload(f, size, filename,
175 "Calculating block hashes",
176 "Uploading missing blocks")
178 out.output("Uploading md5sum file ...")
179 md5str = "%s %s\n" % (session['checksum'], filename)
180 kamaki.upload(StringIO.StringIO(md5str), size=len(md5str),
181 remote_path="%s.md5sum" % filename)
184 except ClientError as e:
186 "Error in storage service client: %s" % e.message,
187 title="Storage Service Client Error", width=SMALL_WIDTH)
188 if 'pithos_uri' in session:
189 del session['pithos_uri']
196 d.msgbox("Image file `%s' was successfully uploaded" % filename,
202 def register_image(session):
203 """Register image with the compute service"""
204 d = session["dialog"]
208 if "account" not in session:
209 d.msgbox("You need to select a valid cloud before you "
210 "can register an images with it", width=SMALL_WIDTH)
213 if "pithos_uri" not in session:
214 d.msgbox("You need to upload the image to the cloud before you can "
215 "register it", width=SMALL_WIDTH)
219 (code, answer) = d.inputbox("Please provide a registration name:",
221 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
224 name = answer.strip()
226 d.msgbox("Registration name cannot be empty", width=SMALL_WIDTH)
229 ret = d.yesno("Make the image public?\\nA public image is accessible "
230 "by every user of the service.", defaultno=1,
232 if ret not in (0, 1):
235 is_public = True if ret == 0 else False
240 metadata.update(session['metadata'])
241 if 'task_metadata' in session:
242 for key in session['task_metadata']:
243 metadata[key] = 'yes'
245 img_type = "public" if is_public else "private"
246 gauge = GaugeOutput(d, "Image Registration", "Registering image ...")
248 out = session['image'].out
252 out.output("Registering %s image with the cloud ..." %
254 kamaki = Kamaki(session['account'], out)
255 result = kamaki.register(name, session['pithos_uri'], metadata,
258 # Upload metadata file
259 out.output("Uploading metadata file ...")
260 metastring = unicode(json.dumps(result, ensure_ascii=False))
261 kamaki.upload(StringIO.StringIO(metastring),
262 size=len(metastring),
263 remote_path="%s.meta" % session['upload'])
266 out.output("Sharing metadata and md5sum files ...")
267 kamaki.share("%s.meta" % session['upload'])
268 kamaki.share("%s.md5sum" % session['upload'])
270 except ClientError as e:
271 d.msgbox("Error in storage service client: %s" % e.message)
278 d.msgbox("%s image `%s' was successfully registered with the cloud as `%s'"
279 % (img_type.title(), session['upload'], name), width=SMALL_WIDTH)
283 def modify_clouds(session):
284 """Modify existing cloud accounts"""
285 d = session['dialog']
288 clouds = Kamaki.get_clouds()
290 if not add_cloud(session):
295 for (name, cloud) in clouds.items():
296 descr = cloud['description'] if 'description' in cloud else ''
297 choices.append((name, descr))
299 (code, choice) = d.menu(
300 "In this menu you can edit existing cloud accounts or add new "
301 " ones. Press <Edit> to edit an existing account or <Add> to add "
302 " a new one. Press <Back> or hit <ESC> when done.", height=18,
303 width=WIDTH, choices=choices, menu_height=10, ok_label="Edit",
304 extra_button=1, extra_label="Add", cancel="Back", help_button=1,
307 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
309 elif code == d.DIALOG_OK: # Edit button
310 edit_cloud(session, choice)
311 elif code == d.DIALOG_EXTRA: # Add button
315 def delete_clouds(session):
316 """Delete existing cloud accounts"""
317 d = session['dialog']
320 for (name, cloud) in Kamaki.get_clouds().items():
321 descr = cloud['description'] if 'description' in cloud else ''
322 choices.append((name, descr, 0))
324 if len(choices) == 0:
325 d.msgbox("No available clouds to delete!", width=SMALL_WIDTH)
328 (code, to_delete) = d.checklist("Choose which cloud accounts to delete:",
329 choices=choices, width=WIDTH)
331 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
334 if not len(to_delete):
335 d.msgbox("Nothing selected!", width=SMALL_WIDTH)
338 if not d.yesno("Are you sure you want to remove the selected cloud "
339 "accounts?", width=WIDTH, defaultno=1):
341 Kamaki.remove_cloud(i)
342 if 'cloud' in session and session['cloud'] == i:
344 if 'account' in session:
345 del session['account']
349 d.msgbox("%d cloud accounts were deleted." % len(to_delete),
354 def kamaki_menu(session):
355 """Show kamaki related actions"""
356 d = session['dialog']
357 default_item = "Cloud"
359 if 'cloud' not in session:
360 cloud = Kamaki.get_default_cloud_name()
362 session['cloud'] = cloud
363 session['account'] = Kamaki.get_account(cloud)
364 if not session['account']:
365 del session['account']
367 default_item = "Add/Edit"
370 cloud = session["cloud"] if "cloud" in session else "<none>"
371 if 'account' not in session and 'cloud' in session:
372 cloud += " <invalid>"
374 upload = session["upload"] if "upload" in session else "<none>"
376 choices = [("Add/Edit", "Add/Edit cloud accounts"),
377 ("Delete", "Delete existing cloud accounts"),
378 ("Cloud", "Select cloud account to use: %s" % cloud),
379 ("Upload", "Upload image to the cloud"),
380 ("Register", "Register image with the cloud: %s" % upload)]
382 (code, choice) = d.menu(
383 text="Choose one of the following or press <Back> to go back.",
384 width=WIDTH, choices=choices, cancel="Back", height=13,
385 menu_height=5, default_item=default_item,
386 title="Image Registration Menu")
388 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
391 if choice == "Add/Edit":
392 if modify_clouds(session):
393 default_item = "Cloud"
394 elif choice == "Delete":
395 if delete_clouds(session):
396 if len(Kamaki.get_clouds()):
397 default_item = "Cloud"
399 default_time = "Add/Edit"
401 default_time = "Delete"
402 elif choice == "Cloud":
403 default_item = "Cloud"
404 clouds = Kamaki.get_clouds()
406 d.msgbox("No clouds available. Please add a new cloud!",
408 default_item = "Add/Edit"
411 if 'cloud' not in session:
412 session['cloud'] = clouds.keys()[0]
415 for name, info in clouds.items():
416 default = 1 if session['cloud'] == name else 0
417 descr = info['description'] if 'description' in info else ""
418 choices.append((name, descr, default))
420 (code, answer) = d.radiolist("Please select a cloud:",
421 width=WIDTH, choices=choices)
422 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
425 session['account'] = Kamaki.get_account(answer)
427 if session['account'] is None: # invalid account
428 if not d.yesno("The cloud %s' is not valid! Would you "
429 "like to edit it?" % answer, width=WIDTH):
430 if edit_cloud(session, answer):
431 session['account'] = Kamaki.get_account(answer)
432 Kamaki.set_default_cloud(answer)
434 if session['account'] is not None:
435 session['cloud'] = answer
436 Kamaki.set_default_cloud(answer)
437 default_item = "Upload"
439 del session['account']
441 elif choice == "Upload":
442 if upload_image(session):
443 default_item = "Register"
445 default_item = "Upload"
446 elif choice == "Register":
447 if register_image(session):
450 default_item = "Register"
453 def add_property(session):
454 """Add a new property to the image"""
455 d = session['dialog']
458 (code, answer) = d.inputbox("Please provide a name for a new image"
459 " property:", width=WIDTH)
460 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
463 name = answer.strip()
465 d.msgbox("A property name cannot be empty", width=SMALL_WIDTH)
471 (code, answer) = d.inputbox("Please provide a value for image "
472 "property %s" % name, width=WIDTH)
473 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
476 value = answer.strip()
478 d.msgbox("Value cannot be empty", width=SMALL_WIDTH)
483 session['metadata'][name] = value
488 def modify_properties(session):
489 """Modify an existing image property"""
490 d = session['dialog']
494 for (key, val) in session['metadata'].items():
495 choices.append((str(key), str(val)))
497 (code, choice) = d.menu(
498 "In this menu you can edit existing image properties or add new "
499 "ones. Be careful! Most properties have special meaning and "
500 "alter the image deployment behaviour. Press <HELP> to see more "
501 "information about image properties. Press <BACK> when done.",
502 height=18, width=WIDTH, choices=choices, menu_height=10,
503 ok_label="Edit", extra_button=1, extra_label="Add", cancel="Back",
504 help_button=1, title="Image Properties")
506 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
509 elif code == d.DIALOG_OK:
510 (code, answer) = d.inputbox("Please provide a new value for the "
511 "image property with name `%s':" %
513 init=session['metadata'][choice],
515 if code not in (d.DIALOG_CANCEL, d.DIALOG_ESC):
516 value = answer.strip()
518 d.msgbox("Value cannot be empty!")
521 session['metadata'][choice] = value
523 elif code == d.DIALOG_EXTRA:
524 add_property(session)
526 help_file = get_help_file("image_properties")
527 assert os.path.exists(help_file)
528 d.textbox(help_file, title="Image Properties", width=70, height=40)
531 def delete_properties(session):
532 """Delete an image property"""
533 d = session['dialog']
536 for (key, val) in session['metadata'].items():
537 choices.append((key, "%s" % val, 0))
539 (code, to_delete) = d.checklist("Choose which properties to delete:",
540 choices=choices, width=WIDTH)
542 # If the user exits with ESC or CANCEL, the returned tag list is empty.
544 del session['metadata'][i]
548 d.msgbox("%d image properties were deleted." % cnt, width=SMALL_WIDTH)
554 def exclude_tasks(session):
555 """Exclude specific tasks from running during image deployment"""
556 d = session['dialog']
562 if 'excluded_tasks' not in session:
563 session['excluded_tasks'] = []
565 if -1 in session['excluded_tasks']:
566 if not d.yesno("Image deployment configuration is disabled. "
567 "Do you wish to enable it?", width=SMALL_WIDTH):
568 session['excluded_tasks'].remove(-1)
572 for (msg, task, osfamily) in CONFIGURATION_TASKS:
573 if session['metadata']['OSFAMILY'] in osfamily:
574 checked = 1 if index in session['excluded_tasks'] else 0
575 choices.append((str(displayed_index), msg, checked))
576 mapping[displayed_index] = index
581 (code, tags) = d.checklist(
582 text="Please choose which configuration tasks you would like to "
583 "prevent from running during image deployment. "
584 "Press <No Config> to supress any configuration. "
585 "Press <Help> for more help on the image deployment "
586 "configuration tasks.",
587 choices=choices, height=19, list_height=8, width=WIDTH,
588 help_button=1, extra_button=1, extra_label="No Config",
589 title="Exclude Configuration Tasks")
591 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
593 elif code == d.DIALOG_HELP:
594 help_file = get_help_file("configuration_tasks")
595 assert os.path.exists(help_file)
596 d.textbox(help_file, title="Configuration Tasks",
599 elif code == d.DIALOG_EXTRA:
600 session['excluded_tasks'] = [-1]
601 session['task_metadata'] = ["EXCLUDE_ALL_TASKS"]
603 elif code == d.DIALOG_OK:
604 session['excluded_tasks'] = []
606 session['excluded_tasks'].append(mapping[int(tag)])
608 exclude_metadata = []
609 for task in session['excluded_tasks']:
610 exclude_metadata.extend(CONFIGURATION_TASKS[task][1])
612 session['task_metadata'] = map(lambda x: "EXCLUDE_TASK_%s" % x,
619 def sysprep(session):
620 """Perform various system preperation tasks on the image"""
621 d = session['dialog']
622 image = session['image']
624 # Is the image already shrinked?
625 if 'shrinked' in session and session['shrinked']:
626 msg = "It seems you have shrinked the image. Running system " \
627 "preparation tasks on a shrinked image is dangerous."
629 if d.yesno("%s\n\nDo you really want to continue?" % msg,
630 width=SMALL_WIDTH, defaultno=1):
633 wrapper = textwrap.TextWrapper(width=WIDTH - 5)
635 syspreps = image.os.list_syspreps()
637 if len(syspreps) == 0:
638 d.msgbox("No system preparation task available to run!",
639 title="System Preperation", width=SMALL_WIDTH)
646 help_title = "System Preperation Tasks"
647 sysprep_help = "%s\n%s\n\n" % (help_title, '=' * len(help_title))
649 for sysprep in syspreps:
650 name, descr = image.os.sysprep_info(sysprep)
651 display_name = name.replace('-', ' ').capitalize()
652 sysprep_help += "%s\n" % display_name
653 sysprep_help += "%s\n" % ('-' * len(display_name))
654 sysprep_help += "%s\n\n" % wrapper.fill(" ".join(descr.split()))
655 enabled = 1 if sysprep.enabled else 0
656 choices.append((str(index + 1), display_name, enabled))
659 (code, tags) = d.checklist(
660 "Please choose which system preparation tasks you would like to "
661 "run on the image. Press <Help> to see details about the system "
662 "preparation tasks.", title="Run system preparation tasks",
663 choices=choices, width=70, ok_label="Run", help_button=1)
665 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
667 elif code == d.DIALOG_HELP:
668 d.scrollbox(sysprep_help, width=WIDTH)
669 elif code == d.DIALOG_OK:
670 # Enable selected syspreps and disable the rest
671 for i in range(len(syspreps)):
672 if str(i + 1) in tags:
673 image.os.enable_sysprep(syspreps[i])
675 image.os.disable_sysprep(syspreps[i])
677 if len([s for s in image.os.list_syspreps() if s.enabled]) == 0:
678 d.msgbox("No system preperation task is selected!",
679 title="System Preperation", width=SMALL_WIDTH)
682 infobox = InfoBoxOutput(d, "Image Configuration")
684 image.out.add(infobox)
686 # The checksum is invalid. We have mounted the image rw
687 if 'checksum' in session:
688 del session['checksum']
690 # Monitor the metadata changes during syspreps
691 with MetadataMonitor(session, image.os.meta):
693 image.os.do_sysprep()
695 except FatalError as e:
696 title = "System Preparation"
697 d.msgbox("System Preparation failed: %s" % e,
698 title=title, width=SMALL_WIDTH)
700 image.out.remove(infobox)
708 """Shrink the image"""
709 d = session['dialog']
710 image = session['image']
712 shrinked = 'shrinked' in session and session['shrinked']
715 d.msgbox("The image is already shrinked!", title="Image Shrinking",
719 msg = "This operation will shrink the last partition of the image to " \
720 "reduce the total image size. If the last partition is a swap " \
721 "partition, then this partition is removed and the partition " \
722 "before that is shrinked. The removed swap partition will be " \
723 "recreated during image deployment."
725 if not d.yesno("%s\n\nDo you want to continue?" % msg, width=WIDTH,
726 height=12, title="Image Shrinking"):
727 with MetadataMonitor(session, image.meta):
728 infobox = InfoBoxOutput(d, "Image Shrinking", height=4)
729 image.out.add(infobox)
734 image.out.remove(infobox)
736 session['shrinked'] = True
737 update_background_title(session)
744 def customization_menu(session):
745 """Show image customization menu"""
746 d = session['dialog']
748 choices = [("Sysprep", "Run various image preparation tasks"),
749 ("Shrink", "Shrink image"),
750 ("View/Modify", "View/Modify image properties"),
751 ("Delete", "Delete image properties"),
752 ("Exclude", "Exclude various deployment tasks from running")]
756 actions = {"Sysprep": sysprep,
758 "View/Modify": modify_properties,
759 "Delete": delete_properties,
760 "Exclude": exclude_tasks}
762 (code, choice) = d.menu(
763 text="Choose one of the following or press <Back> to exit.",
764 width=WIDTH, choices=choices, cancel="Back", height=13,
765 menu_height=len(choices), default_item=choices[default_item][0],
766 title="Image Customization Menu")
768 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
770 elif choice in actions:
771 default_item = [entry[0] for entry in choices].index(choice)
772 if actions[choice](session):
773 default_item = (default_item + 1) % len(choices)
776 def main_menu(session):
777 """Show the main menu of the program"""
778 d = session['dialog']
780 update_background_title(session)
782 choices = [("Customize", "Customize image & cloud deployment options"),
783 ("Register", "Register image to a cloud"),
784 ("Extract", "Dump image to local file system"),
785 ("Reset", "Reset everything and start over again"),
786 ("Help", "Get help for using snf-image-creator")]
788 default_item = "Customize"
790 actions = {"Customize": customization_menu, "Register": kamaki_menu,
791 "Extract": extract_image}
793 (code, choice) = d.menu(
794 text="Choose one of the following or press <Exit> to exit.",
795 width=WIDTH, choices=choices, cancel="Exit", height=13,
796 default_item=default_item, menu_height=len(choices),
797 title="Image Creator for synnefo (snf-image-creator version %s)" %
800 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
803 elif choice == "Reset":
805 d.infobox("Resetting snf-image-creator. Please wait ...",
808 elif choice == "Help":
809 d.msgbox("For help, check the online documentation:\n\nhttp://www"
810 ".synnefo.org/docs/snf-image-creator/latest/",
811 width=WIDTH, title="Help")
812 elif choice in actions:
813 actions[choice](session)
815 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :