Add basic usage documentation
[snf-image-creator] / docs / install.rst
1 Installation
2 ============
3
4 This guide describes how to install snf-image-creator on an Ubuntu 12.04 LTS
5 system. It it highly recommended to have virtualization capable hardware.
6 snf-image-creator can work on processors that do not support virtualization but
7 it will be extremely slow.
8
9 Dependencies
10 ------------
11
12 snf-image-creator depends on the following programs:
13
14  * Python 2 [http://www.python.org/]
15  * Python setuptools [http://pypi.python.org/pypi/setuptools]
16  * Python Dialog [http://pythondialog.sourceforge.net/]
17  * Python bindings for libguestfs [http://libguestfs.org/]
18  * Kamaki [https://code.grnet.gr/projects/kamaki]
19  * Python Sybprocess Wrapper [http://pypi.python.org/pypi/pbs]
20  * ANSI colors for Python [http://pypi.python.org/pypi/ansicolors]
21  * progress [http://pypi.python.org/pypi/progress]
22  * Python interface to sendfile [http://pypi.python.org/pypi/pysendfile]
23
24 The first four programs (python2, setuptools, libguestfs and Python Dialog)
25 need to be installed manually by the user. In an Ubuntu 12.04 LTS system this
26 can be archived using packages directly provided by the distribution, using
27 the following command:
28
29 .. code-block:: console
30
31    $ apt-get install python-setuptools python-guestfs python-dialog
32
33 The rest of the dependencies will be resolved by setuptools.
34
35 Python Virtual Environment
36 --------------------------
37
38 Since snf-image-creator and the rest of it's dependencies won't be installed
39 using packages provided by the distribution it's better to work in an isolated
40 python virtual environment (virtualenv). Installing the Virtual Python
41 Environment builder in Ubuntu can be accomplished using the following command:
42
43 .. code-block:: console
44
45    $ apt-get install python-virtualenv
46
47 Now, create a new python virtual environment like this:
48
49 .. code-block:: console
50
51    $ virtualenv --system-site-packages ~/image-creator-env
52
53 and activate it by executing:
54
55 .. code-block:: console
56
57    $ source ~/image-creator-env/bin/activate
58
59 You can later deactivate it using the following command:
60
61 .. code-block:: console
62
63    $ deactivate
64
65
66 kamaki Installation
67 -------------------
68
69 Install kamaki from source, by cloning it's repository:
70
71 .. code-block:: console
72
73    $ git clone https://code.grnet.gr/git/kamaki
74    $ cd kamaki
75    $ ./setup build
76
77 Then, make sure you are within the activated virtual environment before you
78 execute:
79
80 .. code-block:: console
81
82    $ ./setup install
83
84 snf-image-creator Installation
85 ------------------------------
86
87 Install snf-image-creator the same way:
88
89 .. code-block:: console
90
91    $ git clone https://code.grnet.gr/git/snf-image-creator
92    $ cd snf-image-creator
93    $ ./setup build
94
95 And from within the virtual environment execute:
96
97 .. code-block:: console
98
99    $ ./setup install
100