Statistics
| Branch: | Tag: | Revision:

root / docs / install.rst @ 3e131a2a

History | View | Annotate | Download (8.4 kB)

1 7b006adb Nikos Skalkotos
Installation
2 fa77d79a Nikos Skalkotos
^^^^^^^^^^^^
3 2d86bc44 Nikos Skalkotos
4 8c7d7b90 Nikos Skalkotos
This guide describes how to install snf-image-creator on a Linux system. It is
5 8a40ba3c Alex Pyrgiotis
highly recommended to have virtualization capable hardware. snf-image-creator
6 b39357a8 Alex Pyrgiotis
will work on processors that do not support virtualization but it will be slow.
7 2d86bc44 Nikos Skalkotos
8 2d86bc44 Nikos Skalkotos
Dependencies
9 fa77d79a Nikos Skalkotos
============
10 2d86bc44 Nikos Skalkotos
11 2d86bc44 Nikos Skalkotos
snf-image-creator depends on the following programs:
12 2d86bc44 Nikos Skalkotos
13 2d86bc44 Nikos Skalkotos
 * Python 2 [http://www.python.org/]
14 2d86bc44 Nikos Skalkotos
 * Python setuptools [http://pypi.python.org/pypi/setuptools]
15 2d86bc44 Nikos Skalkotos
 * Python Dialog [http://pythondialog.sourceforge.net/]
16 2d86bc44 Nikos Skalkotos
 * Python bindings for libguestfs [http://libguestfs.org/]
17 b39357a8 Alex Pyrgiotis
 * Python interface to sendfile [http://pypi.python.org/pypi/pysendfile]
18 afdddc8d Nikos Skalkotos
 * pyparted [https://fedorahosted.org/pyparted/]
19 aab4b154 Nikos Skalkotos
 * rsync [http://rsync.samba.org/]
20 afdddc8d Nikos Skalkotos
 * ./kamaki [https://code.grnet.gr/projects/kamaki]
21 20e37310 Nikos Skalkotos
 * Python sh (previously pbs) [https://github.com/amoffat/sh]
22 2d86bc44 Nikos Skalkotos
 * ANSI colors for Python [http://pypi.python.org/pypi/ansicolors]
23 2d86bc44 Nikos Skalkotos
 * progress [http://pypi.python.org/pypi/progress]
24 2d86bc44 Nikos Skalkotos
25 0e8550d6 Alex Pyrgiotis
The above dependencies are resolved differently, depending on the installation
26 8a40ba3c Alex Pyrgiotis
method you choose. There are two installation methods available:
27 2d86bc44 Nikos Skalkotos
28 b50f3b94 Nikos Skalkotos
#. `Installation using packages <#install-snf-image-creator-using-packages>`_
29 8a40ba3c Alex Pyrgiotis
30 8c7d7b90 Nikos Skalkotos
#. `Installation from source <#install-snf-image-creator-from-source>`_
31 2d86bc44 Nikos Skalkotos
32 5aa25240 Nikos Skalkotos
Install snf-image-creator using packages
33 5aa25240 Nikos Skalkotos
========================================
34 0e8550d6 Alex Pyrgiotis
35 d7a0de81 Nikos Skalkotos
Debian
36 d7a0de81 Nikos Skalkotos
------
37 d7a0de81 Nikos Skalkotos
38 d7a0de81 Nikos Skalkotos
For *Debian 7.0 (wheezy)* you can use our official packages found in our
39 d7a0de81 Nikos Skalkotos
development repository.
40 d7a0de81 Nikos Skalkotos
41 d7a0de81 Nikos Skalkotos
Add the following line to */etc/apt/sources.list*:
42 d7a0de81 Nikos Skalkotos
43 d7a0de81 Nikos Skalkotos
.. code-block:: console
44 d7a0de81 Nikos Skalkotos
45 d7a0de81 Nikos Skalkotos
   deb http://apt.dev.grnet.gr wheezy/
46 d7a0de81 Nikos Skalkotos
47 d7a0de81 Nikos Skalkotos
And resynchronize the package index files from their sources:
48 d7a0de81 Nikos Skalkotos
49 d7a0de81 Nikos Skalkotos
.. code-block:: console
50 d7a0de81 Nikos Skalkotos
51 d7a0de81 Nikos Skalkotos
   $ sudo apt-get update
52 d7a0de81 Nikos Skalkotos
53 d7a0de81 Nikos Skalkotos
You should be able to list the package by calling:
54 d7a0de81 Nikos Skalkotos
55 d7a0de81 Nikos Skalkotos
.. code-block:: console
56 d7a0de81 Nikos Skalkotos
57 d7a0de81 Nikos Skalkotos
   $ apt-cache showpkg snf-image-creator
58 d7a0de81 Nikos Skalkotos
59 d7a0de81 Nikos Skalkotos
And install the package with this command:
60 d7a0de81 Nikos Skalkotos
61 d7a0de81 Nikos Skalkotos
.. code-block:: console
62 d7a0de81 Nikos Skalkotos
63 d7a0de81 Nikos Skalkotos
   $ apt-get install snf-image-creator
64 d7a0de81 Nikos Skalkotos
65 5aa25240 Nikos Skalkotos
Ubuntu
66 5aa25240 Nikos Skalkotos
------
67 5aa25240 Nikos Skalkotos
68 d7a0de81 Nikos Skalkotos
For *Ubuntu 12.04 LTS*, *12.10* and *13.04* systems, you can use our official
69 d7a0de81 Nikos Skalkotos
packages found in *grnet/synnefo* Lauchpad PPA.
70 0e8550d6 Alex Pyrgiotis
71 8c7d7b90 Nikos Skalkotos
Add the synnefo PPA in your system:
72 2d86bc44 Nikos Skalkotos
73 2d86bc44 Nikos Skalkotos
.. code-block:: console
74 2d86bc44 Nikos Skalkotos
75 afdddc8d Nikos Skalkotos
   $ sudo apt-add-repository ppa:grnet/synnefo
76 afdddc8d Nikos Skalkotos
   $ sudo apt-get update
77 a6f30600 Alex Pyrgiotis
78 ccb6b943 Nikos Skalkotos
If *apt-add-repository* is missing, first install:
79 ccb6b943 Nikos Skalkotos
80 d7a0de81 Nikos Skalkotos
*software-properties-common* (Ubuntu 12.10 & 13.04):
81 a6f30600 Alex Pyrgiotis
82 a6f30600 Alex Pyrgiotis
.. code-block:: console
83 b5053149 Alex Pyrgiotis
84 afdddc8d Nikos Skalkotos
   $ sudo apt-get install software-properties-common
85 a6f30600 Alex Pyrgiotis
86 ccb6b943 Nikos Skalkotos
Or *python-software-properties* (Ubuntu 12.04):
87 ccb6b943 Nikos Skalkotos
88 ccb6b943 Nikos Skalkotos
.. code-block:: console
89 ccb6b943 Nikos Skalkotos
90 ccb6b943 Nikos Skalkotos
   $ sudo apt-get install python-software-properties
91 ccb6b943 Nikos Skalkotos
92 8c7d7b90 Nikos Skalkotos
After the synnefo repository is set up, you should be able to list
93 8c7d7b90 Nikos Skalkotos
snf-image-creator by calling:
94 a6f30600 Alex Pyrgiotis
95 a6f30600 Alex Pyrgiotis
.. code-block:: console
96 a6f30600 Alex Pyrgiotis
97 e08d574e Alex Pyrgiotis
   $ apt-cache showpkg snf-image-creator
98 2d86bc44 Nikos Skalkotos
99 8c7d7b90 Nikos Skalkotos
Install the package by issuing:
100 2d86bc44 Nikos Skalkotos
101 2d86bc44 Nikos Skalkotos
.. code-block:: console
102 2d86bc44 Nikos Skalkotos
103 e08d574e Alex Pyrgiotis
   $ sudo apt-get install snf-image-creator
104 2d86bc44 Nikos Skalkotos
105 afdddc8d Nikos Skalkotos
.. note::
106 afdddc8d Nikos Skalkotos
   If you are asked during the installation to create/update a
107 afdddc8d Nikos Skalkotos
   "supermin appliance", choose "Yes".
108 0e8550d6 Alex Pyrgiotis
109 b50f3b94 Nikos Skalkotos
Fedora
110 b50f3b94 Nikos Skalkotos
------
111 b50f3b94 Nikos Skalkotos
112 b50f3b94 Nikos Skalkotos
For *Fedora 17* you can use our official packages hosted at the *synnefo*
113 b50f3b94 Nikos Skalkotos
repository of the openSUSE Build Service.
114 b50f3b94 Nikos Skalkotos
115 b50f3b94 Nikos Skalkotos
Add the *synnefo* repository for *Fedora 17* to *yum*:
116 b50f3b94 Nikos Skalkotos
117 b50f3b94 Nikos Skalkotos
.. code-block:: console
118 b50f3b94 Nikos Skalkotos
119 b50f3b94 Nikos Skalkotos
   $ cd /etc/yum.repos.d
120 b50f3b94 Nikos Skalkotos
   $ wget http://download.opensuse.org/repositories/home:/GRNET:/synnefo/Fedora_17/home:GRNET:synnefo.repo
121 b50f3b94 Nikos Skalkotos
122 b50f3b94 Nikos Skalkotos
To list the *snf-image-creator* package use the following command:
123 b50f3b94 Nikos Skalkotos
124 b50f3b94 Nikos Skalkotos
.. code-block:: console
125 b50f3b94 Nikos Skalkotos
126 b50f3b94 Nikos Skalkotos
   $ yum info snf-image-creator
127 b50f3b94 Nikos Skalkotos
128 b50f3b94 Nikos Skalkotos
Install the package by issuing:
129 b50f3b94 Nikos Skalkotos
130 b50f3b94 Nikos Skalkotos
.. code-block:: console
131 b50f3b94 Nikos Skalkotos
132 b50f3b94 Nikos Skalkotos
   $ yum install snf-image-creator
133 b50f3b94 Nikos Skalkotos
134 b50f3b94 Nikos Skalkotos
CentOS
135 b50f3b94 Nikos Skalkotos
------
136 b50f3b94 Nikos Skalkotos
137 b50f3b94 Nikos Skalkotos
For *CentOS 6* you can use our official packages hosted at the *synnefo*
138 840ccf4b Nikos Skalkotos
repository of the OpenSUSE Build Service.
139 b50f3b94 Nikos Skalkotos
140 b50f3b94 Nikos Skalkotos
Add the *synnefo* repository for *CentOS 6* to the yum repositories list:
141 b50f3b94 Nikos Skalkotos
142 b50f3b94 Nikos Skalkotos
.. code-block:: console
143 b50f3b94 Nikos Skalkotos
144 b50f3b94 Nikos Skalkotos
   $ cd /etc/yum.repos.d
145 b50f3b94 Nikos Skalkotos
   $ wget http://download.opensuse.org/repositories/home:/GRNET:/synnefo/CentOS_CentOS-6/home:GRNET:synnefo.repo
146 b50f3b94 Nikos Skalkotos
147 b50f3b94 Nikos Skalkotos
Check the `Fedora <#fedora>`_ instructions on how to install the software.
148 b50f3b94 Nikos Skalkotos
149 840ccf4b Nikos Skalkotos
OpenSUSE
150 840ccf4b Nikos Skalkotos
--------
151 840ccf4b Nikos Skalkotos
152 840ccf4b Nikos Skalkotos
For *OpenSUSE 12.3* you can use our official packages hosted at the *synnefo*
153 840ccf4b Nikos Skalkotos
repository of the OpenSUSE Build Service.
154 840ccf4b Nikos Skalkotos
155 840ccf4b Nikos Skalkotos
Add the *Virtualization* repository for *OpenSUSE 12.3* to *YaST* with the
156 840ccf4b Nikos Skalkotos
*Zypper* package manager:
157 840ccf4b Nikos Skalkotos
158 840ccf4b Nikos Skalkotos
.. code-block:: console
159 840ccf4b Nikos Skalkotos
160 840ccf4b Nikos Skalkotos
   $ zypper ar -f http://download.opensuse.org/repositories/Virtualization/openSUSE_12.3/Virtualization.repo
161 840ccf4b Nikos Skalkotos
162 840ccf4b Nikos Skalkotos
Add the *synnefo* repository:
163 840ccf4b Nikos Skalkotos
164 840ccf4b Nikos Skalkotos
.. code-block:: console
165 840ccf4b Nikos Skalkotos
166 840ccf4b Nikos Skalkotos
   $ zypper ar -f http://download.opensuse.org/repositories/home:/GRNET:/synnefo/openSUSE_12.3/home:GRNET:synnefo.repo
167 840ccf4b Nikos Skalkotos
168 840ccf4b Nikos Skalkotos
To list the *snf-image-creator* package use the following command:
169 840ccf4b Nikos Skalkotos
170 840ccf4b Nikos Skalkotos
.. code-block:: console
171 840ccf4b Nikos Skalkotos
172 840ccf4b Nikos Skalkotos
   $ zypper se snf-image-creator
173 840ccf4b Nikos Skalkotos
174 840ccf4b Nikos Skalkotos
Install the package by issuing:
175 840ccf4b Nikos Skalkotos
176 840ccf4b Nikos Skalkotos
.. code-block:: console
177 840ccf4b Nikos Skalkotos
178 840ccf4b Nikos Skalkotos
   $ zypper in snf-image-creator
179 840ccf4b Nikos Skalkotos
180 840ccf4b Nikos Skalkotos
181 5aa25240 Nikos Skalkotos
Arch Linux
182 5aa25240 Nikos Skalkotos
----------
183 5aa25240 Nikos Skalkotos
184 5aa25240 Nikos Skalkotos
For *Arch Linux* there are **unofficial** packages in AUR:
185 5aa25240 Nikos Skalkotos
https://aur.archlinux.org/packages/snf-image-creator/ kindly provided by
186 5aa25240 Nikos Skalkotos
Axilleas Pipinellis <axilleas@archlinux.info>.
187 5aa25240 Nikos Skalkotos
188 5aa25240 Nikos Skalkotos
.. note::
189 5aa25240 Nikos Skalkotos
    Those packages are not maintained by the Synnefo development team.
190 5aa25240 Nikos Skalkotos
191 5aa25240 Nikos Skalkotos
    Please direct package-specific questions to Axilleas Pipinellis <axilleas@archlinux.info>,
192 5aa25240 Nikos Skalkotos
    Cc: the Synnefo development team <synnefo-devel@googlegroups.com>
193 5aa25240 Nikos Skalkotos
194 5aa25240 Nikos Skalkotos
To install the package you may use *yaourt*. Create and install
195 5aa25240 Nikos Skalkotos
the *yaourt* package:
196 5aa25240 Nikos Skalkotos
197 5aa25240 Nikos Skalkotos
.. code-block:: console
198 5aa25240 Nikos Skalkotos
199 5aa25240 Nikos Skalkotos
   $ wget https://aur.archlinux.org/packages/pa/package-query/package-query.tar.gz
200 5aa25240 Nikos Skalkotos
   $ tar -xvf package-query.tar.gz
201 5aa25240 Nikos Skalkotos
   $ cd package-query
202 5aa25240 Nikos Skalkotos
   $ makepkg -s
203 5aa25240 Nikos Skalkotos
   $ pacman -U package-query-<VERSION>-<ARCH>.pkg.tar.xz
204 5aa25240 Nikos Skalkotos
   $ cd ..
205 5aa25240 Nikos Skalkotos
   $ wget https://aur.archlinux.org/packages/ya/yaourt/yaourt.tar.gz
206 5aa25240 Nikos Skalkotos
   $ tar -xvf yaourt.tar.gz
207 5aa25240 Nikos Skalkotos
   $ cd yaourt
208 5aa25240 Nikos Skalkotos
   $ makepkg -s
209 5aa25240 Nikos Skalkotos
   $ pacman -U yaourt-<VERSION>-<ARCH>.pkg.tar.xz
210 5aa25240 Nikos Skalkotos
211 5aa25240 Nikos Skalkotos
Install *snf-image-creator* using yaourt:
212 5aa25240 Nikos Skalkotos
213 5aa25240 Nikos Skalkotos
.. code-block:: console
214 5aa25240 Nikos Skalkotos
215 5aa25240 Nikos Skalkotos
   $ yaourt -Sa snf-image-creator
216 5aa25240 Nikos Skalkotos
217 0e8550d6 Alex Pyrgiotis
Install snf-image-creator from source
218 0e8550d6 Alex Pyrgiotis
=====================================
219 0e8550d6 Alex Pyrgiotis
220 afdddc8d Nikos Skalkotos
Manually install the following dependencies:
221 0e8550d6 Alex Pyrgiotis
222 afdddc8d Nikos Skalkotos
 * Python 2 [http://www.python.org/]
223 afdddc8d Nikos Skalkotos
 * Python setuptools [http://pypi.python.org/pypi/setuptools]
224 afdddc8d Nikos Skalkotos
 * Python Dialog [http://pythondialog.sourceforge.net/]
225 afdddc8d Nikos Skalkotos
 * Python bindings for libguestfs [http://libguestfs.org/]
226 afdddc8d Nikos Skalkotos
 * Python interface to sendfile [http://pypi.python.org/pypi/pysendfile]
227 afdddc8d Nikos Skalkotos
 * pyparted [https://fedorahosted.org/pyparted/]
228 aab4b154 Nikos Skalkotos
 * rsync [http://rsync.samba.org/]
229 0e8550d6 Alex Pyrgiotis
230 afdddc8d Nikos Skalkotos
In Ubuntu you can do this using:
231 afdddc8d Nikos Skalkotos
 
232 0e8550d6 Alex Pyrgiotis
.. code-block:: console
233 0e8550d6 Alex Pyrgiotis
234 eb5123b7 Nikos Skalkotos
   $ sudo apt-get install python-setuptools python-guestfs python-dialog \
235 aab4b154 Nikos Skalkotos
     python-sendfile python-parted rsync
236 a2ba6432 Alex Pyrgiotis
237 8c7d7b90 Nikos Skalkotos
If you are using Ubuntu 12.10 you also need to install libguestfs-tools:
238 8c7d7b90 Nikos Skalkotos
239 8c7d7b90 Nikos Skalkotos
.. code-block:: console
240 8c7d7b90 Nikos Skalkotos
241 8c7d7b90 Nikos Skalkotos
   $ sudo apt-get install libguestfs-tools
242 8c7d7b90 Nikos Skalkotos
243 afdddc8d Nikos Skalkotos
.. note::
244 4197b5a6 Nikos Skalkotos
   If you are asked during the installation to create/update a
245 afdddc8d Nikos Skalkotos
   "supermin appliance", choose "Yes".
246 0e8550d6 Alex Pyrgiotis
247 0e8550d6 Alex Pyrgiotis
Python Virtual Environment
248 0e8550d6 Alex Pyrgiotis
--------------------------
249 0e8550d6 Alex Pyrgiotis
250 a2ba6432 Alex Pyrgiotis
Since snf-image-creator and the rest of its dependencies won't be installed
251 0e8550d6 Alex Pyrgiotis
using packages, it's better to work in an isolated python virtual environment
252 afdddc8d Nikos Skalkotos
(virtualenv).
253 afdddc8d Nikos Skalkotos
254 afdddc8d Nikos Skalkotos
Install the Virtual Python Environment builder:
255 afdddc8d Nikos Skalkotos
http://pypi.python.org/pypi/virtualenv.
256 afdddc8d Nikos Skalkotos
257 afdddc8d Nikos Skalkotos
For Ubuntu use the following command:
258 0e8550d6 Alex Pyrgiotis
259 0e8550d6 Alex Pyrgiotis
.. code-block:: console
260 0e8550d6 Alex Pyrgiotis
261 eb5123b7 Nikos Skalkotos
   $ sudo apt-get install python-virtualenv
262 0e8550d6 Alex Pyrgiotis
263 8c7d7b90 Nikos Skalkotos
Then create a new python virtual environment:
264 0e8550d6 Alex Pyrgiotis
265 0e8550d6 Alex Pyrgiotis
.. code-block:: console
266 0e8550d6 Alex Pyrgiotis
267 0e8550d6 Alex Pyrgiotis
   $ virtualenv --system-site-packages ~/image-creator-env
268 0e8550d6 Alex Pyrgiotis
269 0e8550d6 Alex Pyrgiotis
and activate it by executing:
270 0e8550d6 Alex Pyrgiotis
271 0e8550d6 Alex Pyrgiotis
.. code-block:: console
272 0e8550d6 Alex Pyrgiotis
273 0e8550d6 Alex Pyrgiotis
   $ source ~/image-creator-env/bin/activate
274 0e8550d6 Alex Pyrgiotis
275 afdddc8d Nikos Skalkotos
You may later deactivate it using:
276 0e8550d6 Alex Pyrgiotis
277 0e8550d6 Alex Pyrgiotis
.. code-block:: console
278 0e8550d6 Alex Pyrgiotis
279 0e8550d6 Alex Pyrgiotis
   $ deactivate
280 0e8550d6 Alex Pyrgiotis
281 0e8550d6 Alex Pyrgiotis
kamaki Installation
282 0e8550d6 Alex Pyrgiotis
-------------------
283 0e8550d6 Alex Pyrgiotis
284 afdddc8d Nikos Skalkotos
Refer to `./kamaki documentation <http://docs.dev.grnet.gr/kamaki/latest/installation.html>`_
285 8c7d7b90 Nikos Skalkotos
for instructions. You may install kamaki from source inside the virtualenv
286 eb5123b7 Nikos Skalkotos
you've created above or by using binary packages if they are available for your
287 8c7d7b90 Nikos Skalkotos
distribution.
288 0e8550d6 Alex Pyrgiotis
289 afdddc8d Nikos Skalkotos
snf-image-creator Installation
290 afdddc8d Nikos Skalkotos
------------------------------
291 0e8550d6 Alex Pyrgiotis
292 afdddc8d Nikos Skalkotos
Download the latest snf-image-creator source package from
293 afdddc8d Nikos Skalkotos
`here <https://code.grnet.gr/projects/snf-image-creator/files>`_ and install it
294 afdddc8d Nikos Skalkotos
inside the virtualenv using the following commands:
295 0e8550d6 Alex Pyrgiotis
296 0e8550d6 Alex Pyrgiotis
.. code-block:: console
297 0e8550d6 Alex Pyrgiotis
298 afdddc8d Nikos Skalkotos
   $ tar -xf snf_image_creator-<VERSION>.tar.gz
299 afdddc8d Nikos Skalkotos
   $ cd snf_image_creator-<VERSION>
300 eb5123b7 Nikos Skalkotos
   $ python ./setup.py install
301 0e8550d6 Alex Pyrgiotis
302 afdddc8d Nikos Skalkotos
Alternatively, you can install the bleeding edge version of the software by
303 afdddc8d Nikos Skalkotos
cloning its git repository:
304 0e8550d6 Alex Pyrgiotis
305 0e8550d6 Alex Pyrgiotis
.. code-block:: console
306 0e8550d6 Alex Pyrgiotis
307 0e8550d6 Alex Pyrgiotis
   $ git clone https://code.grnet.gr/git/snf-image-creator
308 0e8550d6 Alex Pyrgiotis
   $ cd snf-image-creator
309 afdddc8d Nikos Skalkotos
   $ python ./setup.py install
310 0e8550d6 Alex Pyrgiotis
311 afdddc8d Nikos Skalkotos
To do the latter, you'll need to have git (http://git-scm.com/) installed.
312 afdddc8d Nikos Skalkotos
For ubuntu this can be done using:
313 0e8550d6 Alex Pyrgiotis
314 0e8550d6 Alex Pyrgiotis
.. code-block:: console
315 0e8550d6 Alex Pyrgiotis
316 eb5123b7 Nikos Skalkotos
   $ sudo apt-get install git
317 afdddc8d Nikos Skalkotos
318 afdddc8d Nikos Skalkotos
.. warning::
319 afdddc8d Nikos Skalkotos
   Keep in mind that the bleeding edge version may be unstable or even
320 afdddc8d Nikos Skalkotos
   unusable.