Add basic usage documentation
authorNikos Skalkotos <skalkoto@grnet.gr>
Mon, 15 Oct 2012 14:45:03 +0000 (17:45 +0300)
committerNikos Skalkotos <skalkoto@grnet.gr>
Mon, 15 Oct 2012 14:45:03 +0000 (17:45 +0300)
docs/index.rst
docs/snapshots/01_wizard.png [new file with mode: 0644]
docs/snapshots/02_name.png [new file with mode: 0644]
docs/snapshots/03_description.png [new file with mode: 0644]
docs/snapshots/04_account.png [new file with mode: 0644]
docs/snapshots/05_token.png [new file with mode: 0644]
docs/snapshots/06_confirm.png [new file with mode: 0644]
docs/usage.rst [new file with mode: 0644]

index 34e6161..356d405 100644 (file)
@@ -15,6 +15,7 @@ Contents:
 
    overview
    install
+   usage
 
 
 Indices and tables
diff --git a/docs/snapshots/01_wizard.png b/docs/snapshots/01_wizard.png
new file mode 100644 (file)
index 0000000..4401280
Binary files /dev/null and b/docs/snapshots/01_wizard.png differ
diff --git a/docs/snapshots/02_name.png b/docs/snapshots/02_name.png
new file mode 100644 (file)
index 0000000..8101e50
Binary files /dev/null and b/docs/snapshots/02_name.png differ
diff --git a/docs/snapshots/03_description.png b/docs/snapshots/03_description.png
new file mode 100644 (file)
index 0000000..2d66c1d
Binary files /dev/null and b/docs/snapshots/03_description.png differ
diff --git a/docs/snapshots/04_account.png b/docs/snapshots/04_account.png
new file mode 100644 (file)
index 0000000..55f5283
Binary files /dev/null and b/docs/snapshots/04_account.png differ
diff --git a/docs/snapshots/05_token.png b/docs/snapshots/05_token.png
new file mode 100644 (file)
index 0000000..125847c
Binary files /dev/null and b/docs/snapshots/05_token.png differ
diff --git a/docs/snapshots/06_confirm.png b/docs/snapshots/06_confirm.png
new file mode 100644 (file)
index 0000000..8afdcd8
Binary files /dev/null and b/docs/snapshots/06_confirm.png differ
diff --git a/docs/usage.rst b/docs/usage.rst
new file mode 100644 (file)
index 0000000..32e09dd
--- /dev/null
@@ -0,0 +1,51 @@
+Usage
+=====
+
+snf-image-creator comes in 2 variants:
+ * snf-mkimage: A user-friendly dialog-based program
+ * snf-image-creator: A non-interactive command line program
+
+Creating a new image
+--------------------
+
+Suppose you want to create a new ubuntu server image. Download the installation
+disk from the internet:
+
+.. code-block:: console
+
+   $ wget http://ubuntureleases.tsl.gr/12.04.1/ubuntu-12.04.1-server-amd64.iso
+
+Create a 2G sparce file to host the new system:
+
+.. code-block:: console
+
+   $ truncate -s 2G ubuntu_hd.raw
+
+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 \
+     -cdrom ubuntu-12.04.1-server-amd64.iso
+
+After this, become root, activate the virtual environment you have installed
+snf-image-creator in, and use *snf-mkimage* to create and upload the image:
+
+.. code-block:: console
+
+   $ sudo -s
+   $ source /path/to/snf-image-env/bin/activate
+   $ snf-mkimage ubuntu_hd.raw
+
+In the first screen you will be asked to choose if you want to run the program
+in *Wizand* or *Expert* mode. Choose *Wizard*.
+
+.. image:: /snapshots/01_wizard.png
+
+Then you will be asked to provide a name, a description, an ~okeanos account
+and the token corresponding to this account. After that you will be asked to
+confirm the provided data.
+
+.. image:: /snapshots/06_confirm.png
+
+Choosing *YES* will create the image and upload it to your ~okeanos account.