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.4 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 <http://trac.dbzteam.org/pyinotify/>`_
38 - `PycURL Python module <http://pycurl.sourceforge.net/>`_
39 - `ctypes Python module
40 <http://starship.python.net/crew/theller/ctypes/>`_, if running on
41 python 2.4 (optional, used for node daemon memory locking)
42 - `socat <http://www.dest-unreach.org/socat/>`_, see :ref:`note
44 - `Paramiko <http://www.lag.net/paramiko/>`_, if you want automated SSH
45 setup; optional otherwise but manual setup of the nodes required
46 - `affinity Python module <http://pypi.python.org/pypi/affinity/0.1.0>`_,
47 optional python package for supporting CPU pinning under KVM
48 - `ElementTree Python module <http://effbot.org/zone/element-index.htm>`_,
49 if running on python 2.4 (optional, used by the ``ovfconverter`` tool)
50 - `qemu-img <http://qemu.org/>`_, if you want to use ``ovfconverter``
51 - `fping <http://fping.sourceforge.net/>`_
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 \
60 ndisc6 python python-pyopenssl openssl \
61 python-pyparsing python-simplejson \
62 python-pyinotify python-pycurl socat fping
64 Note that this does not install optional packages::
66 $ apt-get install python-paramiko python-affinity qemu-img
68 If some of the python packages are not available in your system,
69 you can try installing them using ``easy_install`` command.
72 $ apt-get install python-setuptools
73 $ cd / && sudo easy_install \
77 On Fedora to install all required packages except RBD, DRBD and Xen::
79 $ yum install openssh openssh-clients bridge-utils iproute ndisc6 \
80 pyOpenSSL pyparsing python-simplejson python-inotify \
81 python-lxm socat fping
83 For optional packages use the command::
85 $ yum install python-paramiko python-affinity qemu-img
87 If you want to build from source, please see doc/devnotes.rst for more
92 Ganeti's import/export functionality uses ``socat`` with OpenSSL for
93 transferring data between nodes. By default, OpenSSL 0.9.8 and above
94 employ transparent compression of all data using zlib if supported by
95 both sides of a connection. In cases where a lot of data is
96 transferred, this can lead to an increased CPU usage. Additionally,
97 Ganeti already compresses all data using ``gzip`` where it makes sense
98 (for inter-cluster instance moves).
100 To remedey this situation, patches implementing a new ``socat`` option
101 for disabling OpenSSL compression have been contributed and will
102 likely be included in the next feature release. Until then, users or
103 distributions need to apply the patches on their own.
105 Ganeti will use the option if it's detected by the ``configure``
106 script; auto-detection can be disabled by explicitly passing
107 ``--enable-socat-compress`` (use the option to disable compression) or
108 ``--disable-socat-compress`` (don't use the option).
110 The patches and more information can be found on
111 http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
116 If you want to enable the `htools` component, which is recommended on
117 bigger deployments (this give you automatic instance placement, cluster
118 balancing, etc.), then you need to have a Haskell compiler installed on
119 your build machine (but this is not required on the machines which are
120 just going to run Ganeti). More specifically:
122 - `GHC <http://www.haskell.org/ghc/>`_ version 6.12 or higher
123 - or even better, `The Haskell Platform
124 <http://hackage.haskell.org/platform/>`_ which gives you a simple way
126 - `json <http://hackage.haskell.org/package/json>`_, a JSON library
127 - `network <http://hackage.haskell.org/package/network>`_, a basic
129 - `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
130 programming library (note: tested with up to version 3.x)
131 - `curl <http://hackage.haskell.org/package/curl>`_, bindings for the
132 curl library, only needed if you want these tools to connect to remote
133 clusters (as opposed to the local one)
134 - `bytestring <http://hackage.haskell.org/package/bytestring>`_ and
135 `utf8-string <http://hackage.haskell.org/package/utf8-string>`_
136 libraries; these usually come with the GHC compiler
137 - `regex-pcre <http://hackage.haskell.org/package/regex-pcre>`_,
138 bindings for the ``pcre`` library
140 Some of these are also available as package in Debian/Ubuntu::
142 $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
143 libghc6-parallel-dev libghc6-curl-dev
145 Or in Fedora running::
147 $ yum install ghc ghc-json-devel ghc-network-devel ghc-parallel-devel
149 The most recent Fedora doesn't provide ``ghc-curl``. So this needs to be
150 installed using ``cabal`` or alternatively htools can be build without
153 Note that more recent version have switched to GHC 7.x and the packages
156 $ apt-get install ghc libghc-json-dev libghc-network-dev \
157 libghc-parallel-dev libghc-curl-dev \
158 libghc-regex-pcre-dev
160 If using a distribution which does not provide them, first install
161 the Haskell platform. You can also install ``cabal`` manualy::
163 $ apt-get install cabal-install
165 Then install the additional libraries via
168 $ cabal install json network parallel curl regex-pcre
170 The compilation of the htools components is automatically enabled when
171 the compiler and the requisite libraries are found. You can use the
172 ``--enable-htools`` configure flag to force the selection (at which
173 point ``./configure`` will fail if it doesn't find the prerequisites).
175 In Ganeti version 2.6, one of the daemons (``ganeti-confd``) is shipped
176 in two versions: the Python default version (which has no extra
177 dependencies), and an experimental Haskell version. This latter version
178 can be enabled via the ``./configure`` flag ``--enable-confd=haskell``
179 and a few has extra dependencies:
181 - `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
182 above (note that Debian Squeeze only has version 1.0.9)
183 - `Crypto <http://hackage.haskell.org/package/Crypto>`_, tested with
185 - `text <http://hackage.haskell.org/package/text>`_
186 - `hinotify <http://hackage.haskell.org/package/hinotify>`_
188 These libraries are available in Debian Wheezy (but not in Squeeze), so
189 you can use either apt::
191 $ apt-get install libghc-hslogger-dev libghc-crypto-dev libghc-text-dev \
196 $ cabal install hslogger Crypto text hinotify
202 If one of the cabal packages fails to install due to unfulfilled
203 dependencies, you can try enabling symlinks in ``~/.cabal/config``.
205 Make sure that your ``~/.cabal/bin`` directory (or whatever else
206 is defined as ``bindir``) is in your ``PATH``.
208 Installation of the software
209 ----------------------------
211 To install, simply run the following command::
213 $ ./configure --localstatedir=/var --sysconfdir=/etc && \
217 This will install the software under ``/usr/local``. You then need to
218 copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
219 integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
223 Cluster initialisation
224 ----------------------
226 Before initialising the cluster, on each node you need to create the
227 following directories:
230 - ``/var/lib/ganeti``
231 - ``/var/log/ganeti``
234 - ``/srv/ganeti/export``
236 After this, use ``gnt-cluster init``.
238 .. vim: set textwidth=72 syntax=rst :