Make SetupToolsLogging use tools logfile
[ganeti-github.git] / INSTALL
1 Ganeti quick installation guide
2 ===============================
3
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`.
8
9
10 Software Requirements
11 ---------------------
12
13 .. highlight:: shell-example
14
15 Before installing, please verify that you have the following programs:
16
17 - `Xen Hypervisor <http://www.xen.org/>`_, version 3.0 or above, if
18   running on Xen
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.6 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
37   1.4.6 or above
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
41   <socat-note>` below
42 - `Paramiko <http://www.lag.net/paramiko/>`_, if you want to use
43   ``ganeti-listrunner``
44 - `psutil Python module <https://github.com/giampaolo/psutil>`_,
45   optional python package for supporting CPU pinning under KVM
46 - `fdsend Python module <https://gitorious.org/python-fdsend>`_,
47   optional Python package for supporting NIC hotplugging under KVM
48 - `qemu-img <http://qemu.org/>`_, if you want to use ``ovfconverter``
49 - `fping <http://fping.sourceforge.net/>`_
50 - `Python IP address manipulation library
51   <http://code.google.com/p/ipaddr-py/>`_
52 - `Bitarray Python library <http://pypi.python.org/pypi/bitarray/>`_
53 - `GNU Make <http://www.gnu.org/software/make/>`_
54 - `GNU M4 <http://www.gnu.org/software/m4/>`_
55
56 These programs are supplied as part of most Linux distributions, so
57 usually they can be installed via the standard package manager. Also
58 many of them will already be installed on a standard machine. On
59 Debian/Ubuntu, you can use this command line to install all required
60 packages, except for RBD, DRBD and Xen::
61
62   $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping make m4 \
63                     ndisc6 python python-openssl openssl \
64                     python-pyparsing python-simplejson python-bitarray \
65                     python-pyinotify python-pycurl python-ipaddr socat fping
66
67 Note that the previous instructions don't install optional packages.
68 To install the optional package, run the following line.::
69
70   $ apt-get install python-paramiko python-psutil qemu-utils
71
72 If some of the python packages are not available in your system,
73 you can try installing them using ``easy_install`` command.
74 For example::
75
76   $ apt-get install python-setuptools python-dev
77   $ cd / && easy_install \
78             psutil \
79             bitarray \
80             ipaddr
81
82
83 On Fedora to install all required packages except RBD, DRBD and Xen::
84
85   $ yum install openssh openssh-clients bridge-utils iproute ndisc6 make \
86                 pyOpenSSL pyparsing python-simplejson python-inotify \
87                 python-lxm socat fping python-bitarray python-ipaddr
88
89 For optional packages use the command::
90
91   $ yum install python-paramiko python-psutil qemu-img
92
93 If you want to build from source, please see doc/devnotes.rst for more
94 dependencies.
95
96 .. _socat-note:
97 .. note::
98   Ganeti's import/export functionality uses ``socat`` with OpenSSL for
99   transferring data between nodes. By default, OpenSSL 0.9.8 and above
100   employ transparent compression of all data using zlib if supported by
101   both sides of a connection. In cases where a lot of data is
102   transferred, this can lead to an increased CPU usage. Additionally,
103   Ganeti already compresses all data using ``gzip`` where it makes sense
104   (for inter-cluster instance moves).
105
106   To remedey this situation, patches implementing a new ``socat`` option
107   for disabling OpenSSL compression have been contributed and will
108   likely be included in the next feature release. Until then, users or
109   distributions need to apply the patches on their own.
110
111   Ganeti will use the option if it's detected by the ``configure``
112   script; auto-detection can be disabled by explicitly passing
113   ``--enable-socat-compress`` (use the option to disable compression) or
114   ``--disable-socat-compress`` (don't use the option).
115
116   The patches and more information can be found on
117   http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
118
119 Haskell requirements
120 ~~~~~~~~~~~~~~~~~~~~
121
122 Starting with Ganeti 2.7, the Haskell GHC compiler and a few base
123 libraries are required in order to build Ganeti (but not to run and
124 deploy Ganeti on production machines). More specifically:
125
126 - `GHC <http://www.haskell.org/ghc/>`_ version 7 or higher
127 - or even better, `The Haskell Platform
128   <http://hackage.haskell.org/platform/>`_ which gives you a simple way
129   to bootstrap Haskell
130 - `cabal-install <http://hackage.haskell.org/package/json>`_ and
131   `Cabal <http://hackage.haskell.org/package/json>`_, the Common Architecture
132   for Building Haskell Applications and Libraries (executable and library)
133 - `json <http://hackage.haskell.org/package/json>`_, a JSON library
134 - `network <http://hackage.haskell.org/package/network>`_, a basic
135   network library
136 - `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
137   programming library (note: tested with up to version 3.x)
138 - `bytestring <http://hackage.haskell.org/package/bytestring>`_ and
139   `utf8-string <http://hackage.haskell.org/package/utf8-string>`_
140   libraries; these usually come with the GHC compiler
141 - `text <http://hackage.haskell.org/package/text>`_
142 - `deepseq <http://hackage.haskell.org/package/deepseq>`_,
143   usually comes with the GHC compiler
144 - `curl <http://hackage.haskell.org/package/curl>`_, tested with
145   versions 1.3.4 and above
146 - `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
147   above.
148 - `hinotify <http://hackage.haskell.org/package/hinotify>`_, tested with
149   version 0.3.2
150 - `Crypto <http://hackage.haskell.org/package/Crypto>`_, tested with
151   version 4.2.4
152 - `regex-pcre <http://hackage.haskell.org/package/regex-pcre>`_,
153   bindings for the ``pcre`` library
154 - `attoparsec <http://hackage.haskell.org/package/attoparsec>`_,
155   version 0.10 and above
156 - `vector <http://hackage.haskell.org/package/vector>`_
157 - `process <http://hackage.haskell.org/package/process>`_, version 1.0.1.1 and
158   above; usually comes with the GHC compiler
159 - `base64-bytestring
160   <http://hackage.haskell.org/package/base64-bytestring>`_,
161   version 1.0.0.0 and above
162 - `lifted-base <http://hackage.haskell.org/package/lifted-base>`_,
163   version 0.1.1 and above.
164 - `lens <http://hackage.haskell.org/package/lens>`_,
165   version 3.10 and above.
166
167 Some of these are also available as package in Debian/Ubuntu::
168
169   $ apt-get install ghc cabal-install libghc-cabal-dev \
170                     libghc-json-dev libghc-network-dev \
171                     libghc-parallel-dev \
172                     libghc-utf8-string-dev libghc-curl-dev \
173                     libghc-hslogger-dev \
174                     libghc-crypto-dev libghc-text-dev \
175                     libghc-hinotify-dev libghc-regex-pcre-dev \
176                     libpcre3-dev \
177                     libghc-attoparsec-dev libghc-vector-dev \
178                     libghc-zlib-dev
179
180 Debian Jessie also includes recent enough versions of these libraries::
181
182   $ apt-get install libghc-base64-bytestring-dev \
183                     libghc-lens-dev \
184                     libghc-lifted-base-dev
185
186 In Fedora, some of them are available via packages as well::
187
188   $ yum install ghc ghc-json-devel ghc-network-devel \
189                     ghc-parallel-devel ghc-deepseq-devel \
190                     ghc-hslogger-devel ghc-text-devel \
191                     ghc-regex-pcre-devel
192
193 The most recent Fedora doesn't provide ``crypto``, ``inotify``. So these
194 need to be installed using ``cabal``.
195
196 If using a distribution which does not provide these libraries, first
197 install the Haskell platform. Then run::
198
199   $ cabal update
200
201 Then install the additional native libraries::
202
203   $ apt-get install libpcre3-dev libcurl4-openssl-dev
204
205 And finally the libraries required for building the packages via ``cabal``
206 (it will automatically pick only those that are not already installed via your
207 distribution packages)::
208
209   $ cabal install --only-dependencies cabal/ganeti.template.cabal
210
211 Haskell optional features
212 ~~~~~~~~~~~~~~~~~~~~~~~~~
213
214 Optionally, more functionality can be enabled if your build machine has
215 a few more Haskell libraries enabled: the ``ganeti-confd`` daemon
216 (``--enable-confd``), the monitoring daemon (``--enable-monitoring``) and
217 the meta-data daemon (``--enable-metadata``).
218 The extra dependencies for these are:
219
220 - `snap-server` <http://hackage.haskell.org/package/snap-server>`_, version
221   0.8.1 and above.
222 - `case-insensitive`
223   <http://hackage.haskell.org/package/case-insensitive>`_, version
224   0.4.0.1 and above (it's also a dependency of ``snap-server``).
225 - `PSQueue <http://hackage.haskell.org/package/PSQueue>`_,
226   version 1.0 and above.
227
228 These libraries are available in Debian Wheezy or later, so you can use
229 either apt::
230
231   $ apt-get install libghc-snap-server-dev libghc-psqueue-dev
232
233 or ``cabal``::
234
235   $ cabal install --only-dependencies cabal/ganeti.template.cabal \
236                   --flags="confd mond metad"
237
238 to install them.
239
240 .. _cabal-note:
241 .. note::
242   Make sure that your ``~/.cabal/bin`` directory (or whatever else
243   is defined as ``bindir``) is in your ``PATH``.
244
245 Installation of the software
246 ----------------------------
247
248 To install, simply run the following command::
249
250   $ ./configure --localstatedir=/var --sysconfdir=/etc && \
251     make && \
252     make install
253
254 This will install the software under ``/usr/local``. You then need to
255 copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
256 integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
257 etc.). Also, Ganeti uses symbolic links in the sysconfdir to determine,
258 which of potentially many installed versions currently is used. If these
259 symbolic links should be added by the install as well, add the
260 option ``--enable-symlinks`` to the ``configure`` call.
261
262
263 Cluster initialisation
264 ----------------------
265
266 Before initialising the cluster, on each node you need to create the
267 following directories:
268
269 - ``/etc/ganeti``
270 - ``/var/lib/ganeti``
271 - ``/var/log/ganeti``
272 - ``/srv/ganeti``
273 - ``/srv/ganeti/os``
274 - ``/srv/ganeti/export``
275
276 After this, use ``gnt-cluster init``.
277
278 .. vim: set textwidth=72 syntax=rst :
279 .. Local Variables:
280 .. mode: rst
281 .. fill-column: 72
282 .. End: