Statistics
| Branch: | Tag: | Revision:

root / INSTALL @ e9ba0663

History | View | Annotate | Download (10.7 kB)

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
- `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/>`_
51

    
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::
57

    
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
62

    
63
If bitarray is missing it can be installed from easy-install::
64

    
65
  $ easy_install bitarray
66

    
67
Or on newer distributions (eg. Debian Wheezy) the above becomes::
68

    
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
73

    
74
Note that this does not install optional packages::
75

    
76
  $ apt-get install python-paramiko python-affinity qemu-img
77

    
78
If some of the python packages are not available in your system,
79
you can try installing them using ``easy_install`` command.
80
For example::
81

    
82
  $ apt-get install python-setuptools python-dev
83
  $ cd / && sudo easy_install \
84
            affinity \
85
            bitarray \
86
            ipaddr
87

    
88

    
89
On Fedora to install all required packages except RBD, DRBD and Xen::
90

    
91
  $ yum install openssh openssh-clients bridge-utils iproute ndisc6 \
92
                pyOpenSSL pyparsing python-simplejson python-inotify \
93
                python-lxm socat fping python-bitarray python-ipaddr
94

    
95
For optional packages use the command::
96

    
97
  $ yum install python-paramiko python-affinity qemu-img
98

    
99
If you want to build from source, please see doc/devnotes.rst for more
100
dependencies.
101

    
102
.. _socat-note:
103
.. note::
104
  Ganeti's import/export functionality uses ``socat`` with OpenSSL for
105
  transferring data between nodes. By default, OpenSSL 0.9.8 and above
106
  employ transparent compression of all data using zlib if supported by
107
  both sides of a connection. In cases where a lot of data is
108
  transferred, this can lead to an increased CPU usage. Additionally,
109
  Ganeti already compresses all data using ``gzip`` where it makes sense
110
  (for inter-cluster instance moves).
111

    
112
  To remedey this situation, patches implementing a new ``socat`` option
113
  for disabling OpenSSL compression have been contributed and will
114
  likely be included in the next feature release. Until then, users or
115
  distributions need to apply the patches on their own.
116

    
117
  Ganeti will use the option if it's detected by the ``configure``
118
  script; auto-detection can be disabled by explicitly passing
119
  ``--enable-socat-compress`` (use the option to disable compression) or
120
  ``--disable-socat-compress`` (don't use the option).
121

    
122
  The patches and more information can be found on
123
  http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
124

    
125
Haskell requirements
126
~~~~~~~~~~~~~~~~~~~~
127

    
128
Starting with Ganeti 2.7, the Haskell GHC compiler and a few base
129
libraries are required in order to build Ganeti (but not to run and
130
deploy Ganeti on production machines). More specifically:
131

    
132
- `GHC <http://www.haskell.org/ghc/>`_ version 6.12 or higher
133
- or even better, `The Haskell Platform
134
  <http://hackage.haskell.org/platform/>`_ which gives you a simple way
135
  to bootstrap Haskell
136
- `json <http://hackage.haskell.org/package/json>`_, a JSON library
137
- `network <http://hackage.haskell.org/package/network>`_, a basic
138
  network library
139
- `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
140
  programming library (note: tested with up to version 3.x)
141
- `bytestring <http://hackage.haskell.org/package/bytestring>`_ and
142
  `utf8-string <http://hackage.haskell.org/package/utf8-string>`_
143
  libraries; these usually come with the GHC compiler
144
- `deepseq <http://hackage.haskell.org/package/deepseq>`_
145
- `curl <http://hackage.haskell.org/package/curl>`_, tested with
146
  versions 1.3.4 and above
147

    
148
Some of these are also available as package in Debian/Ubuntu::
149

    
150
  $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
151
                    libghc6-parallel-dev libghc6-deepseq-dev \
152
                    libghc6-curl-dev
153

    
154
Or in newer versions of these distributions (using GHC 7.x)::
155

    
156
  $ apt-get install ghc libghc-json-dev libghc-network-dev \
157
                    libghc-parallel-dev libghc-deepseq-dev \
158
                    libghc-utf8-string-dev libghc-curl-dev
159

    
160
In Fedora, some of them are available via packages as well::
161

    
162
  $ yum install ghc ghc-json-devel ghc-network-devel \
163
                    ghc-parallel-devel ghc-deepseq-devel
164

    
165
If using a distribution which does not provide them, first install
166
the Haskell platform. You can also install ``cabal`` manually::
167

    
168
  $ apt-get install cabal-install
169
  $ cabal update
170

    
171
Then install the additional libraries (only the ones not available in your
172
distribution packages) via ``cabal``::
173

    
174
  $ cabal install json network parallel utf8-string curl
175

    
176
Haskell optional features
177
~~~~~~~~~~~~~~~~~~~~~~~~~
178

    
179
Optionally, more functionality can be enabled if your build machine has
180
a few more Haskell libraries enabled: the ``ganeti-confd`` and
181
``ganeti-queryd`` daemon (``--enable-confd``) and the monitoring daemon
182
(``--enable-mond``). The list of extra dependencies for these is:
183

    
184
- `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
185
  above (note that Debian Squeeze only has version 1.0.9)
186
- `Crypto <http://hackage.haskell.org/package/Crypto>`_, tested with
187
  version 4.2.4
188
- `text <http://hackage.haskell.org/package/text>`_
189
- `hinotify <http://hackage.haskell.org/package/hinotify>`_, tested with
190
  version 0.3.2
191
- `regex-pcre <http://hackage.haskell.org/package/regex-pcre>`_,
192
  bindings for the ``pcre`` library
193
- `attoparsec <http://hackage.haskell.org/package/attoparsec>`_
194
- `vector <http://hackage.haskell.org/package/vector>`_
195
- `snap-server` <http://hackage.haskell.org/package/snap-server>`_, version
196
  0.8.1 and above.
197

    
198
These libraries are available in Debian Wheezy (but not in Squeeze), so you
199
can use either apt::
200

    
201
  $ apt-get install libghc-hslogger-dev libghc-crypto-dev libghc-text-dev \
202
                    libghc-hinotify-dev libghc-regex-pcre-dev \
203
                    libghc-attoparsec-dev libghc-vector-dev \
204
                    libghc-snap-server-dev
205

    
206
or ``cabal``, after installing a required non-Haskell dependency::
207

    
208
  $ apt-get install libpcre3-dev
209
  $ cabal install hslogger Crypto text hinotify==0.3.2 regex-pcre \
210
                  attoparsec vector snap-server
211

    
212
to install them.
213

    
214
In case you still use ghc-6.12, note that ``cabal`` would automatically try to
215
install newer versions of some of the libraries snap-server depends on, that
216
cannot be compiled with ghc-6.12, so you have to install snap-server on its
217
own, esplicitly forcing the installation of compatible versions::
218

    
219
  $ cabal install MonadCatchIO-transformers==0.2.2.0 mtl==2.0.1.0 \
220
                  hashable==1.1.2.0 case-insensitive==0.3 parsec==3.0.1 \
221
                  network==2.3 snap-server==0.8.1
222

    
223
The most recent Fedora doesn't provide ``crypto``, ``inotify``. So these
224
need to be installed using ``cabal``, if desired. The other packages can
225
be installed via ``yum``::
226

    
227
  $ yum install ghc-hslogger-devel ghc-text-devel \
228
                ghc-regex-pcre-devel
229

    
230
.. _cabal-note:
231
.. note::
232
  If one of the cabal packages fails to install due to unfulfilled
233
  dependencies, you can try enabling symlinks in ``~/.cabal/config``.
234

    
235
  Make sure that your ``~/.cabal/bin`` directory (or whatever else
236
  is defined as ``bindir``) is in your ``PATH``.
237

    
238
Installation of the software
239
----------------------------
240

    
241
To install, simply run the following command::
242

    
243
  $ ./configure --localstatedir=/var --sysconfdir=/etc && \
244
    make && \
245
    make install
246

    
247
This will install the software under ``/usr/local``. You then need to
248
copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
249
integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
250
etc.).
251

    
252

    
253
Cluster initialisation
254
----------------------
255

    
256
Before initialising the cluster, on each node you need to create the
257
following directories:
258

    
259
- ``/etc/ganeti``
260
- ``/var/lib/ganeti``
261
- ``/var/log/ganeti``
262
- ``/srv/ganeti``
263
- ``/srv/ganeti/os``
264
- ``/srv/ganeti/export``
265

    
266
After this, use ``gnt-cluster init``.
267

    
268
.. vim: set textwidth=72 syntax=rst :
269
.. Local Variables:
270
.. mode: rst
271
.. fill-column: 72
272
.. End: