1 Ganeti quick installation guide
2 ===============================
4 Please note that a more detailed installation procedure is described in
5 the :doc:`install`. Refer to it if you are setting up Ganeti the first time.
6 This quick installation guide is mainly meant as reference for experienced
7 users. A glossary of terms can be found in the :doc:`glossary`.
13 .. highlight:: shell-example
15 Before installing, please verify that you have the following programs:
17 - `Xen Hypervisor <http://www.xen.org/>`_, version 3.0 or above, if
19 - `KVM Hypervisor <http://www.linux-kvm.org>`_, version 72 or above, if
20 running on KVM. In order to use advanced features, such as live
21 migration, virtio, etc, an even newer version is recommended (qemu-kvm
22 versions 0.11.X and above have shown good behavior).
23 - `DRBD <http://www.drbd.org/>`_, kernel module and userspace utils,
24 version 8.0.7 or above; note that Ganeti doesn't yet support version 8.4
25 - `RBD <http://ceph.newdream.net/>`_, kernel modules
26 (``rbd.ko``/``libceph.ko``) and userspace utils (``ceph-common``)
27 - `LVM2 <http://sourceware.org/lvm2/>`_
28 - `OpenSSH <http://www.openssh.com/portable.html>`_
29 - `bridge utilities <http://www.linuxfoundation.org/en/Net:Bridge>`_
30 - `iproute2 <http://www.linuxfoundation.org/en/Net:Iproute2>`_
31 - `arping <http://www.skbuff.net/iputils/>`_ (part of iputils)
32 - `ndisc6 <http://www.remlab.net/ndisc6/>`_ (if using IPv6)
33 - `Python <http://www.python.org/>`_, version 2.6 or above, not 3.0
34 - `Python OpenSSL bindings <http://pyopenssl.sourceforge.net/>`_
35 - `simplejson Python module <http://code.google.com/p/simplejson/>`_
36 - `pyparsing Python module <http://pyparsing.wikispaces.com/>`_, version
38 - `pyinotify Python module <https://github.com/seb-m/pyinotify>`_
39 - `PycURL Python module <http://pycurl.sourceforge.net/>`_
40 - `socat <http://www.dest-unreach.org/socat/>`_, see :ref:`note
42 - `Paramiko <http://www.lag.net/paramiko/>`_, if you want to use
44 - `affinity Python module <http://pypi.python.org/pypi/affinity/0.1.0>`_,
45 optional python package for supporting CPU pinning under KVM
46 - `qemu-img <http://qemu.org/>`_, if you want to use ``ovfconverter``
47 - `fping <http://fping.sourceforge.net/>`_
48 - `Python IP address manipulation library
49 <http://code.google.com/p/ipaddr-py/>`_
50 - `Bitarray Python library <http://pypi.python.org/pypi/bitarray/>`_
51 - `GNU Make <http://www.gnu.org/software/make/>`_
53 These programs are supplied as part of most Linux distributions, so
54 usually they can be installed via the standard package manager. Also
55 many of them will already be installed on a standard machine. On
56 Debian/Ubuntu, you can use this command line to install all required
57 packages, except for RBD, DRBD and Xen::
59 $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping make \
60 ndisc6 python python-openssl openssl \
61 python-pyparsing python-simplejson python-bitarray \
62 python-pyinotify python-pycurl python-ipaddr socat fping
64 For older distributions (eg. Debian Squeeze) the package names are
67 $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping make \
68 ndisc6 python python-pyopenssl openssl \
69 python-pyparsing python-simplejson python-bitarray \
70 python-pyinotify python-pycurl python-ipaddr socat fping
72 If bitarray is missing it can be installed from easy-install::
74 $ easy_install bitarray
76 Note that this does not install optional packages::
78 $ apt-get install python-paramiko python-affinity qemu-img
80 If some of the python packages are not available in your system,
81 you can try installing them using ``easy_install`` command.
84 $ apt-get install python-setuptools python-dev
85 $ cd / && sudo easy_install \
91 On Fedora to install all required packages except RBD, DRBD and Xen::
93 $ yum install openssh openssh-clients bridge-utils iproute ndisc6 make \
94 pyOpenSSL pyparsing python-simplejson python-inotify \
95 python-lxm socat fping python-bitarray python-ipaddr
97 For optional packages use the command::
99 $ yum install python-paramiko python-affinity qemu-img
101 If you want to build from source, please see doc/devnotes.rst for more
106 Ganeti's import/export functionality uses ``socat`` with OpenSSL for
107 transferring data between nodes. By default, OpenSSL 0.9.8 and above
108 employ transparent compression of all data using zlib if supported by
109 both sides of a connection. In cases where a lot of data is
110 transferred, this can lead to an increased CPU usage. Additionally,
111 Ganeti already compresses all data using ``gzip`` where it makes sense
112 (for inter-cluster instance moves).
114 To remedey this situation, patches implementing a new ``socat`` option
115 for disabling OpenSSL compression have been contributed and will
116 likely be included in the next feature release. Until then, users or
117 distributions need to apply the patches on their own.
119 Ganeti will use the option if it's detected by the ``configure``
120 script; auto-detection can be disabled by explicitly passing
121 ``--enable-socat-compress`` (use the option to disable compression) or
122 ``--disable-socat-compress`` (don't use the option).
124 The patches and more information can be found on
125 http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
130 Starting with Ganeti 2.7, the Haskell GHC compiler and a few base
131 libraries are required in order to build Ganeti (but not to run and
132 deploy Ganeti on production machines). More specifically:
134 - `GHC <http://www.haskell.org/ghc/>`_ version 6.12 or higher
135 - or even better, `The Haskell Platform
136 <http://hackage.haskell.org/platform/>`_ which gives you a simple way
138 - `json <http://hackage.haskell.org/package/json>`_, a JSON library
139 - `network <http://hackage.haskell.org/package/network>`_, a basic
141 - `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
142 programming library (note: tested with up to version 3.x)
143 - `bytestring <http://hackage.haskell.org/package/bytestring>`_ and
144 `utf8-string <http://hackage.haskell.org/package/utf8-string>`_
145 libraries; these usually come with the GHC compiler
146 - `deepseq <http://hackage.haskell.org/package/deepseq>`_
147 - `curl <http://hackage.haskell.org/package/curl>`_, tested with
148 versions 1.3.4 and above
149 - `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
150 above (note that Debian Squeeze only has version 1.0.9)
152 Some of these are also available as package in Debian/Ubuntu::
154 $ apt-get install ghc libghc-json-dev libghc-network-dev \
155 libghc-parallel-dev libghc-deepseq-dev \
156 libghc-utf8-string-dev libghc-curl-dev \
159 Or in older versions of these distributions (using GHC 6.x)::
161 $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
162 libghc6-parallel-dev libghc6-deepseq-dev \
165 In Fedora, some of them are available via packages as well::
167 $ yum install ghc ghc-json-devel ghc-network-devel \
168 ghc-parallel-devel ghc-deepseq-devel
170 If using a distribution which does not provide them, first install
171 the Haskell platform. You can also install ``cabal`` manually::
173 $ apt-get install cabal-install
176 Then install the additional libraries (only the ones not available in your
177 distribution packages) via ``cabal``::
179 $ cabal install json network parallel utf8-string curl hslogger
181 Haskell optional features
182 ~~~~~~~~~~~~~~~~~~~~~~~~~
184 Optionally, more functionality can be enabled if your build machine has
185 a few more Haskell libraries enabled: the ``ganeti-confd`` and
186 ``ganeti-luxid`` daemon (``--enable-confd``) and the monitoring daemon
187 (``--enable-mond``). The list of extra dependencies for these is:
189 - `Crypto <http://hackage.haskell.org/package/Crypto>`_, tested with
191 - `text <http://hackage.haskell.org/package/text>`_
192 - `hinotify <http://hackage.haskell.org/package/hinotify>`_, tested with
194 - `regex-pcre <http://hackage.haskell.org/package/regex-pcre>`_,
195 bindings for the ``pcre`` library
196 - `attoparsec <http://hackage.haskell.org/package/attoparsec>`_
197 - `vector <http://hackage.haskell.org/package/vector>`_
198 - `snap-server` <http://hackage.haskell.org/package/snap-server>`_, version
200 - `process <http://hackage.haskell.org/package/process>`_, version 1.0.1.1 and
203 These libraries are available in Debian Wheezy (but not in Squeeze), so you
206 $ apt-get install libghc-crypto-dev libghc-text-dev \
207 libghc-hinotify-dev libghc-regex-pcre-dev \
208 libghc-attoparsec-dev libghc-vector-dev \
209 libghc-snap-server-dev
211 or ``cabal``, after installing a required non-Haskell dependency::
213 $ apt-get install libpcre3-dev libcurl4-openssl-dev
214 $ cabal install Crypto text hinotify==0.3.2 regex-pcre \
215 attoparsec vector snap-server
219 In case you still use ghc-6.12, note that ``cabal`` would automatically try to
220 install newer versions of some of the libraries snap-server depends on, that
221 cannot be compiled with ghc-6.12, so you have to install snap-server on its
222 own, esplicitly forcing the installation of compatible versions::
224 $ cabal install MonadCatchIO-transformers==0.2.2.0 mtl==2.0.1.0 \
225 hashable==1.1.2.0 case-insensitive==0.3 parsec==3.0.1 \
226 network==2.3 snap-server==0.8.1
228 The most recent Fedora doesn't provide ``crypto``, ``inotify``. So these
229 need to be installed using ``cabal``, if desired. The other packages can
230 be installed via ``yum``::
232 $ yum install ghc-hslogger-devel ghc-text-devel \
237 If one of the cabal packages fails to install due to unfulfilled
238 dependencies, you can try enabling symlinks in ``~/.cabal/config``.
240 Make sure that your ``~/.cabal/bin`` directory (or whatever else
241 is defined as ``bindir``) is in your ``PATH``.
243 Installation of the software
244 ----------------------------
246 To install, simply run the following command::
248 $ ./configure --localstatedir=/var --sysconfdir=/etc && \
252 This will install the software under ``/usr/local``. You then need to
253 copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
254 integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
258 Cluster initialisation
259 ----------------------
261 Before initialising the cluster, on each node you need to create the
262 following directories:
265 - ``/var/lib/ganeti``
266 - ``/var/log/ganeti``
269 - ``/srv/ganeti/export``
271 After this, use ``gnt-cluster init``.
273 .. vim: set textwidth=72 syntax=rst :