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 - `fdsend Python module <https://gitorious.org/python-fdsend>`_,
47 optional Python package for supporting NIC hotplugging under KVM
48 - `qemu-img <http://qemu.org/>`_, if you want to use ``ovfconverter``
49 - `fping <http://fping.sourceforge.net/>`_
50 - `Python IP address manipulation library
51 <http://code.google.com/p/ipaddr-py/>`_
52 - `Bitarray Python library <http://pypi.python.org/pypi/bitarray/>`_
53 - `GNU Make <http://www.gnu.org/software/make/>`_
54 - `GNU M4 <http://www.gnu.org/software/m4/>`_
56 These programs are supplied as part of most Linux distributions, so
57 usually they can be installed via the standard package manager. Also
58 many of them will already be installed on a standard machine. On
59 Debian/Ubuntu, you can use this command line to install all required
60 packages, except for RBD, DRBD and Xen::
62 $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping make m4 \
63 ndisc6 python python-openssl openssl \
64 python-pyparsing python-simplejson python-bitarray \
65 python-pyinotify python-pycurl python-ipaddr socat fping
67 For older distributions (eg. Debian Squeeze) the package names are
70 $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping make \
71 ndisc6 python python-pyopenssl openssl \
72 python-pyparsing python-simplejson python-bitarray \
73 python-pyinotify python-pycurl python-ipaddr socat fping
75 If bitarray is missing it can be installed from easy-install::
77 $ easy_install bitarray
79 Note that this does not install optional packages::
81 $ apt-get install python-paramiko python-affinity qemu-utils
83 If some of the python packages are not available in your system,
84 you can try installing them using ``easy_install`` command.
87 $ apt-get install python-setuptools python-dev
88 $ cd / && easy_install \
94 On Fedora to install all required packages except RBD, DRBD and Xen::
96 $ yum install openssh openssh-clients bridge-utils iproute ndisc6 make \
97 pyOpenSSL pyparsing python-simplejson python-inotify \
98 python-lxm socat fping python-bitarray python-ipaddr
100 For optional packages use the command::
102 $ yum install python-paramiko python-affinity qemu-img
104 If you want to build from source, please see doc/devnotes.rst for more
109 Ganeti's import/export functionality uses ``socat`` with OpenSSL for
110 transferring data between nodes. By default, OpenSSL 0.9.8 and above
111 employ transparent compression of all data using zlib if supported by
112 both sides of a connection. In cases where a lot of data is
113 transferred, this can lead to an increased CPU usage. Additionally,
114 Ganeti already compresses all data using ``gzip`` where it makes sense
115 (for inter-cluster instance moves).
117 To remedey this situation, patches implementing a new ``socat`` option
118 for disabling OpenSSL compression have been contributed and will
119 likely be included in the next feature release. Until then, users or
120 distributions need to apply the patches on their own.
122 Ganeti will use the option if it's detected by the ``configure``
123 script; auto-detection can be disabled by explicitly passing
124 ``--enable-socat-compress`` (use the option to disable compression) or
125 ``--disable-socat-compress`` (don't use the option).
127 The patches and more information can be found on
128 http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
133 Starting with Ganeti 2.7, the Haskell GHC compiler and a few base
134 libraries are required in order to build Ganeti (but not to run and
135 deploy Ganeti on production machines). More specifically:
137 - `GHC <http://www.haskell.org/ghc/>`_ version 6.12 or higher
138 - or even better, `The Haskell Platform
139 <http://hackage.haskell.org/platform/>`_ which gives you a simple way
141 - `json <http://hackage.haskell.org/package/json>`_, a JSON library
142 - `network <http://hackage.haskell.org/package/network>`_, a basic
144 - `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
145 programming library (note: tested with up to version 3.x)
146 - `bytestring <http://hackage.haskell.org/package/bytestring>`_ and
147 `utf8-string <http://hackage.haskell.org/package/utf8-string>`_
148 libraries; these usually come with the GHC compiler
149 - `deepseq <http://hackage.haskell.org/package/deepseq>`_
150 - `curl <http://hackage.haskell.org/package/curl>`_, tested with
151 versions 1.3.4 and above
152 - `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
153 above (note that Debian Squeeze only has version 1.0.9)
155 Some of these are also available as package in Debian/Ubuntu::
157 $ apt-get install ghc libghc-json-dev libghc-network-dev \
158 libghc-parallel-dev libghc-deepseq-dev \
159 libghc-utf8-string-dev libghc-curl-dev \
162 Or in older versions of these distributions (using GHC 6.x)::
164 $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
165 libghc6-parallel-dev libghc6-deepseq-dev \
168 In Fedora, some of them are available via packages as well::
170 $ yum install ghc ghc-json-devel ghc-network-devel \
171 ghc-parallel-devel ghc-deepseq-devel
173 If using a distribution which does not provide them, first install
174 the Haskell platform. You can also install ``cabal`` manually::
176 $ apt-get install cabal-install
179 Then install the additional libraries (only the ones not available in your
180 distribution packages) via ``cabal``::
182 $ cabal install json network parallel utf8-string curl hslogger
184 Haskell optional features
185 ~~~~~~~~~~~~~~~~~~~~~~~~~
187 Optionally, more functionality can be enabled if your build machine has
188 a few more Haskell libraries enabled: the ``ganeti-confd`` and
189 ``ganeti-luxid`` daemon (``--enable-confd``) and the monitoring daemon
190 (``--enable-mond``). The list of extra dependencies for these is:
192 - `Crypto <http://hackage.haskell.org/package/Crypto>`_, tested with
194 - `text <http://hackage.haskell.org/package/text>`_
195 - `hinotify <http://hackage.haskell.org/package/hinotify>`_, tested with
197 - `regex-pcre <http://hackage.haskell.org/package/regex-pcre>`_,
198 bindings for the ``pcre`` library
199 - `attoparsec <http://hackage.haskell.org/package/attoparsec>`_
200 - `vector <http://hackage.haskell.org/package/vector>`_
201 - `snap-server` <http://hackage.haskell.org/package/snap-server>`_, version
203 - `process <http://hackage.haskell.org/package/process>`_, version 1.0.1.1 and
206 These libraries are available in Debian Wheezy (but not in Squeeze), so you
209 $ apt-get install libghc-crypto-dev libghc-text-dev \
210 libghc-hinotify-dev libghc-regex-pcre-dev \
212 libghc-attoparsec-dev libghc-vector-dev \
213 libghc-snap-server-dev
215 or ``cabal``, after installing a required non-Haskell dependency::
217 $ apt-get install libpcre3-dev libcurl4-openssl-dev
218 $ cabal install Crypto text hinotify==0.3.2 regex-pcre \
219 attoparsec vector snap-server
223 In case you still use ghc-6.12, note that ``cabal`` would automatically try to
224 install newer versions of some of the libraries snap-server depends on, that
225 cannot be compiled with ghc-6.12, so you have to install snap-server on its
226 own, explicitly forcing the installation of compatible versions::
228 $ cabal install MonadCatchIO-transformers==0.2.2.0 mtl==2.0.1.0 \
229 hashable==1.1.2.0 case-insensitive==0.3 parsec==3.0.1 \
230 network==2.3 snap-server==0.8.1
232 The most recent Fedora doesn't provide ``crypto``, ``inotify``. So these
233 need to be installed using ``cabal``, if desired. The other packages can
234 be installed via ``yum``::
236 $ yum install ghc-hslogger-devel ghc-text-devel \
241 If one of the cabal packages fails to install due to unfulfilled
242 dependencies, you can try enabling symlinks in ``~/.cabal/config``.
244 Make sure that your ``~/.cabal/bin`` directory (or whatever else
245 is defined as ``bindir``) is in your ``PATH``.
247 Installation of the software
248 ----------------------------
250 To install, simply run the following command::
252 $ ./configure --localstatedir=/var --sysconfdir=/etc && \
256 This will install the software under ``/usr/local``. You then need to
257 copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
258 integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
262 Cluster initialisation
263 ----------------------
265 Before initialising the cluster, on each node you need to create the
266 following directories:
269 - ``/var/lib/ganeti``
270 - ``/var/log/ganeti``
273 - ``/srv/ganeti/export``
275 After this, use ``gnt-cluster init``.
277 .. vim: set textwidth=72 syntax=rst :