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, install *software-properties-common* first:
50 .. code-block:: console
52 $ sudo apt-get install software-properties-common
54 After the synnefo repository is set up, you should be able to list
55 snf-image-creator by calling:
57 .. code-block:: console
59 $ apt-cache showpkg snf-image-creator
61 Install the package by issuing:
63 .. code-block:: console
65 $ sudo apt-get install snf-image-creator
67 If you are using Ubuntu 12.10, also install libguestfs-tools:
69 .. code-block:: console
71 $ sudo apt-get install libguestfs-tools
74 If you are asked during the installation to create/update a
75 "supermin appliance", choose "Yes".
78 In *Ubuntu 12.10* the current package of libguestfs (1.18-2) is broken. Take
79 a look at the open `bug report <https://bugs.launchpad.net/ubuntu/quantal/+source/libguestfs/+bug/1086974>`_.
80 Until version 1.18-2ubunut1 is out, you may workaround this problem by
81 creating a symlink like this:
83 *sudo ln -s /usr/lib/guestfs /usr/lib/x86_64-linux-gnu/guestfs*
88 For *Fedora 17* you can use our official packages hosted at the *synnefo*
89 repository of the openSUSE Build Service.
91 Add the *synnefo* repository for *Fedora 17* to *yum*:
93 .. code-block:: console
96 $ wget http://download.opensuse.org/repositories/home:/GRNET:/synnefo/Fedora_17/home:GRNET:synnefo.repo
98 To list the *snf-image-creator* package use the following command:
100 .. code-block:: console
102 $ yum info snf-image-creator
104 Install the package by issuing:
106 .. code-block:: console
108 $ yum install snf-image-creator
113 For *CentOS 6* you can use our official packages hosted at the *synnefo*
114 repository of the openSUSE Build Service.
116 Add the *synnefo* repository for *CentOS 6* to the yum repositories list:
118 .. code-block:: console
120 $ cd /etc/yum.repos.d
121 $ wget http://download.opensuse.org/repositories/home:/GRNET:/synnefo/CentOS_CentOS-6/home:GRNET:synnefo.repo
123 Check the `Fedora <#fedora>`_ instructions on how to install the software.
128 For *Arch Linux* there are **unofficial** packages in AUR:
129 https://aur.archlinux.org/packages/snf-image-creator/ kindly provided by
130 Axilleas Pipinellis <axilleas@archlinux.info>.
133 Those packages are not maintained by the Synnefo development team.
135 Please direct package-specific questions to Axilleas Pipinellis <axilleas@archlinux.info>,
136 Cc: the Synnefo development team <synnefo-devel@googlegroups.com>
138 To install the package you may use *yaourt*. Create and install
139 the *yaourt* package:
141 .. code-block:: console
143 $ wget https://aur.archlinux.org/packages/pa/package-query/package-query.tar.gz
144 $ tar -xvf package-query.tar.gz
147 $ pacman -U package-query-<VERSION>-<ARCH>.pkg.tar.xz
149 $ wget https://aur.archlinux.org/packages/ya/yaourt/yaourt.tar.gz
150 $ tar -xvf yaourt.tar.gz
153 $ pacman -U yaourt-<VERSION>-<ARCH>.pkg.tar.xz
155 Install *snf-image-creator* using yaourt:
157 .. code-block:: console
159 $ yaourt -Sa snf-image-creator
161 Install snf-image-creator from source
162 =====================================
164 Manually install the following dependencies:
166 * Python 2 [http://www.python.org/]
167 * Python setuptools [http://pypi.python.org/pypi/setuptools]
168 * Python Dialog [http://pythondialog.sourceforge.net/]
169 * Python bindings for libguestfs [http://libguestfs.org/]
170 * Python interface to sendfile [http://pypi.python.org/pypi/pysendfile]
171 * pyparted [https://fedorahosted.org/pyparted/]
172 * rsync [http://rsync.samba.org/]
174 In Ubuntu you can do this using:
176 .. code-block:: console
178 $ sudo apt-get install python-setuptools python-guestfs python-dialog \
179 python-sendfile python-parted rsync
181 If you are using Ubuntu 12.10 you also need to install libguestfs-tools:
183 .. code-block:: console
185 $ sudo apt-get install libguestfs-tools
188 If you are asked during the installation to create/update a
189 "supermin appliance", choose "Yes".
191 Python Virtual Environment
192 --------------------------
194 Since snf-image-creator and the rest of its dependencies won't be installed
195 using packages, it's better to work in an isolated python virtual environment
198 Install the Virtual Python Environment builder:
199 http://pypi.python.org/pypi/virtualenv.
201 For Ubuntu use the following command:
203 .. code-block:: console
205 $ sudo apt-get install python-virtualenv
207 Then create a new python virtual environment:
209 .. code-block:: console
211 $ virtualenv --system-site-packages ~/image-creator-env
213 and activate it by executing:
215 .. code-block:: console
217 $ source ~/image-creator-env/bin/activate
219 You may later deactivate it using:
221 .. code-block:: console
228 Refer to `./kamaki documentation <http://docs.dev.grnet.gr/kamaki/latest/installation.html>`_
229 for instructions. You may install kamaki from source inside the virtualenv
230 you've created above or by using binary packages if they are available for your
233 snf-image-creator Installation
234 ------------------------------
236 Download the latest snf-image-creator source package from
237 `here <https://code.grnet.gr/projects/snf-image-creator/files>`_ and install it
238 inside the virtualenv using the following commands:
240 .. code-block:: console
242 $ tar -xf snf_image_creator-<VERSION>.tar.gz
243 $ cd snf_image_creator-<VERSION>
244 $ python ./setup.py install
246 Alternatively, you can install the bleeding edge version of the software by
247 cloning its git repository:
249 .. code-block:: console
251 $ git clone https://code.grnet.gr/git/snf-image-creator
252 $ cd snf-image-creator
253 $ python ./setup.py install
255 To do the latter, you'll need to have git (http://git-scm.com/) installed.
256 For ubuntu this can be done using:
258 .. code-block:: console
260 $ sudo apt-get install git
263 Keep in mind that the bleeding edge version may be unstable or even