Statistics
| Branch: | Tag: | Revision:

root / INSTALL @ 653bc0f1

History | View | Annotate | Download (11.4 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
- `GNU Make <http://www.gnu.org/software/make/>`_
52
- `GNU M4 <http://www.gnu.org/software/m4/>`_
53

    
54
These programs are supplied as part of most Linux distributions, so
55
usually they can be installed via the standard package manager. Also
56
many of them will already be installed on a standard machine. On
57
Debian/Ubuntu, you can use this command line to install all required
58
packages, except for RBD, DRBD and Xen::
59

    
60
  $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping make m4 \
61
                    ndisc6 python python-openssl openssl \
62
                    python-pyparsing python-simplejson python-bitarray \
63
                    python-pyinotify python-pycurl python-ipaddr socat fping
64

    
65
For older distributions (eg. Debian  Squeeze) the package names are
66
different.::
67

    
68
  $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping make \
69
                    ndisc6 python python-pyopenssl openssl \
70
                    python-pyparsing python-simplejson python-bitarray \
71
                    python-pyinotify python-pycurl python-ipaddr socat fping
72

    
73
If bitarray is missing it can be installed from easy-install::
74

    
75
  $ easy_install bitarray
76

    
77
Note that the previous instructions don't install optional packages.
78
To install the optional package, run the following line.::
79

    
80
  $ apt-get install python-paramiko python-affinity qemu-utils
81

    
82
If some of the python packages are not available in your system,
83
you can try installing them using ``easy_install`` command.
84
For example::
85

    
86
  $ apt-get install python-setuptools python-dev
87
  $ cd / && easy_install \
88
            affinity \
89
            bitarray \
90
            ipaddr
91

    
92

    
93
On Fedora to install all required packages except RBD, DRBD and Xen::
94

    
95
  $ yum install openssh openssh-clients bridge-utils iproute ndisc6 make \
96
                pyOpenSSL pyparsing python-simplejson python-inotify \
97
                python-lxm socat fping python-bitarray python-ipaddr
98

    
99
For optional packages use the command::
100

    
101
  $ yum install python-paramiko python-affinity qemu-img
102

    
103
If you want to build from source, please see doc/devnotes.rst for more
104
dependencies.
105

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

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

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

    
126
  The patches and more information can be found on
127
  http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
128

    
129
Haskell requirements
130
~~~~~~~~~~~~~~~~~~~~
131

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

    
136
- `GHC <http://www.haskell.org/ghc/>`_ version 6.12 or higher
137
- or even better, `The Haskell Platform
138
  <http://hackage.haskell.org/platform/>`_ which gives you a simple way
139
  to bootstrap Haskell
140
- `json <http://hackage.haskell.org/package/json>`_, a JSON library
141
- `network <http://hackage.haskell.org/package/network>`_, a basic
142
  network library
143
- `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
144
  programming library (note: tested with up to version 3.x)
145
- `bytestring <http://hackage.haskell.org/package/bytestring>`_ and
146
  `utf8-string <http://hackage.haskell.org/package/utf8-string>`_
147
  libraries; these usually come with the GHC compiler
148
- `text <http://hackage.haskell.org/package/text>`_
149
- `deepseq <http://hackage.haskell.org/package/deepseq>`_
150
- `curl <http://hackage.haskell.org/package/curl>`_, tested with
151
  versions 1.3.4 and above
152
- `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
153
  above (note that Debian Squeeze only has version 1.0.9)
154
- `hinotify <http://hackage.haskell.org/package/hinotify>`_, tested with
155
  version 0.3.2
156
- `Crypto <http://hackage.haskell.org/package/Crypto>`_, tested with
157
  version 4.2.4
158
- `regex-pcre <http://hackage.haskell.org/package/regex-pcre>`_,
159
  bindings for the ``pcre`` library
160
- `attoparsec <http://hackage.haskell.org/package/attoparsec>`_
161
- `vector <http://hackage.haskell.org/package/vector>`_
162
- `process <http://hackage.haskell.org/package/process>`_, version 1.0.1.1 and
163
  above
164

    
165
Some of these are also available as package in Debian/Ubuntu::
166

    
167
  $ apt-get install ghc libghc-json-dev libghc-network-dev \
168
                    libghc-parallel-dev libghc-deepseq-dev \
169
                    libghc-utf8-string-dev libghc-curl-dev \
170
                    libghc-hslogger-dev \
171
                    libghc-crypto-dev libghc-text-dev \
172
                    libghc-hinotify-dev libghc-regex-pcre-dev \
173
                    libpcre3-dev \
174
                    libghc-attoparsec-dev libghc-vector-dev \
175
                    libghc6-zlib-dev
176

    
177
Or in older versions of these distributions (using GHC 6.x)::
178

    
179
  $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
180
                    libghc6-parallel-dev libghc6-deepseq-dev \
181
                    libghc6-curl-dev
182

    
183
In Fedora, some of them are available via packages as well::
184

    
185
  $ yum install ghc ghc-json-devel ghc-network-devel \
186
                    ghc-parallel-devel ghc-deepseq-devel \
187
                    ghc-hslogger-devel ghc-text-devel \
188
                    ghc-regex-pcre-devel
189

    
190
The most recent Fedora doesn't provide ``crypto``, ``inotify``. So these
191
need to be installed using ``cabal``.
192

    
193
If using a distribution which does not provide these libraries, first
194
install the Haskell platform. You can also install ``cabal`` manually::
195

    
196
  $ apt-get install cabal-install
197
  $ cabal update
198

    
199
Then install the additional native libraries::
200

    
201
  $ apt-get install libpcre3-dev libcurl4-openssl-dev
202

    
203
And finally the libraries required for building the packages (only the
204
ones not available in your distribution packages) via ``cabal``::
205

    
206
  $ cabal install json network parallel utf8-string curl hslogger \
207
                  Crypto text hinotify==0.3.2 regex-pcre \
208
                  attoparsec vector base64-bytestring
209

    
210
Haskell optional features
211
~~~~~~~~~~~~~~~~~~~~~~~~~
212

    
213
Optionally, more functionality can be enabled if your build machine has
214
a few more Haskell libraries enabled: the ``ganeti-confd`` daemon
215
(``--enable-confd``) and the monitoring daemon (``--enable-mond``).
216
The extra dependency for these is:
217

    
218
- `snap-server` <http://hackage.haskell.org/package/snap-server>`_, version
219
  0.8.1 and above.
220

    
221
This library is available in Debian Wheezy (but not in Squeeze), so you
222
can use either apt::
223

    
224
  $ apt-get install libghc-snap-server-dev
225

    
226
or ``cabal``::
227

    
228
  $ cabal install snap-server
229

    
230
to install it.
231

    
232
In case you still use ghc-6.12, note that ``cabal`` would automatically try to
233
install newer versions of some of the libraries snap-server depends on, that
234
cannot be compiled with ghc-6.12, so you have to install snap-server on its
235
own, explicitly forcing the installation of compatible versions::
236

    
237
  $ cabal install MonadCatchIO-transformers==0.2.2.0 mtl==2.0.1.0 \
238
                  hashable==1.1.2.0 case-insensitive==0.3 parsec==3.0.1 \
239
                  network==2.3 snap-server==0.8.1
240

    
241
.. _cabal-note:
242
.. note::
243
  If one of the cabal packages fails to install due to unfulfilled
244
  dependencies, you can try enabling symlinks in ``~/.cabal/config``.
245

    
246
  Make sure that your ``~/.cabal/bin`` directory (or whatever else
247
  is defined as ``bindir``) is in your ``PATH``.
248

    
249
Installation of the software
250
----------------------------
251

    
252
To install, simply run the following command::
253

    
254
  $ ./configure --localstatedir=/var --sysconfdir=/etc && \
255
    make && \
256
    make install
257

    
258
This will install the software under ``/usr/local``. You then need to
259
copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
260
integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
261
etc.). Also, Ganeti uses symbolic links in the sysconfdir to determine,
262
which of potentially many installed versions currently is used. If these
263
symbolic links should be added by the install as well, add the
264
option ``--enable-symlinks`` to the ``configure`` call.
265

    
266

    
267
Cluster initialisation
268
----------------------
269

    
270
Before initialising the cluster, on each node you need to create the
271
following directories:
272

    
273
- ``/etc/ganeti``
274
- ``/var/lib/ganeti``
275
- ``/var/log/ganeti``
276
- ``/srv/ganeti``
277
- ``/srv/ganeti/os``
278
- ``/srv/ganeti/export``
279

    
280
After this, use ``gnt-cluster init``.
281

    
282
.. vim: set textwidth=72 syntax=rst :
283
.. Local Variables:
284
.. mode: rst
285
.. fill-column: 72
286
.. End: