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.4 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 - `qemu-img <http://qemu.org/>`_, if you want to use ``ovfconverter``
47 - `fping <http://fping.sourceforge.net/>`_
48 - `Python IP address manipulation library
49 <http://code.google.com/p/ipaddr-py/>`_
50 - `Bitarray Python library <http://pypi.python.org/pypi/bitarray/>`_
52 These programs are supplied as part of most Linux distributions, so
53 usually they can be installed via the standard package manager. Also
54 many of them will already be installed on a standard machine. On
55 Debian/Ubuntu, you can use this command line to install all required
56 packages, except for RBD, DRBD and Xen::
58 $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
59 ndisc6 python python-pyopenssl openssl \
60 python-pyparsing python-simplejson python-bitarray \
61 python-pyinotify python-pycurl python-ipaddr socat fping
63 If bitarray is missing it can be installed from easy-install::
65 $ easy_install bitarray
67 Or on newer distributions (eg. Debian Wheezy) the above becomes::
69 $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
70 ndisc6 python python-openssl openssl \
71 python-pyparsing python-simplejson python-bitarray \
72 python-pyinotify python-pycurl python-ipaddr socat fping
74 Note that this does not install optional packages::
76 $ apt-get install python-paramiko python-affinity qemu-img
78 If some of the python packages are not available in your system,
79 you can try installing them using ``easy_install`` command.
82 $ apt-get install python-setuptools
83 $ cd / && sudo easy_install \
87 On Fedora to install all required packages except RBD, DRBD and Xen::
89 $ yum install openssh openssh-clients bridge-utils iproute ndisc6 \
90 pyOpenSSL pyparsing python-simplejson python-inotify \
91 python-lxm socat fping
93 For optional packages use the command::
95 $ yum install python-paramiko python-affinity qemu-img
97 If you want to build from source, please see doc/devnotes.rst for more
102 Ganeti's import/export functionality uses ``socat`` with OpenSSL for
103 transferring data between nodes. By default, OpenSSL 0.9.8 and above
104 employ transparent compression of all data using zlib if supported by
105 both sides of a connection. In cases where a lot of data is
106 transferred, this can lead to an increased CPU usage. Additionally,
107 Ganeti already compresses all data using ``gzip`` where it makes sense
108 (for inter-cluster instance moves).
110 To remedey this situation, patches implementing a new ``socat`` option
111 for disabling OpenSSL compression have been contributed and will
112 likely be included in the next feature release. Until then, users or
113 distributions need to apply the patches on their own.
115 Ganeti will use the option if it's detected by the ``configure``
116 script; auto-detection can be disabled by explicitly passing
117 ``--enable-socat-compress`` (use the option to disable compression) or
118 ``--disable-socat-compress`` (don't use the option).
120 The patches and more information can be found on
121 http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
126 Starting with Ganeti 2.7, the Haskell GHC compiler and a few base
127 libraries are required in order to build Ganeti (but not to run and
128 deploy Ganeti on production machines). More specifically:
130 - `GHC <http://www.haskell.org/ghc/>`_ version 6.12 or higher
131 - or even better, `The Haskell Platform
132 <http://hackage.haskell.org/platform/>`_ which gives you a simple way
134 - `json <http://hackage.haskell.org/package/json>`_, a JSON library
135 - `network <http://hackage.haskell.org/package/network>`_, a basic
137 - `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
138 programming library (note: tested with up to version 3.x)
139 - `bytestring <http://hackage.haskell.org/package/bytestring>`_ and
140 `utf8-string <http://hackage.haskell.org/package/utf8-string>`_
141 libraries; these usually come with the GHC compiler
142 - `deepseq <http://hackage.haskell.org/package/deepseq>`_
144 Some of these are also available as package in Debian/Ubuntu::
146 $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
147 libghc6-parallel-dev libghc6-deepseq-dev
149 Or in newer versions of these distributions (using GHC 7.x)::
151 $ apt-get install ghc libghc-json-dev libghc-network-dev \
152 libghc-parallel-dev libghc-deepseq-dev \
153 libghc-utf8-string-dev
155 In Fedora, they are available via packages as well::
157 $ yum install ghc ghc-json-devel ghc-network-devel \
158 ghc-parallel-devel ghc-deepseq-devel
160 If using a distribution which does not provide them, first install
161 the Haskell platform. You can also install ``cabal`` manually::
163 $ apt-get install cabal-install
165 Then install the additional libraries via
168 $ cabal install json network parallel utf8-string
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).
176 Haskell optional features
177 ~~~~~~~~~~~~~~~~~~~~~~~~~
179 Optionally, more functionality can be enabled if your build machine has
180 a few more Haskell libraries enabled: RAPI access to remote cluster from
181 htools (``--enable-htools-rapi``), the ``ganeti-confd``
182 daemon (``--enable-confd``) and the monitoring agent
183 (``--enable-monitoring``). The list of extra dependencies for these is:
185 - `curl <http://hackage.haskell.org/package/curl>`_, tested with
186 versions 1.3.4 and above
187 - `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
188 above (note that Debian Squeeze only has version 1.0.9)
189 - `Crypto <http://hackage.haskell.org/package/Crypto>`_, tested with
191 - `text <http://hackage.haskell.org/package/text>`_
192 - `hinotify <http://hackage.haskell.org/package/hinotify>`_, tested with
194 - `regex-pcre <http://hackage.haskell.org/package/regex-pcre>`_,
195 bindings for the ``pcre`` library
196 - `attoparsec <http://hackage.haskell.org/package/attoparsec>`_
197 - `vector <http://hackage.haskell.org/package/vector>`_
199 These libraries are available in Debian Wheezy (but not in Squeeze, with
200 the exception of curl), so you can use either apt::
202 $ apt-get install libghc-hslogger-dev libghc-crypto-dev libghc-text-dev \
203 libghc-hinotify-dev libghc-regex-pcre-dev libghc-curl-dev \
204 libghc-attoparsec-dev libghc-vector-dev libpcre3-dev
208 $ apt-get install libprcre3-dev libcurl4-openssl-dev
209 $ cabal install hslogger Crypto text hinotify==0.3.2 regex-pcre curl \
214 The most recent Fedora doesn't provide ``curl``, ``crypto``,
215 ``inotify``. So these need to be installed using ``cabal``, if
216 desired. The other packages can be installed via ``yum``::
218 $ yum install ghc-hslogger-devel ghc-text-devel \
223 If one of the cabal packages fails to install due to unfulfilled
224 dependencies, you can try enabling symlinks in ``~/.cabal/config``.
226 Make sure that your ``~/.cabal/bin`` directory (or whatever else
227 is defined as ``bindir``) is in your ``PATH``.
229 Installation of the software
230 ----------------------------
232 To install, simply run the following command::
234 $ ./configure --localstatedir=/var --sysconfdir=/etc && \
238 This will install the software under ``/usr/local``. You then need to
239 copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
240 integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
244 Cluster initialisation
245 ----------------------
247 Before initialising the cluster, on each node you need to create the
248 following directories:
251 - ``/var/lib/ganeti``
252 - ``/var/log/ganeti``
255 - ``/srv/ganeti/export``
257 After this, use ``gnt-cluster init``.
259 .. vim: set textwidth=72 syntax=rst :