Add basic usage documentation
[snf-image-creator] / docs / usage.rst
1 Usage
2 =====
3
4 snf-image-creator comes in 2 variants:
5  * snf-mkimage: A user-friendly dialog-based program
6  * snf-image-creator: A non-interactive command line program
7
8 Creating a new image
9 --------------------
10
11 Suppose you want to create a new ubuntu server image. Download the installation
12 disk from the internet:
13
14 .. code-block:: console
15
16    $ wget http://ubuntureleases.tsl.gr/12.04.1/ubuntu-12.04.1-server-amd64.iso
17
18 Create a 2G sparce file to host the new system:
19
20 .. code-block:: console
21
22    $ truncate -s 2G ubuntu_hd.raw
23
24 And install the ubuntu system on this file:
25
26 .. code-block:: console
27
28    $ sudo kvm -boot d -drive file=ubuntu_hd.raw,format=raw,cache=none,if=virtio \
29      -cdrom ubuntu-12.04.1-server-amd64.iso
30
31 After this, become root, activate the virtual environment you have installed
32 snf-image-creator in, and use *snf-mkimage* to create and upload the image:
33
34 .. code-block:: console
35
36    $ sudo -s
37    $ source /path/to/snf-image-env/bin/activate
38    $ snf-mkimage ubuntu_hd.raw
39
40 In the first screen you will be asked to choose if you want to run the program
41 in *Wizand* or *Expert* mode. Choose *Wizard*.
42
43 .. image:: /snapshots/01_wizard.png
44
45 Then you will be asked to provide a name, a description, an ~okeanos account
46 and the token corresponding to this account. After that you will be asked to
47 confirm the provided data.
48
49 .. image:: /snapshots/06_confirm.png
50
51 Choosing *YES* will create the image and upload it to your ~okeanos account.