1 Ganeti quick installation guide
2 ===============================
4 Please note that a more detailed installation procedure is described in
5 the :doc:`install`. A glossary of terms can be found in the
12 .. highlight:: shell-example
14 Before installing, please verify that you have the following programs:
16 - `Xen Hypervisor <http://www.xen.org/>`_, version 3.0 or above, if
18 - `KVM Hypervisor <http://www.linux-kvm.org>`_, version 72 or above, if
19 running on KVM. In order to use advanced features, such as live
20 migration, virtio, etc, an even newer version is recommended (qemu-kvm
21 versions 0.11.X and above have shown good behavior).
22 - `DRBD <http://www.drbd.org/>`_, kernel module and userspace utils,
23 version 8.0.7 or above; note that Ganeti doesn't yet support version 8.4
24 - `RBD <http://ceph.newdream.net/>`_, kernel modules
25 (``rbd.ko``/``libceph.ko``) and userspace utils (``ceph-common``)
26 - `LVM2 <http://sourceware.org/lvm2/>`_
27 - `OpenSSH <http://www.openssh.com/portable.html>`_
28 - `bridge utilities <http://www.linuxfoundation.org/en/Net:Bridge>`_
29 - `iproute2 <http://www.linuxfoundation.org/en/Net:Iproute2>`_
30 - `arping <http://www.skbuff.net/iputils/>`_ (part of iputils)
31 - `ndisc6 <http://www.remlab.net/ndisc6/>`_ (if using IPv6)
32 - `Python <http://www.python.org/>`_, version 2.6 or above, not 3.0
33 - `Python OpenSSL bindings <http://pyopenssl.sourceforge.net/>`_
34 - `simplejson Python module <http://code.google.com/p/simplejson/>`_
35 - `pyparsing Python module <http://pyparsing.wikispaces.com/>`_, version
37 - `pyinotify Python module <https://github.com/seb-m/pyinotify>`_
38 - `PycURL Python module <http://pycurl.sourceforge.net/>`_
39 - `socat <http://www.dest-unreach.org/socat/>`_, see :ref:`note
41 - `Paramiko <http://www.lag.net/paramiko/>`_, if you want to use
43 - `affinity Python module <http://pypi.python.org/pypi/affinity/0.1.0>`_,
44 optional python package for supporting CPU pinning under KVM
45 - `qemu-img <http://qemu.org/>`_, if you want to use ``ovfconverter``
46 - `fping <http://fping.sourceforge.net/>`_
47 - `Python IP address manipulation library
48 <http://code.google.com/p/ipaddr-py/>`_
49 - `Bitarray Python library <http://pypi.python.org/pypi/bitarray/>`_
51 These programs are supplied as part of most Linux distributions, so
52 usually they can be installed via the standard package manager. Also
53 many of them will already be installed on a standard machine. On
54 Debian/Ubuntu, you can use this command line to install all required
55 packages, except for RBD, DRBD and Xen::
57 $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
58 ndisc6 python python-pyopenssl openssl \
59 python-pyparsing python-simplejson \
60 python-pyinotify python-pycurl socat fping
62 Note that this does not install optional packages::
64 $ apt-get install python-paramiko python-affinity qemu-img
66 If some of the python packages are not available in your system,
67 you can try installing them using ``easy_install`` command.
70 $ apt-get install python-setuptools
71 $ cd / && sudo easy_install \
75 On Fedora to install all required packages except RBD, DRBD and Xen::
77 $ yum install openssh openssh-clients bridge-utils iproute ndisc6 \
78 pyOpenSSL pyparsing python-simplejson python-inotify \
79 python-lxm socat fping
81 For optional packages use the command::
83 $ yum install python-paramiko python-affinity qemu-img
85 If you want to build from source, please see doc/devnotes.rst for more
90 Ganeti's import/export functionality uses ``socat`` with OpenSSL for
91 transferring data between nodes. By default, OpenSSL 0.9.8 and above
92 employ transparent compression of all data using zlib if supported by
93 both sides of a connection. In cases where a lot of data is
94 transferred, this can lead to an increased CPU usage. Additionally,
95 Ganeti already compresses all data using ``gzip`` where it makes sense
96 (for inter-cluster instance moves).
98 To remedey this situation, patches implementing a new ``socat`` option
99 for disabling OpenSSL compression have been contributed and will
100 likely be included in the next feature release. Until then, users or
101 distributions need to apply the patches on their own.
103 Ganeti will use the option if it's detected by the ``configure``
104 script; auto-detection can be disabled by explicitly passing
105 ``--enable-socat-compress`` (use the option to disable compression) or
106 ``--disable-socat-compress`` (don't use the option).
108 The patches and more information can be found on
109 http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
114 Starting with Ganeti 2.7, the Haskell GHC compiler and a few base
115 libraries are required in order to build Ganeti (but not to run and
116 deploy Ganeti on production machines). More specifically:
118 - `GHC <http://www.haskell.org/ghc/>`_ version 6.12 or higher
119 - or even better, `The Haskell Platform
120 <http://hackage.haskell.org/platform/>`_ which gives you a simple way
122 - `json <http://hackage.haskell.org/package/json>`_, a JSON library
123 - `network <http://hackage.haskell.org/package/network>`_, a basic
125 - `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
126 programming library (note: tested with up to version 3.x)
127 - `bytestring <http://hackage.haskell.org/package/bytestring>`_ and
128 `utf8-string <http://hackage.haskell.org/package/utf8-string>`_
129 libraries; these usually come with the GHC compiler
130 - `deepseq <http://hackage.haskell.org/package/deepseq>`_
131 - `curl <http://hackage.haskell.org/package/curl>`_, tested with
132 versions 1.3.4 and above
134 Some of these are also available as package in Debian/Ubuntu::
136 $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
137 libghc6-parallel-dev libghc6-deepseq-dev \
140 Or in newer versions of these distributions (using GHC 7.x)::
142 $ apt-get install ghc libghc-json-dev libghc-network-dev \
143 libghc-parallel-dev libghc-deepseq-dev \
144 libghc-utf8-string-dev libghc-curl-dev
146 In Fedora, some of them are available via packages as well::
148 $ yum install ghc ghc-json-devel ghc-network-devel \
149 ghc-parallel-devel ghc-deepseq-devel
151 If using a distribution which does not provide them, first install
152 the Haskell platform. You can also install ``cabal`` manually::
154 $ apt-get install cabal-install
156 Then install the additional libraries via
159 $ cabal install json network parallel utf8-string curl
161 Haskell optional features
162 ~~~~~~~~~~~~~~~~~~~~~~~~~
164 Optionally, more functionality can be enabled if your build machine has
165 a few more Haskell libraries enabled: the ``ganeti-confd`` daemon
166 (``--enable-confd``) and the monitoring agent
167 (``--enable-monitoring``). The list of extra dependencies for these is:
169 - `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
170 above (note that Debian Squeeze only has version 1.0.9)
171 - `Crypto <http://hackage.haskell.org/package/Crypto>`_, tested with
173 - `text <http://hackage.haskell.org/package/text>`_
174 - `hinotify <http://hackage.haskell.org/package/hinotify>`_, tested with
176 - `regex-pcre <http://hackage.haskell.org/package/regex-pcre>`_,
177 bindings for the ``pcre`` library
178 - `attoparsec <http://hackage.haskell.org/package/attoparsec>`_
179 - `vector <http://hackage.haskell.org/package/vector>`_
181 These libraries are available in Debian Wheezy (but not in Squeeze, with
182 the exception of curl), so you can use either apt::
184 $ apt-get install libghc-hslogger-dev libghc-crypto-dev libghc-text-dev \
185 libghc-hinotify-dev libghc-regex-pcre-dev \
186 libghc-attoparsec-dev libghc-vector-dev
190 $ cabal install hslogger Crypto text hinotify regex-pcre \
195 The most recent Fedora doesn't provide ``crypto``, ``inotify``. So these
196 need to be installed using ``cabal``, if desired. The other packages can
197 be installed via ``yum``::
199 $ yum install ghc-hslogger-devel ghc-text-devel \
204 If one of the cabal packages fails to install due to unfulfilled
205 dependencies, you can try enabling symlinks in ``~/.cabal/config``.
207 Make sure that your ``~/.cabal/bin`` directory (or whatever else
208 is defined as ``bindir``) is in your ``PATH``.
210 Installation of the software
211 ----------------------------
213 To install, simply run the following command::
215 $ ./configure --localstatedir=/var --sysconfdir=/etc && \
219 This will install the software under ``/usr/local``. You then need to
220 copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
221 integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
225 Cluster initialisation
226 ----------------------
228 Before initialising the cluster, on each node you need to create the
229 following directories:
232 - ``/var/lib/ganeti``
233 - ``/var/log/ganeti``
236 - ``/srv/ganeti/export``
238 After this, use ``gnt-cluster init``.
240 .. vim: set textwidth=72 syntax=rst :