From: Nikos Skalkotos <skalkoto@grnet.gr>
Date: Tue, 26 Jun 2012 13:42:04 +0000 (+0300)
Subject: Add image properties help file
X-Git-Tag: v0.1~53
X-Git-Url: https://code.grnet.gr/git/snf-image-creator/commitdiff_plain/09743d3a8cc6a0a15166a454d2fb13d244e6304d?hp=279f2c7d3b9bf9eee3d9e2af48e96e90d01db9ef

Add image properties help file
---

diff --git a/image_creator/dialog_main.py b/image_creator/dialog_main.py
index b533a15..3994d8f 100644
--- a/image_creator/dialog_main.py
+++ b/image_creator/dialog_main.py
@@ -316,9 +316,8 @@ def register_image(session):
         return False
 
     if "upload" not in session:
-        d.msgbox("You need to have an image uploaded to pithos+ before you "
-                 "can register it to cyclades",
-                 width=MSGBOX_WIDTH)
+        d.msgbox("You need to upload the image to pithos+ before you can "
+                 "register it to cyclades", width=MSGBOX_WIDTH)
         return False
 
     while 1:
@@ -362,7 +361,7 @@ def kamaki_menu(session):
         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)]
+                   ("Register", "Register the image to cyclades: %s" % upload)]
 
         (code, choice) = d.menu(
             text="Choose one of the following or press <Back> to go back.",
@@ -480,6 +479,10 @@ def modify_properties(session):
         # ADD button
         elif code == d.DIALOG_EXTRA:
             add_property(session)
+        elif code == 'help':
+            help_file = get_help_file("image_properties")
+            assert os.path.exists(help_file)
+            d.textbox(help_file, title="Image Properties", width=70, height=40)
 
 
 def delete_properties(session):
diff --git a/image_creator/help/image_properties.rst b/image_creator/help/image_properties.rst
new file mode 100644
index 0000000..a282c24
--- /dev/null
+++ b/image_creator/help/image_properties.rst
@@ -0,0 +1,32 @@
+Image properties with special meaning
+=====================================
+
+Properties used during image deployment
+---------------------------------------
+ - OSFAMILY={linux, windows}
+     This specifies whether this is a Linux or a Windows image.
+ - ROOT_PARTITION=n
+     The partition number of the root partition.
+ - USERS="username1 username2..."
+     This is a space-seperated list of users, whose password will
+     be reset during deployment.
+ - SWAP=<n>:<size>
+     If this property is present, cyclades will create a swap
+     partition with given size at the end of the instance's disk.
+     This property only makes sense for Linux images.
+
+Properties used by the ~okeanos User Interface
+----------------------------------------------
+ - OS
+     The value of this property is used to associate the image
+     with an Operating System Logo.
+ - DESCRIPTION
+     A short description about the image.
+ - SIZE
+     This is used by the UI to compute the image copy progress
+     during deployment.
+ - GUI
+     Short description about the Graphical User Interface the
+     image hosts.
+ - KERNEL
+     The kernel version of the image OS.