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 *Debian 7.0 (wheezy)* you can use our official packages found in our
39 development repository.
41 Add the following line to */etc/apt/sources.list*:
43 .. code-block:: console
45 deb http://apt.dev.grnet.gr wheezy/
47 And resynchronize the package index files from their sources:
49 .. code-block:: console
53 You should be able to list the package by calling:
55 .. code-block:: console
57 $ apt-cache showpkg snf-image-creator
59 And install the package with this command:
61 .. code-block:: console
63 $ apt-get install snf-image-creator
68 For *Ubuntu 12.04 LTS*, *12.10* and *13.04* systems, you can use our official
69 packages found in *grnet/synnefo* Lauchpad PPA.
71 Add the synnefo PPA in your system:
73 .. code-block:: console
75 $ sudo apt-add-repository ppa:grnet/synnefo
78 If *apt-add-repository* is missing, first install:
80 *software-properties-common* (Ubuntu 12.10 & 13.04):
82 .. code-block:: console
84 $ sudo apt-get install software-properties-common
86 Or *python-software-properties* (Ubuntu 12.04):
88 .. code-block:: console
90 $ sudo apt-get install python-software-properties
92 After the synnefo repository is set up, you should be able to list
93 snf-image-creator by calling:
95 .. code-block:: console
97 $ apt-cache showpkg snf-image-creator
99 Install the package by issuing:
101 .. code-block:: console
103 $ sudo apt-get install snf-image-creator
106 If you are asked during the installation to create/update a
107 "supermin appliance", choose "Yes".
112 For *Fedora 17* you can use our official packages hosted at the *synnefo*
113 repository of the openSUSE Build Service.
115 Add the *synnefo* repository for *Fedora 17* to *yum*:
117 .. code-block:: console
119 $ cd /etc/yum.repos.d
120 $ wget http://download.opensuse.org/repositories/home:/GRNET:/synnefo/Fedora_17/home:GRNET:synnefo.repo
122 To list the *snf-image-creator* package use the following command:
124 .. code-block:: console
126 $ yum info snf-image-creator
128 Install the package by issuing:
130 .. code-block:: console
132 $ yum install snf-image-creator
137 For *CentOS 6* you can use our official packages hosted at the *synnefo*
138 repository of the OpenSUSE Build Service.
140 Add the *synnefo* repository for *CentOS 6* to the yum repositories list:
142 .. code-block:: console
144 $ cd /etc/yum.repos.d
145 $ wget http://download.opensuse.org/repositories/home:/GRNET:/synnefo/CentOS_CentOS-6/home:GRNET:synnefo.repo
147 Check the `Fedora <#fedora>`_ instructions on how to install the software.
152 For *OpenSUSE 12.3* you can use our official packages hosted at the *synnefo*
153 repository of the OpenSUSE Build Service.
155 Add the *Virtualization* repository for *OpenSUSE 12.3* to *YaST* with the
156 *Zypper* package manager:
158 .. code-block:: console
160 $ zypper ar -f http://download.opensuse.org/repositories/Virtualization/openSUSE_12.3/Virtualization.repo
162 Add the *synnefo* repository:
164 .. code-block:: console
166 $ zypper ar -f http://download.opensuse.org/repositories/home:/GRNET:/synnefo/openSUSE_12.3/home:GRNET:synnefo.repo
168 To list the *snf-image-creator* package use the following command:
170 .. code-block:: console
172 $ zypper se snf-image-creator
174 Install the package by issuing:
176 .. code-block:: console
178 $ zypper in snf-image-creator
184 For *Arch Linux* there are **unofficial** packages in AUR:
185 https://aur.archlinux.org/packages/snf-image-creator/ kindly provided by
186 Axilleas Pipinellis <axilleas@archlinux.info>.
189 Those packages are not maintained by the Synnefo development team.
191 Please direct package-specific questions to Axilleas Pipinellis <axilleas@archlinux.info>,
192 Cc: the Synnefo development team <synnefo-devel@googlegroups.com>
194 To install the package you may use *yaourt*. Create and install
195 the *yaourt* package:
197 .. code-block:: console
199 $ wget https://aur.archlinux.org/packages/pa/package-query/package-query.tar.gz
200 $ tar -xvf package-query.tar.gz
203 $ pacman -U package-query-<VERSION>-<ARCH>.pkg.tar.xz
205 $ wget https://aur.archlinux.org/packages/ya/yaourt/yaourt.tar.gz
206 $ tar -xvf yaourt.tar.gz
209 $ pacman -U yaourt-<VERSION>-<ARCH>.pkg.tar.xz
211 Install *snf-image-creator* using yaourt:
213 .. code-block:: console
215 $ yaourt -Sa snf-image-creator
217 Install snf-image-creator from source
218 =====================================
220 Manually install the following dependencies:
222 * Python 2 [http://www.python.org/]
223 * Python setuptools [http://pypi.python.org/pypi/setuptools]
224 * Python Dialog [http://pythondialog.sourceforge.net/]
225 * Python bindings for libguestfs [http://libguestfs.org/]
226 * Python interface to sendfile [http://pypi.python.org/pypi/pysendfile]
227 * pyparted [https://fedorahosted.org/pyparted/]
228 * rsync [http://rsync.samba.org/]
230 In Ubuntu you can do this using:
232 .. code-block:: console
234 $ sudo apt-get install python-setuptools python-guestfs python-dialog \
235 python-sendfile python-parted rsync
237 If you are using Ubuntu 12.10 you also need to install libguestfs-tools:
239 .. code-block:: console
241 $ sudo apt-get install libguestfs-tools
244 If you are asked during the installation to create/update a
245 "supermin appliance", choose "Yes".
247 Python Virtual Environment
248 --------------------------
250 Since snf-image-creator and the rest of its dependencies won't be installed
251 using packages, it's better to work in an isolated python virtual environment
254 Install the Virtual Python Environment builder:
255 http://pypi.python.org/pypi/virtualenv.
257 For Ubuntu use the following command:
259 .. code-block:: console
261 $ sudo apt-get install python-virtualenv
263 Then create a new python virtual environment:
265 .. code-block:: console
267 $ virtualenv --system-site-packages ~/image-creator-env
269 and activate it by executing:
271 .. code-block:: console
273 $ source ~/image-creator-env/bin/activate
275 You may later deactivate it using:
277 .. code-block:: console
284 Refer to `./kamaki documentation <http://docs.dev.grnet.gr/kamaki/latest/installation.html>`_
285 for instructions. You may install kamaki from source inside the virtualenv
286 you've created above or by using binary packages if they are available for your
289 snf-image-creator Installation
290 ------------------------------
292 Download the latest snf-image-creator source package from
293 `here <https://code.grnet.gr/projects/snf-image-creator/files>`_ and install it
294 inside the virtualenv using the following commands:
296 .. code-block:: console
298 $ tar -xf snf_image_creator-<VERSION>.tar.gz
299 $ cd snf_image_creator-<VERSION>
300 $ python ./setup.py install
302 Alternatively, you can install the bleeding edge version of the software by
303 cloning its git repository:
305 .. code-block:: console
307 $ git clone https://code.grnet.gr/git/snf-image-creator
308 $ cd snf-image-creator
309 $ python ./setup.py install
311 To do the latter, you'll need to have git (http://git-scm.com/) installed.
312 For ubuntu this can be done using:
314 .. code-block:: console
316 $ sudo apt-get install git
319 Keep in mind that the bleeding edge version may be unstable or even