4 This guide describes how to install snf-image-creator on a Linux system. It is
5 highly recommended to have virtualization capable hardware. snf-image-creator
6 will work on processors that do not support virtualization but it will be slow.
11 snf-image-creator depends on the following programs:
13 * Python 2 [http://www.python.org/]
14 * Python setuptools [http://pypi.python.org/pypi/setuptools]
15 * Python Dialog [http://pythondialog.sourceforge.net/]
16 * Python bindings for libguestfs [http://libguestfs.org/]
17 * Python interface to sendfile [http://pypi.python.org/pypi/pysendfile]
18 * pyparted [https://fedorahosted.org/pyparted/]
19 * rsync [http://rsync.samba.org/]
20 * ./kamaki [https://code.grnet.gr/projects/kamaki]
21 * Python sh (previously pbs) [https://github.com/amoffat/sh]
22 * ANSI colors for Python [http://pypi.python.org/pypi/ansicolors]
23 * progress [http://pypi.python.org/pypi/progress]
25 The above dependencies are resolved differently, depending on the installation
26 method you choose. There are two installation methods available:
28 #. `Installation using packages <#install-snf-image-creator-using-packages>`_
30 #. `Installation from source <#install-snf-image-creator-from-source>`_
32 Install snf-image-creator using packages
33 ========================================
38 For *Ubuntu 12.04 LTS* and *12.10* systems, you can use our official packages
39 found in *grnet/synnefo* Lauchpad PPA.
41 Add the synnefo PPA in your system:
43 .. code-block:: console
45 $ sudo apt-add-repository ppa:grnet/synnefo
48 If *apt-add-repository* is missing, first install:
50 *software-properties-common* (Ubuntu 12.10):
52 .. code-block:: console
54 $ sudo apt-get install software-properties-common
56 Or *python-software-properties* (Ubuntu 12.04):
58 .. code-block:: console
60 $ sudo apt-get install python-software-properties
62 After the synnefo repository is set up, you should be able to list
63 snf-image-creator by calling:
65 .. code-block:: console
67 $ apt-cache showpkg snf-image-creator
69 Install the package by issuing:
71 .. code-block:: console
73 $ sudo apt-get install snf-image-creator
76 If you are asked during the installation to create/update a
77 "supermin appliance", choose "Yes".
80 In *Ubuntu 12.10* the current package of libguestfs (1.18-2) is broken. Take
81 a look at the open `bug report <https://bugs.launchpad.net/ubuntu/quantal/+source/libguestfs/+bug/1086974>`_.
82 Until version 1.18-2ubunut1 is out, you may workaround this problem by
83 creating a symlink like this:
85 *sudo ln -s /usr/lib/guestfs /usr/lib/x86_64-linux-gnu/guestfs*
90 For *Fedora 17* you can use our official packages hosted at the *synnefo*
91 repository of the openSUSE Build Service.
93 Add the *synnefo* repository for *Fedora 17* to *yum*:
95 .. code-block:: console
98 $ wget http://download.opensuse.org/repositories/home:/GRNET:/synnefo/Fedora_17/home:GRNET:synnefo.repo
100 To list the *snf-image-creator* package use the following command:
102 .. code-block:: console
104 $ yum info snf-image-creator
106 Install the package by issuing:
108 .. code-block:: console
110 $ yum install snf-image-creator
115 For *CentOS 6* you can use our official packages hosted at the *synnefo*
116 repository of the openSUSE Build Service.
118 Add the *synnefo* repository for *CentOS 6* to the yum repositories list:
120 .. code-block:: console
122 $ cd /etc/yum.repos.d
123 $ wget http://download.opensuse.org/repositories/home:/GRNET:/synnefo/CentOS_CentOS-6/home:GRNET:synnefo.repo
125 Check the `Fedora <#fedora>`_ instructions on how to install the software.
130 For *Arch Linux* there are **unofficial** packages in AUR:
131 https://aur.archlinux.org/packages/snf-image-creator/ kindly provided by
132 Axilleas Pipinellis <axilleas@archlinux.info>.
135 Those packages are not maintained by the Synnefo development team.
137 Please direct package-specific questions to Axilleas Pipinellis <axilleas@archlinux.info>,
138 Cc: the Synnefo development team <synnefo-devel@googlegroups.com>
140 To install the package you may use *yaourt*. Create and install
141 the *yaourt* package:
143 .. code-block:: console
145 $ wget https://aur.archlinux.org/packages/pa/package-query/package-query.tar.gz
146 $ tar -xvf package-query.tar.gz
149 $ pacman -U package-query-<VERSION>-<ARCH>.pkg.tar.xz
151 $ wget https://aur.archlinux.org/packages/ya/yaourt/yaourt.tar.gz
152 $ tar -xvf yaourt.tar.gz
155 $ pacman -U yaourt-<VERSION>-<ARCH>.pkg.tar.xz
157 Install *snf-image-creator* using yaourt:
159 .. code-block:: console
161 $ yaourt -Sa snf-image-creator
163 Install snf-image-creator from source
164 =====================================
166 Manually install the following dependencies:
168 * Python 2 [http://www.python.org/]
169 * Python setuptools [http://pypi.python.org/pypi/setuptools]
170 * Python Dialog [http://pythondialog.sourceforge.net/]
171 * Python bindings for libguestfs [http://libguestfs.org/]
172 * Python interface to sendfile [http://pypi.python.org/pypi/pysendfile]
173 * pyparted [https://fedorahosted.org/pyparted/]
174 * rsync [http://rsync.samba.org/]
176 In Ubuntu you can do this using:
178 .. code-block:: console
180 $ sudo apt-get install python-setuptools python-guestfs python-dialog \
181 python-sendfile python-parted rsync
183 If you are using Ubuntu 12.10 you also need to install libguestfs-tools:
185 .. code-block:: console
187 $ sudo apt-get install libguestfs-tools
190 If you are asked during the installation to create/update a
191 "supermin appliance", choose "Yes".
193 Python Virtual Environment
194 --------------------------
196 Since snf-image-creator and the rest of its dependencies won't be installed
197 using packages, it's better to work in an isolated python virtual environment
200 Install the Virtual Python Environment builder:
201 http://pypi.python.org/pypi/virtualenv.
203 For Ubuntu use the following command:
205 .. code-block:: console
207 $ sudo apt-get install python-virtualenv
209 Then create a new python virtual environment:
211 .. code-block:: console
213 $ virtualenv --system-site-packages ~/image-creator-env
215 and activate it by executing:
217 .. code-block:: console
219 $ source ~/image-creator-env/bin/activate
221 You may later deactivate it using:
223 .. code-block:: console
230 Refer to `./kamaki documentation <http://docs.dev.grnet.gr/kamaki/latest/installation.html>`_
231 for instructions. You may install kamaki from source inside the virtualenv
232 you've created above or by using binary packages if they are available for your
235 snf-image-creator Installation
236 ------------------------------
238 Download the latest snf-image-creator source package from
239 `here <https://code.grnet.gr/projects/snf-image-creator/files>`_ and install it
240 inside the virtualenv using the following commands:
242 .. code-block:: console
244 $ tar -xf snf_image_creator-<VERSION>.tar.gz
245 $ cd snf_image_creator-<VERSION>
246 $ python ./setup.py install
248 Alternatively, you can install the bleeding edge version of the software by
249 cloning its git repository:
251 .. code-block:: console
253 $ git clone https://code.grnet.gr/git/snf-image-creator
254 $ cd snf-image-creator
255 $ python ./setup.py install
257 To do the latter, you'll need to have git (http://git-scm.com/) installed.
258 For ubuntu this can be done using:
260 .. code-block:: console
262 $ sudo apt-get install git
265 Keep in mind that the bleeding edge version may be unstable or even