Update the documentation
authorNikos Skalkotos <skalkoto@grnet.gr>
Tue, 19 Mar 2013 14:44:04 +0000 (16:44 +0200)
committerNikos Skalkotos <skalkoto@grnet.gr>
Tue, 19 Mar 2013 14:44:04 +0000 (16:44 +0200)
Update the documentation to reflect the changes made after 0.2.4

12 files changed:
docs/install.rst
docs/man/snf-image-creator.rst
docs/overview.rst
docs/snapshots/01_wizard.png [deleted file]
docs/snapshots/02_name.png [deleted file]
docs/snapshots/03_description.png [deleted file]
docs/snapshots/04_account.png [deleted file]
docs/snapshots/05_token.png [deleted file]
docs/snapshots/06_confirm.png [deleted file]
docs/snapshots/confirm.png [new file with mode: 0644]
docs/snapshots/wizard.png [new file with mode: 0644]
docs/usage.rst

index 1aa8812..dfd0dd4 100644 (file)
@@ -45,12 +45,20 @@ Add the synnefo PPA in your system:
    $ sudo apt-add-repository ppa:grnet/synnefo
    $ sudo apt-get update
 
-If *apt-add-repository* is missing, install *software-properties-common* first:
+If *apt-add-repository* is missing, first install:
+
+*software-properties-common* (Ubuntu 12.10):
 
 .. code-block:: console
 
    $ sudo apt-get install software-properties-common
 
+Or *python-software-properties* (Ubuntu 12.04):
+
+.. code-block:: console
+
+   $ sudo apt-get install python-software-properties
+
 After the synnefo repository is set up, you should be able to list
 snf-image-creator by calling:
 
@@ -64,12 +72,6 @@ Install the package by issuing:
 
    $ sudo apt-get install snf-image-creator
 
-If you are using Ubuntu 12.10, also install libguestfs-tools:
-
-.. code-block:: console
-
-   $ sudo apt-get install libguestfs-tools
-
 .. note::
    If you are asked during the installation to create/update a
    "supermin appliance", choose "Yes".
index ee87989..751d42a 100644 (file)
@@ -17,10 +17,6 @@ itself.
 Options
 -------
 
--a ACCOUNT, --account=ACCOUNT
-       use this ACCOUNT when uploading/registering images to a Synnefo
-       deployment
-
 --disable-sysprep=SYSPREP
        prevent SYSPREP operation from running on the input media
 
@@ -45,6 +41,9 @@ Options
 -o FILE, --outfile=FILE
        dump image to FILE
 
+--public
+       register image to cyclades as public
+
 --print-sysprep
        print the enabled and disabled system preparation operations for this
        input media
index e332d63..2cd3a19 100644 (file)
@@ -30,7 +30,7 @@ Creation
 The program can either dump the image file locally or use
 `./kamaki <https://code.grnet.gr/projects/kamaki>`_ to directly upload and
 register it on a `Synnefo <https://code.grnet.gr/projects/synnefo>`_
-deployment.
+deployment as private or public image.
 
 Image Format
 ============
diff --git a/docs/snapshots/01_wizard.png b/docs/snapshots/01_wizard.png
deleted file mode 100644 (file)
index 4401280..0000000
Binary files a/docs/snapshots/01_wizard.png and /dev/null differ
diff --git a/docs/snapshots/02_name.png b/docs/snapshots/02_name.png
deleted file mode 100644 (file)
index 8101e50..0000000
Binary files a/docs/snapshots/02_name.png and /dev/null differ
diff --git a/docs/snapshots/03_description.png b/docs/snapshots/03_description.png
deleted file mode 100644 (file)
index 2d66c1d..0000000
Binary files a/docs/snapshots/03_description.png and /dev/null differ
diff --git a/docs/snapshots/04_account.png b/docs/snapshots/04_account.png
deleted file mode 100644 (file)
index 55f5283..0000000
Binary files a/docs/snapshots/04_account.png and /dev/null differ
diff --git a/docs/snapshots/05_token.png b/docs/snapshots/05_token.png
deleted file mode 100644 (file)
index 125847c..0000000
Binary files a/docs/snapshots/05_token.png and /dev/null differ
diff --git a/docs/snapshots/06_confirm.png b/docs/snapshots/06_confirm.png
deleted file mode 100644 (file)
index 8afdcd8..0000000
Binary files a/docs/snapshots/06_confirm.png and /dev/null differ
diff --git a/docs/snapshots/confirm.png b/docs/snapshots/confirm.png
new file mode 100644 (file)
index 0000000..2ac9d6b
Binary files /dev/null and b/docs/snapshots/confirm.png differ
diff --git a/docs/snapshots/wizard.png b/docs/snapshots/wizard.png
new file mode 100644 (file)
index 0000000..0e27018
Binary files /dev/null and b/docs/snapshots/wizard.png differ
index 40e8607..a1c8da6 100644 (file)
@@ -31,9 +31,6 @@ snf-image-creator receives the following options:
                          upload the image to pithos with name FILENAME
    -r IMAGENAME, --register=IMAGENAME
                          register the image with ~okeanos as IMAGENAME
-   -a ACCOUNT, --account=ACCOUNT
-                         use this ACCOUNT when uploading/registering images
-                         [Default: None]
    -m KEY=VALUE, --metadata=KEY=VALUE
                          add custom KEY=VALUE metadata to the image
    -t TOKEN, --token=TOKEN
@@ -48,13 +45,17 @@ snf-image-creator receives the following options:
                          media
    --no-sysprep          don't perform any system preparation operation
    --no-shrink           don't shrink the image
+   --public              register image to cyclades as public
    --tmpdir=DIR          create large temporary image files under DIR
 
 Most input options are self-describing. If you want to save a local copy of
 the image you create, provide a filename using the *-o* option. To upload the
-image to *pithos+*, provide valid credentials using *-a* and *-t* and a
+image to *pithos+*, provide a valid authentication token using *-t* and a
 filename using *-u*. If you also want to register the image with *~okeanos*, in
-addition to *-u* provide a registration name using *-r*.
+addition to *-u* provide a registration name using *-r*. All images are
+registered as *private*. Only the user that registers the image can create
+VM's out of it. If you want the image to be visible by other user too, use the
+*--public* option.
 
 By default, before extracting the image, snf-image-creator will perform a
 number of system preparation operations on the snapshot of the media and will
@@ -175,8 +176,8 @@ following basic information:
  * Name: A short name for the image (ex. "Slackware")
  * Description: An one-line description for the image
    (ex. "Slackware Linux 14.0 with KDE")
- * Account: An *~okeanos* account user id
- * Token: A token corresponding to the account given above
+ * Registration Type: Private or Public
+ * Account: The authentication token for an *~okeanos* account
 
 After confirming, the image will be extracted, uploaded to *pithos+* and
 registered with *~okeanos*. The user will also be given the choice to keep a
@@ -201,9 +202,10 @@ In the *Customize* sub-menu the user can control:
 
 In the *Register* sub-menu the user can provide:
 
- * The credentials to login to *~okeanos*
+ * The credentials (authentication token) to authenticate on *~okeanos*
  * A *pithos+* filename for the uploaded *diskdump* image
- * A name for the image to be registered to *~okeanos* with
+ * A name for the image to be registered to *~okeanos* with, as well as the
+   registration type (*private* or *public*)
 
 By choosing the *Extract* menu entry, the user can dump the image to the local
 file system. Finally, if the user selects *Reset*, the system will ignore
@@ -228,13 +230,13 @@ disk from the Internet:
 
 .. code-block:: console
 
-   $ wget http://ubuntureleases.tsl.gr/12.04.1/ubuntu-12.04.1-server-amd64.iso
+   $ wget http://ubuntureleases.tsl.gr/12.04.2/ubuntu-12.04.2-server-amd64.iso
 
 Verify that it has been downloaded correctly:
 
 .. code-block:: console
 
-   $ echo 'a8c667e871f48f3a662f3fbf1c3ddb17  ubuntu-12.04.1-server-amd64.iso' > check.md5
+   $ echo 'a8c667e871f48f3a662f3fbf1c3ddb17  ubuntu-12.04.2-server-amd64.iso' > check.md5
    $ md5sum -c check.md5
 
 Create a 2G sparse file to host the new system:
@@ -248,7 +250,7 @@ And install the Ubuntu system on this file:
 .. code-block:: console
 
    $ sudo kvm -boot d -drive file=ubuntu_hd.raw,format=raw,cache=none,if=virtio \
-     -m 1G -cdrom ubuntu-12.04.1-server-amd64.iso
+     -m 1G -cdrom ubuntu-12.04.2-server-amd64.iso
 
 .. warning::
 
@@ -271,13 +273,13 @@ image:
 In the first screen you will be asked to choose if you want to run the program
 in *Wizard* or *Expert* mode. Choose *Wizard*.
 
-.. image:: /snapshots/01_wizard.png
+.. image:: /snapshots/wizard.png
 
-Then you will be asked to provide a name, a description, an *~okeanos* account
-and the token corresponding to this account. Finally, you'll be asked to
-confirm the provided data.
+Then you will be asked to provide a name, a description, a registration type
+(*private* or *public*) and the authentication token corresponding to your
+*~okeanos* account. Finally, you'll be asked to confirm the provided data.
 
-.. image:: /snapshots/06_confirm.png
+.. image:: /snapshots/confirm.png
 
 Choosing *YES* will create and upload the image to your *~okeanos* account.