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 \
61 python-ipaddr python-bitarray
63 Note that this does not install optional packages::
65 $ apt-get install python-paramiko python-affinity qemu-img
67 If some of the python packages are not available in your system,
68 you can try installing them using ``easy_install`` command.
71 $ apt-get install python-setuptools python-dev
72 $ cd / && sudo easy_install \
78 On Fedora to install all required packages except RBD, DRBD and Xen::
80 $ yum install openssh openssh-clients bridge-utils iproute ndisc6 \
81 pyOpenSSL pyparsing python-simplejson python-inotify \
82 python-lxm socat fping python-bitarray python-ipaddr
84 For optional packages use the command::
86 $ yum install python-paramiko python-affinity qemu-img
88 If you want to build from source, please see doc/devnotes.rst for more
93 Ganeti's import/export functionality uses ``socat`` with OpenSSL for
94 transferring data between nodes. By default, OpenSSL 0.9.8 and above
95 employ transparent compression of all data using zlib if supported by
96 both sides of a connection. In cases where a lot of data is
97 transferred, this can lead to an increased CPU usage. Additionally,
98 Ganeti already compresses all data using ``gzip`` where it makes sense
99 (for inter-cluster instance moves).
101 To remedey this situation, patches implementing a new ``socat`` option
102 for disabling OpenSSL compression have been contributed and will
103 likely be included in the next feature release. Until then, users or
104 distributions need to apply the patches on their own.
106 Ganeti will use the option if it's detected by the ``configure``
107 script; auto-detection can be disabled by explicitly passing
108 ``--enable-socat-compress`` (use the option to disable compression) or
109 ``--disable-socat-compress`` (don't use the option).
111 The patches and more information can be found on
112 http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
117 Starting with Ganeti 2.7, the Haskell GHC compiler and a few base
118 libraries are required in order to build Ganeti (but not to run and
119 deploy Ganeti on production machines). More specifically:
121 - `GHC <http://www.haskell.org/ghc/>`_ version 6.12 or higher
122 - or even better, `The Haskell Platform
123 <http://hackage.haskell.org/platform/>`_ which gives you a simple way
125 - `json <http://hackage.haskell.org/package/json>`_, a JSON library
126 - `network <http://hackage.haskell.org/package/network>`_, a basic
128 - `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
129 programming library (note: tested with up to version 3.x)
130 - `bytestring <http://hackage.haskell.org/package/bytestring>`_ and
131 `utf8-string <http://hackage.haskell.org/package/utf8-string>`_
132 libraries; these usually come with the GHC compiler
133 - `deepseq <http://hackage.haskell.org/package/deepseq>`_
134 - `curl <http://hackage.haskell.org/package/curl>`_, tested with
135 versions 1.3.4 and above
137 Some of these are also available as package in Debian/Ubuntu::
139 $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
140 libghc6-parallel-dev libghc6-deepseq-dev \
143 Or in newer versions of these distributions (using GHC 7.x)::
145 $ apt-get install ghc libghc-json-dev libghc-network-dev \
146 libghc-parallel-dev libghc-deepseq-dev \
147 libghc-utf8-string-dev libghc-curl-dev
149 In Fedora, some of them are available via packages as well::
151 $ yum install ghc ghc-json-devel ghc-network-devel \
152 ghc-parallel-devel ghc-deepseq-devel
154 If using a distribution which does not provide them, first install
155 the Haskell platform. You can also install ``cabal`` manually::
157 $ apt-get install cabal-install
159 Then install the additional libraries via
162 $ cabal install json network parallel utf8-string curl
164 Haskell optional features
165 ~~~~~~~~~~~~~~~~~~~~~~~~~
167 Optionally, more functionality can be enabled if your build machine has
168 a few more Haskell libraries enabled: the ``ganeti-confd`` daemon
169 (``--enable-confd``) and the monitoring daemon
170 (``--enable-mond``). The list of extra dependencies for these is:
172 - `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
173 above (note that Debian Squeeze only has version 1.0.9)
174 - `Crypto <http://hackage.haskell.org/package/Crypto>`_, tested with
176 - `text <http://hackage.haskell.org/package/text>`_
177 - `hinotify <http://hackage.haskell.org/package/hinotify>`_, tested with
179 - `regex-pcre <http://hackage.haskell.org/package/regex-pcre>`_,
180 bindings for the ``pcre`` library
181 - `attoparsec <http://hackage.haskell.org/package/attoparsec>`_
182 - `vector <http://hackage.haskell.org/package/vector>`_
183 - `snap-server` <http://hackage.haskell.org/package/snap-server>`_, version
186 These libraries are available in Debian Wheezy (but not in Squeeze), so you
189 $ apt-get install libghc-hslogger-dev libghc-crypto-dev libghc-text-dev \
190 libghc-hinotify-dev libghc-regex-pcre-dev \
191 libghc-attoparsec-dev libghc-vector-dev \
192 libghc-snap-server-dev
194 or ``cabal``, after installing a required non-Haskell dependency::
196 $ apt-get install libpcre3-dev
197 $ cabal install hslogger Crypto text hinotify regex-pcre \
198 attoparsec vector snap-server
202 In case you still use ghc-6.12, note that ``cabal`` would automatically try to
203 install newer versions of some of the libraries snap-server depends on, that
204 cannot be compiled with ghc-6.12, so you have to install snap-server on its
205 own, esplicitly forcing the installation of compatible versions::
207 $ cabal install MonadCatchIO-transformers==0.2.2.0 mtl==2.0.1.0 \
208 hashable==1.1.2.0 case-insensitive==0.3 parsec==3.0.1 \
209 network==2.3 snap-server==0.8.1
211 The most recent Fedora doesn't provide ``crypto``, ``inotify``. So these
212 need to be installed using ``cabal``, if desired. The other packages can
213 be installed via ``yum``::
215 $ yum install ghc-hslogger-devel ghc-text-devel \
220 If one of the cabal packages fails to install due to unfulfilled
221 dependencies, you can try enabling symlinks in ``~/.cabal/config``.
223 Make sure that your ``~/.cabal/bin`` directory (or whatever else
224 is defined as ``bindir``) is in your ``PATH``.
226 Installation of the software
227 ----------------------------
229 To install, simply run the following command::
231 $ ./configure --localstatedir=/var --sysconfdir=/etc && \
235 This will install the software under ``/usr/local``. You then need to
236 copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
237 integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
241 Cluster initialisation
242 ----------------------
244 Before initialising the cluster, on each node you need to create the
245 following directories:
248 - ``/var/lib/ganeti``
249 - ``/var/log/ganeti``
252 - ``/srv/ganeti/export``
254 After this, use ``gnt-cluster init``.
256 .. vim: set textwidth=72 syntax=rst :