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 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 \
63 python-elementtree qemu
65 If you want to build from source, please see doc/devnotes.rst for more
70 Ganeti's import/export functionality uses ``socat`` with OpenSSL for
71 transferring data between nodes. By default, OpenSSL 0.9.8 and above
72 employ transparent compression of all data using zlib if supported by
73 both sides of a connection. In cases where a lot of data is
74 transferred, this can lead to an increased CPU usage. Additionally,
75 Ganeti already compresses all data using ``gzip`` where it makes sense
76 (for inter-cluster instance moves).
78 To remedey this situation, patches implementing a new ``socat`` option
79 for disabling OpenSSL compression have been contributed and will
80 likely be included in the next feature release. Until then, users or
81 distributions need to apply the patches on their own.
83 Ganeti will use the option if it's detected by the ``configure``
84 script; auto-detection can be disabled by explicitely passing
85 ``--enable-socat-compress`` (use the option to disable compression) or
86 ``--disable-socat-compress`` (don't use the option).
88 The patches and more information can be found on
89 http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
94 If you want to enable the `htools` component, which is recommended on
95 bigger deployments (this give you automatic instance placement, cluster
96 balancing, etc.), then you need to have a Haskell compiler installed on
97 your build machine (but this is not required on the machines which are
98 just going to run Ganeti). More specifically:
100 - `GHC <http://www.haskell.org/ghc/>`_ version 6.12 or higher
101 - or even better, `The Haskell Platform
102 <http://hackage.haskell.org/platform/>`_ which gives you a simple way
104 - `json <http://hackage.haskell.org/package/json>`_, a JSON library
105 - `network <http://hackage.haskell.org/package/network>`_, a basic
107 - `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
108 programming library (note: tested with up to version 3.x)
109 - `curl <http://hackage.haskell.org/package/curl>`_, bindings for the
110 curl library, only needed if you want these tools to connect to remote
111 clusters (as opposed to the local one)
113 All of these are also available as package in Debian/Ubuntu::
115 $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
116 libghc6-parallel-dev libghc6-curl-dev
118 Note that more recent version have switched to GHC 7.x and the packages
121 $ apt-get install ghc libghc-json-dev libghc-network-dev \
122 libghc-parallel-dev libghc-curl-dev
124 If using a distribution which does not provide them, the first install
125 the Haskell platform and then install the additional libraries via
128 $ cabal install json network parallel curl
130 The compilation of the htools components is automatically enabled when
131 the compiler and the requisite libraries are found. You can use the
132 ``--enable-htools`` configure flag to force the selection (at which
133 point ``./configure`` will fail if it doesn't find the prerequisites).
135 In Ganeti version 2.6, one of the daemons (``ganeti-confd``) is shipped
136 in two versions: the Python default version (which has no extra
137 dependencies), and an experimental Haskell version. This latter version
138 can be enabled via the ``./configure`` flag ``--enable-confd=haskell``
139 and a few has extra dependencies:
141 - `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
142 above (note that Debian Squeeze only has version 1.0.9)
143 - `Crypto <http://hackage.haskell.org/package/Crypto>`_, tested with
145 - `text <http://hackage.haskell.org/package/text>`_
146 - ``bytestring``, which usually comes with the compiler
148 These libraries are available in Debian Wheezy (but not in Squeeze), so
149 you can use either apt::
151 $ apt-get install libghc-hslogger-dev libghc-crypto-dev libghc-text-dev
155 $ cabal install hslogger Crypto text
159 Installation of the software
160 ----------------------------
162 To install, simply run the following command::
164 $ ./configure --localstatedir=/var --sysconfdir=/etc && \
168 This will install the software under ``/usr/local``. You then need to
169 copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
170 integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
174 Cluster initialisation
175 ----------------------
177 Before initialising the cluster, on each node you need to create the
178 following directories:
181 - ``/var/lib/ganeti``
182 - ``/var/log/ganeti``
185 - ``/srv/ganeti/export``
187 After this, use ``gnt-cluster init``.
189 .. vim: set textwidth=72 syntax=rst :