from image_creator import __version__ as version
from image_creator.util import FatalError, MD5
-from image_creator.output.dialog import InitializationOutput, GaugeOutput
+from image_creator.output.dialog import GaugeOutput, InfoBoxOutput
from image_creator.disk import Disk
from image_creator.os_type import os_cls
from image_creator.kamaki_wrapper import Kamaki, ClientError
+from image_creator.help import get_help_file
MSGBOX_WIDTH = 60
YESNO_WIDTH = 50
MENU_WIDTH = 70
INPUTBOX_WIDTH = 70
-
-CONFIGURATION_TASKS = {
- "FixPartitionTable":
- "Enlarge last partition to use all the available space",
- "FilesystemResizeUnmounted":
- "Resize file system to use all the available space",
- "AddSwap": "Set up the swap partition and add an entry in fstab",
- "DeleteSSHKeys": "Remove ssh keys and in some cases recreate them",
- "DisableRemoteDesktopConnections":
- "Temporary Disable Remote Desktop Connections",
- "40SELinuxAutorelabel": "Force the system to relabel at next boot",
- "AssignHostname": "Assign Hostname/Computer Name to the instance",
- "ChangePassword": "Changes Password for specified users",
- "EnforcePersonality": "Inject files to the instance",
- "FilesystemResizeMounted":
- "Resize filesystem to use all the available space"}
+CHECKBOX_WIDTH = 70
+HELP_WIDTH = 70
+INFOBOX_WIDTH = 70
+
+CONFIGURATION_TASKS = [
+ ("Partition table manipulation", ["FixPartitionTable"],
+ ["linux", "windows"]),
+ ("File system resize",
+ ["FilesystemResizeUnmounted", "FilesystemResizeMounted"],
+ ["linux", "windows"]),
+ ("Swap partition configuration", ["AddSwap"], ["linux"]),
+ ("SSH keys removal", ["DeleteSSHKeys"], ["linux"]),
+ ("Temporal RDP disabling", ["DisableRemoteDesktopConnections"], ["windows"]),
+ ("SELinux relabeling at next boot", ["SELinuxAutorelabel"],
+ ["linux"]),
+ ("Hostname/Computer Name assignment", ["AssignHostname"],
+ ["windows", "linux"]),
+ ("Password change", ["ChangePassword"], ["windows", "linux"]),
+ ("File injection", ["EnforcePersonality"], ["windows", "linux"])
+]
class Reset(Exception):
pass
+class metadata_monitor(object):
+ def __init__(self, session, meta):
+ self.session = session
+ self.meta = meta
+
+ def __enter__(self):
+ self.old = {}
+ for (k, v) in self.meta.items():
+ self.old[k] = v
+
+ def __exit__(self, type, value, traceback):
+ d = self.session['dialog']
+
+ altered = {}
+ added = {}
+
+ for (k, v) in self.meta.items():
+ if k not in self.old:
+ added[k] = v
+ elif self.old[k] != v:
+ altered[k] = v
+
+ if not (len(added) or len(altered)):
+ return
+
+ msg = "The last action has changed some image properties:\n\n"
+ if len(added):
+ msg += "New image properties:\n"
+ for (k, v) in added.items():
+ msg += ' %s: "%s"\n' % (k, v)
+ msg += "\n"
+ if len(altered):
+ msg += "Updated image properties:\n"
+ for (k, v) in altered.items():
+ msg += ' %s: "%s" -> "%s"\n' % (k, self.old[k], v)
+ msg += "\n"
+
+ self.session['metadata'].update(added)
+ self.session['metadata'].update(altered)
+ d.msgbox(msg, title="Image Property Changes", width=MSGBOX_WIDTH)
+
+
def confirm_exit(d, msg=''):
return not d.yesno("%s Do you want to exit?" % msg, width=YESNO_WIDTH)
def confirm_reset(d):
- return not d.yesno(
- "Are you sure you want to reset everything?",
- width=YESNO_WIDTH)
+ return not d.yesno("Are you sure you want to reset everything?",
+ width=YESNO_WIDTH)
+
+
+def update_background_title(session):
+ d = session['dialog']
+ dev = session['device']
+
+ MB = 2 ** 20
+
+ size = (dev.meta['SIZE'] + MB - 1) // MB
+ shrinked = 'shrinked' in session and session['shrinked'] == True
+ postfix = " (shrinked)" if shrinked else ''
+
+ title = "OS: %s, Distro: %s, Size: %dMB%s" % \
+ (dev.ostype, dev.distro, size, postfix)
+
+ d.setBackgroundTitle(title)
def extract_image(session):
d.msgbox("Image file `%s' was successfully uploaded to pithos+" % filename,
width=MSGBOX_WIDTH)
+
return True
account = session["account"] if "account" in session else "<none>"
token = session["token"] if "token" in session else "<none>"
upload = session["upload"] if "upload" in session else "<none>"
+
+ choices = [("Account", "Change your ~okeanos username: %s" % account),
+ ("Token", "Change your ~okeanos token: %s" % token),
+ ("Upload", "Upload image to pithos+"),
+ ("Register", "Register image to cyclades: %s" % upload)]
+
(code, choice) = d.menu(
- "Choose one of the following or press <Back> to go back.",
- width=MENU_WIDTH,
- choices=[("Account", "Change your ~okeanos username: %s" %
- account),
- ("Token", "Change your ~okeanos token: %s" % token),
- ("Upload", "Upload image to pithos+"),
- ("Register", "Register image to cyclades: %s" % upload)],
- cancel="Back",
- default_item=default_item,
- help_button=1,
- title="Image Registration Menu")
+ text="Choose one of the following or press <Back> to go back.",
+ width=MENU_WIDTH, choices=choices, cancel="Back", help_button=1,
+ default_item=default_item, title="Image Registration Menu")
if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
return False
(code, choice) = d.menu(
"In this menu you can edit existing image properties or add new "
- "ones. Be carefull! Most properties have special meaning and "
+ "ones. Be careful! Most properties have special meaning and "
"alter the image deployment behaviour. Press <HELP> to see more "
"information about image properties. Press <BACK> when done.",
- height=18,
- width=MENU_WIDTH,
- choices=choices, menu_height=10,
- ok_label="EDIT", extra_button=1, extra_label="ADD", cancel="BACK",
- help_button=1, help_label="HELP", title="Image Metadata")
+ height=18, width=MENU_WIDTH, choices=choices, menu_height=10,
+ ok_label="Edit", extra_button=1, extra_label="Add", cancel="Back",
+ help_button=1, title="Image Metadata")
if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
break
choices.append((key, "%s" % val, 0))
(code, to_delete) = d.checklist("Choose which properties to delete:",
- choices=choices)
- count = len(to_delete)
+ choices=choices, width=CHECKBOX_WIDTH)
+
# If the user exits with ESC or CANCEL, the returned tag list is empty.
for i in to_delete:
del session['metadata'][i]
- if count > 0:
- d.msgbox("%d image properties were deleted.", width=MSGBOX_WIDTH)
+ cnt = len(to_delete)
+ if cnt > 0:
+ d.msgbox("%d image properties were deleted." % cnt, width=MSGBOX_WIDTH)
-def exclude_task(session):
+def exclude_tasks(session):
d = session['dialog']
+ index = 0
+ displayed_index = 1
choices = []
- for (key, val) in session['metadata'].items():
- choices.append((key, "%s" % val, 0))
+ mapping = {}
+ if 'excluded_tasks' not in session:
+ session['excluded_tasks'] = []
+
+ if -1 in session['excluded_tasks']:
+ if not d.yesno("Image deployment configuration is disabled. "
+ "Do you wish to enable it?", width=YESNO_WIDTH):
+ session['excluded_tasks'].remove(-1)
+ else:
+ return
+
+ for (msg, task, osfamily) in CONFIGURATION_TASKS:
+ if session['metadata']['OSFAMILY'] in osfamily:
+ checked = 1 if index in session['excluded_tasks'] else 0
+ choices.append((str(displayed_index), msg, checked))
+ mapping[displayed_index] = index
+ displayed_index += 1
+ index += 1
- (code, to_delete) = d.checklist("Choose which properties to delete:",
- choices=choices)
- count = len(to_delete)
- # If the user exits with ESC or CANCEL, the returned tag list is empty.
- for i in to_delete:
- del session['metadata'][i]
+ while 1:
+ (code, tags) = d.checklist(
+ text="Please choose which configuration tasks you would like to "
+ "prevent from running during image deployment. "
+ "Press <No Config> to supress any configuration. "
+ "Press <Help> for more help on the image deployment "
+ "configuration tasks.",
+ choices=choices, height=19, list_height=8, width=CHECKBOX_WIDTH,
+ help_button=1, extra_button=1, extra_label="No Config",
+ title="Exclude Configuration Tasks")
+
+ if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
+ break
+ elif code == d.DIALOG_HELP:
+ help_file = get_help_file("configuration_tasks")
+ assert os.path.exists(help_file)
+ d.textbox(help_file, title="Configuration Tasks",
+ width=70, height=40)
+ # No Config button
+ elif code == d.DIALOG_EXTRA:
+ session['excluded_tasks'] = [-1]
+ session['task_metadata'] = ["EXCLUDE_ALL_TASKS"]
+ break
+ elif code == d.DIALOG_OK:
+ session['excluded_tasks'] = []
+ for tag in tags:
+ session['excluded_tasks'].append(mapping[int(tag)])
+
+ exclude_metadata = []
+ for task in session['excluded_tasks']:
+ exclude_metadata.extend(CONFIGURATION_TASKS[task][1])
- if count > 0:
- d.msgbox("%d image properties were deleted.", width=MSGBOX_WIDTH)
+ session['task_metadata'] = \
+ map(lambda x: "EXCLUDE_TASK_%s" % x, exclude_metadata)
+ break
-def deploy_menu(session):
+def sysprep(session):
d = session['dialog']
+ image_os = session['image_os']
+
+ # Is the image already shrinked?
+ if 'shrinked' in session and session['shrinked'] == True:
+ msg = "It seems you have shrinked the image. Running system " \
+ "preparation tasks on a shrinked image is dangerous."
+
+ if d.yesno("%s\n\nDo you really want to continue?" % msg,
+ width=YESNO_WIDTH, defaultno=1):
+ return
+
+ wrapper = textwrap.TextWrapper(width=65)
+
+ help_title = "System Preperation Tasks"
+ sysprep_help = "%s\n%s\n\n" % (help_title, '=' * len(help_title))
+
+ if 'exec_syspreps' not in session:
+ session['exec_syspreps'] = []
+
+ all_syspreps = image_os.list_syspreps()
+ # Only give the user the choice between syspreps that have not ran yet
+ syspreps = [s for s in all_syspreps if s not in session['exec_syspreps']]
+
+ if len(syspreps) == 0:
+ d.msgbox("No system preparation task left to run!", width=MSGBOX_WIDTH)
+ return
- default_item = "View/Modify"
- actions = {"View/Modify": modify_properties, "Delete": delete_properties}
+ while 1:
+ choices = []
+ index = 0
+ for sysprep in syspreps:
+ name, descr = image_os.sysprep_info(sysprep)
+ display_name = name.replace('-', ' ').capitalize()
+ sysprep_help += "%s\n" % display_name
+ sysprep_help += "%s\n" % ('-' * len(display_name))
+ sysprep_help += "%s\n\n" % wrapper.fill(" ".join(descr.split()))
+ enabled = 1 if sysprep.enabled else 0
+ choices.append((str(index + 1), display_name, enabled))
+ index += 1
+
+ (code, tags) = d.checklist(
+ "Please choose which system preperation tasks you would like to "
+ "run on the image. Press <Help> to see details about the system "
+ "preperation tasks.", title="Run system preperation tasks",
+ choices=choices, width=70, ok_label="Run", help_button=1)
+
+ if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
+ break
+ elif code == d.DIALOG_HELP:
+ d.scrollbox(sysprep_help, width=HELP_WIDTH)
+ elif code == d.DIALOG_OK:
+ # Enable selected syspreps and disable the rest
+ for i in range(len(syspreps)):
+ if str(i + 1) in tags:
+ image_os.enable_sysprep(syspreps[i])
+ session['exec_syspreps'].append(syspreps[i])
+ else:
+ image_os.disable_sysprep(syspreps[i])
+
+ out = InfoBoxOutput(d, "Image Configuration")
+ try:
+ dev = session['device']
+ dev.out = out
+ dev.mount(readonly=False)
+ try:
+ # The checksum is invalid. We have mounted the image rw
+ if 'checksum' in session:
+ del session['checksum']
+
+ # Monitor the metadata changes during syspreps
+ with metadata_monitor(session, image_os.meta):
+ image_os.out = out
+ image_os.do_sysprep()
+ image_os.out.finalize()
+
+ # Disable syspreps that have ran
+ for sysprep in session['exec_syspreps']:
+ image_os.disable_sysprep(sysprep)
+
+ finally:
+ dev.umount()
+ finally:
+ out.cleanup()
+ break
+
+
+def shrink(session):
+ d = session['dialog']
+ dev = session['device']
+
+ shrinked = 'shrinked' in session and session['shrinked'] == True
+
+ if shrinked:
+ d.msgbox("You have already shrinked your image!")
+ return
+
+ msg = "This operation will shrink the last partition of the image to " \
+ "reduce the total image size. If the last partition is a swap " \
+ "partition, then this partition is removed and the partition " \
+ "before that is shrinked. The removed swap partition will be " \
+ "recreated during image deployment."
+
+ if not d.yesno("%s\n\nDo you want to continue?" % msg, width=70,
+ height=12, title="Image Shrinking"):
+
+ with metadata_monitor(session, dev.meta):
+ dev.out = InfoBoxOutput(d, "Image Shrinking", height=3)
+ dev.shrink()
+ dev.out.finalize()
+
+ session['shrinked'] = True
+ update_background_title(session)
+
+
+def customization_menu(session):
+ d = session['dialog']
+
+ choices = [("Sysprep", "Run various image preperation tasks"),
+ ("Shrink", "Shrink image"),
+ ("View/Modify", "View/Modify image properties"),
+ ("Delete", "Delete image properties"),
+ ("Exclude", "Exclude various deployment tasks from running")]
+
+ default_item = "Sysprep"
+
+ actions = {"Sysprep": sysprep,
+ "Shrink": shrink,
+ "View/Modify": modify_properties,
+ "Delete": delete_properties,
+ "Exclude": exclude_tasks}
while 1:
(code, choice) = d.menu(
- "Choose one of the following or press <Back> to exit.",
- width=MENU_WIDTH,
- choices=[("View/Modify", "View/Modify image properties"),
- ("Delete", "Delete image properties"),
- ("Exclude", "Exclude configuration tasks from running")],
- cancel="Back",
- default_item=default_item,
- title="Image Deployment Menu")
+ text="Choose one of the following or press <Back> to exit.",
+ width=MENU_WIDTH, choices=choices, cancel="Back", height=13,
+ menu_height=len(choices), default_item=default_item,
+ title="Image Customization Menu")
if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
break
def main_menu(session):
d = session['dialog']
dev = session['device']
- d.setBackgroundTitle("OS: %s, Distro: %s" % (dev.ostype, dev.distro))
- actions = {"Deploy": deploy_menu,
- "Register": kamaki_menu,
- "Extract": extract_image}
+
+ update_background_title(session)
+
+ choices = [("Customize", "Customize image & ~okeanos deployment options"),
+ ("Register", "Register image to ~okeanos"),
+ ("Extract", "Dump image to local file system"),
+ ("Reset", "Reset everything and start over again"),
+ ("Help", "Get help for using snf-image-creator")]
+
default_item = "Customize"
+ actions = {"Customize": customization_menu, "Register": kamaki_menu,
+ "Extract": extract_image}
while 1:
(code, choice) = d.menu(
- "Choose one of the following or press <Exit> to exit.",
- width=MENU_WIDTH,
- choices=[("Customize", "Run various image customization tasks"),
- ("Deploy", "Configure ~okeanos image deployment options"),
- ("Register", "Register image to ~okeanos"),
- ("Extract", "Dump image to local file system"),
- ("Reset", "Reset everything and start over again"),
- ("Help", "Get help for using snf-image-creator")],
- cancel="Exit",
- default_item=default_item,
+ text="Choose one of the following or press <Exit> to exit.",
+ width=MENU_WIDTH, choices=choices, cancel="Exit", height=13,
+ default_item=default_item, menu_height=len(choices),
title="Image Creator for ~okeanos (snf-image-creator version %s)" %
version)
if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
if confirm_exit(d):
break
- else:
- continue
-
- if choice == "Reset":
+ elif choice == "Reset":
if confirm_reset(d):
- d.infobox("Resetting snf-image-creator. Please wait...")
+ d.infobox("Resetting snf-image-creator. Please wait...",
+ width=INFOBOX_WIDTH)
raise Reset
- else:
- continue
elif choice in actions:
actions[choice](session)
return media
-def collect_metadata(dev, out):
-
- out.output("Collecting image metadata...")
- metadata = dev.meta
- dev.mount(readonly=True)
- cls = os_cls(dev.distro, dev.ostype)
- image_os = cls(dev.root, dev.g, out)
- dev.umount()
- metadata.update(image_os.meta)
- out.success("done")
-
- return metadata
-
-
def image_creator(d):
basename = os.path.basename(sys.argv[0])
usage = "Usage: %s [input_media]" % basename
sys.stderr.write("%s\n" % usage)
return 1
+ d.setBackgroundTitle('snf-image-creator')
+
if os.geteuid() != 0:
raise FatalError("You must run %s as root" % basename)
media = select_file(d, sys.argv[1] if len(sys.argv) == 2 else None)
- out = InitializationOutput(d)
+ out = GaugeOutput(d, "Initialization", "Initializing...")
disk = Disk(media, out)
- def signal_handler(signum, fram):
+ def signal_handler(signum, frame):
out.cleanup()
disk.cleanup()
snapshot = disk.snapshot()
dev = disk.get_device(snapshot)
- metadata = collect_metadata(dev, out)
+ out.output("Collecting image metadata...")
+
+ metadata = {}
+ for (key, value) in dev.meta.items():
+ metadata[str(key)] = str(value)
+
+ dev.mount(readonly=True)
+ cls = os_cls(dev.distro, dev.ostype)
+ image_os = cls(dev.root, dev.g, out)
+ dev.umount()
+
+ for (key, value) in image_os.meta.items():
+ metadata[str(key)] = str(value)
+
+ out.success("done")
out.cleanup()
# Make sure the signal handler does not call out.cleanup again
def dummy(self):
pass
- instancemethod = type(InitializationOutput.cleanup)
- out.cleanup = instancemethod(dummy, out, InitializationOutput)
+ out.cleanup = type(GaugeOutput.cleanup)(dummy, out, GaugeOutput)
session = {"dialog": d,
"disk": disk,
"snapshot": snapshot,
"device": dev,
+ "image_os": image_os,
"metadata": metadata}
main_menu(session)
sys.exit(ret)
except FatalError as e:
msg = textwrap.fill(str(e), width=70)
- d.infobox(msg, width=70, title="Fatal Error")
+ d.infobox(msg, width=INFOBOX_WIDTH, title="Fatal Error")
sys.exit(1)
except Reset:
continue
projects / snf-image-creator / blobdiff