Update installation method of sf-image-creator
[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 will work on processors that do not support virtualization
7 but 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 sh (previously pbs) [https://github.com/amoffat/sh]
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 When installing snf-image-creator, the above dependencies are automatically
25 resolved.
26
27 Development repository addition
28 ===============================
29
30 In order to install snf-image-creator and the rest of it's dependencies, you
31 must first add GRNET's dev repo to your sources. You can use the following
32 commands:
33
34 .. code-block:: console
35
36    cd /etc/apt/sources.list.d
37    echo "deb http://apt.dev.grnet.gr precise main" | \
38    sudo tee -a  apt.dev.grnet.gr.list
39    echo "deb-src http://apt.dev.grnet.gr precise main" | \
40    sudo tee -a apt.dev.grnet.gr.list
41
42 You will also need to import the repo's GPG key. You can use the ``curl`` tool
43 for this.
44
45 .. code-block:: console
46
47    $ sudo apt-get install curl
48
49 Use the following command to import the GPG key:
50
51 .. code-block:: console
52
53    $ sudo curl https://dev.grnet.gr/files/apt-grnetdev.pub | sudo apt-key add -
54
55 You can verify that the repo has been added successfully if snf-image-creator
56 exists as a package. First do an update of your sources:
57
58 .. code-block:: console
59
60    $ sudo apt-get update
61
62 then check if snf-image-creator exists with the following command:
63
64 .. code-block:: console
65
66    $ apt-cache showpkg snf-image-creator
67
68 snf-image-creator Installation
69 ==============================
70
71 If GRNET's dev repo has been added successfully, you can install
72 snf-image-creator, along with its dependencies, with the following command:
73
74 .. code-block:: console
75
76    $ sudo apt-get install snf-image-creator
77
78 The installation might take a while. Please note that at some point during the
79 installation you will be prompted to create/update a "supermin appliance". This
80 is a setting regarding libguestfs and you can safely choose "Yes".