INSTALL 10.7 KB
Newer Older
Michael Hanselmann's avatar
Michael Hanselmann committed
1
2
Ganeti quick installation guide
===============================
3

Michael Hanselmann's avatar
Michael Hanselmann committed
4
Please note that a more detailed installation procedure is described in
5
6
7
the :doc:`install`. Refer to it if you are setting up Ganeti the first time.
This quick installation guide is mainly meant as reference for experienced
users. A glossary of terms can be found in the :doc:`glossary`.
8
9


10
Software Requirements
Michael Hanselmann's avatar
Michael Hanselmann committed
11
---------------------
Iustin Pop's avatar
Iustin Pop committed
12

13
14
.. highlight:: shell-example

Iustin Pop's avatar
Iustin Pop committed
15
Before installing, please verify that you have the following programs:
Michael Hanselmann's avatar
Michael Hanselmann committed
16

17
18
19
20
21
- `Xen Hypervisor <http://www.xen.org/>`_, version 3.0 or above, if
  running on Xen
- `KVM Hypervisor <http://www.linux-kvm.org>`_, version 72 or above, if
  running on KVM. In order to use advanced features, such as live
  migration, virtio, etc, an even newer version is recommended (qemu-kvm
22
  versions 0.11.X and above have shown good behavior).
Michael Hanselmann's avatar
Michael Hanselmann committed
23
- `DRBD <http://www.drbd.org/>`_, kernel module and userspace utils,
24
25
26
  version 8.0.7 or above; note that Ganeti doesn't yet support version 8.4
- `RBD <http://ceph.newdream.net/>`_, kernel modules
  (``rbd.ko``/``libceph.ko``) and userspace utils (``ceph-common``)
Michael Hanselmann's avatar
Michael Hanselmann committed
27
28
29
30
31
- `LVM2 <http://sourceware.org/lvm2/>`_
- `OpenSSH <http://www.openssh.com/portable.html>`_
- `bridge utilities <http://www.linuxfoundation.org/en/Net:Bridge>`_
- `iproute2 <http://www.linuxfoundation.org/en/Net:Iproute2>`_
- `arping <http://www.skbuff.net/iputils/>`_ (part of iputils)
32
- `ndisc6 <http://www.remlab.net/ndisc6/>`_ (if using IPv6)
Guido Trotter's avatar
Guido Trotter committed
33
- `Python <http://www.python.org/>`_, version 2.6 or above, not 3.0
Michael Hanselmann's avatar
Michael Hanselmann committed
34
35
- `Python OpenSSL bindings <http://pyopenssl.sourceforge.net/>`_
- `simplejson Python module <http://code.google.com/p/simplejson/>`_
36
37
- `pyparsing Python module <http://pyparsing.wikispaces.com/>`_, version
  1.4.6 or above
Michael Hanselmann's avatar
Michael Hanselmann committed
38
- `pyinotify Python module <https://github.com/seb-m/pyinotify>`_
39
- `PycURL Python module <http://pycurl.sourceforge.net/>`_
40
41
- `socat <http://www.dest-unreach.org/socat/>`_, see :ref:`note
  <socat-note>` below
42
43
- `Paramiko <http://www.lag.net/paramiko/>`_, if you want to use
  ``ganeti-listrunner``
44
- `psutil Python module <https://github.com/giampaolo/psutil>`_,
45
  optional python package for supporting CPU pinning under KVM
46
47
- `fdsend Python module <https://gitorious.org/python-fdsend>`_,
  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
51
52
- `Python IP address manipulation library
  <http://code.google.com/p/ipaddr-py/>`_
- `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/>`_
Michael Hanselmann's avatar
Michael Hanselmann committed
55
56
57
58
59

These programs are supplied as part of most Linux distributions, so
usually they can be installed via the standard package manager. Also
many of them will already be installed on a standard machine. On
Debian/Ubuntu, you can use this command line to install all required
60
packages, except for RBD, DRBD and Xen::
Michael Hanselmann's avatar
Michael Hanselmann committed
61

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

67
68
Note that the previous instructions don't install optional packages.
To install the optional package, run the following line.::
69

70
  $ apt-get install python-paramiko python-psutil qemu-utils
71
72
73
74
75

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

76
  $ apt-get install python-setuptools python-dev
77
  $ cd / && easy_install \
78
            psutil \
79
            bitarray \
80
            ipaddr
81

Michael Hanselmann's avatar
Michael Hanselmann committed
82

83
84
On Fedora to install all required packages except RBD, DRBD and Xen::

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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
If you want to build from source, please see doc/devnotes.rst for more
dependencies.

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

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

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

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

Haskell requirements
~~~~~~~~~~~~~~~~~~~~

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

Petr Pudlak's avatar
Petr Pudlak committed
126
- `GHC <http://www.haskell.org/ghc/>`_ version 7 or higher
127
128
129
130
131
132
- or even better, `The Haskell Platform
  <http://hackage.haskell.org/platform/>`_ which gives you a simple way
  to bootstrap Haskell
- `json <http://hackage.haskell.org/package/json>`_, a JSON library
- `network <http://hackage.haskell.org/package/network>`_, a basic
  network library
133
134
- `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
  programming library (note: tested with up to version 3.x)
135
136
137
- `bytestring <http://hackage.haskell.org/package/bytestring>`_ and
  `utf8-string <http://hackage.haskell.org/package/utf8-string>`_
  libraries; these usually come with the GHC compiler
138
- `text <http://hackage.haskell.org/package/text>`_
139
- `deepseq <http://hackage.haskell.org/package/deepseq>`_
140
141
- `curl <http://hackage.haskell.org/package/curl>`_, tested with
  versions 1.3.4 and above
142
- `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
Petr Pudlak's avatar
Petr Pudlak committed
143
  above.
144
145
146
147
148
149
150
151
152
153
- `hinotify <http://hackage.haskell.org/package/hinotify>`_, tested with
  version 0.3.2
- `Crypto <http://hackage.haskell.org/package/Crypto>`_, tested with
  version 4.2.4
- `regex-pcre <http://hackage.haskell.org/package/regex-pcre>`_,
  bindings for the ``pcre`` library
- `attoparsec <http://hackage.haskell.org/package/attoparsec>`_
- `vector <http://hackage.haskell.org/package/vector>`_
- `process <http://hackage.haskell.org/package/process>`_, version 1.0.1.1 and
  above
154
155
- `lifted-base <http://hackage.haskell.org/package/lifted-base>`_,
  version 0.1.1 and above.
Petr Pudlak's avatar
Petr Pudlak committed
156
157
- `lens <http://hackage.haskell.org/package/lens>`_,
  version 3.0 and above.
158

Iustin Pop's avatar
Iustin Pop committed
159
Some of these are also available as package in Debian/Ubuntu::
160

161
  $ apt-get install ghc libghc-json-dev libghc-network-dev \
162
                    libghc-parallel-dev libghc-deepseq-dev \
163
                    libghc-utf8-string-dev libghc-curl-dev \
164
165
166
167
                    libghc-hslogger-dev \
                    libghc-crypto-dev libghc-text-dev \
                    libghc-hinotify-dev libghc-regex-pcre-dev \
                    libpcre3-dev \
168
                    libghc-attoparsec-dev libghc-vector-dev \
Petr Pudlak's avatar
Petr Pudlak committed
169
170
171
172
173
174
175
                    libghc-zlib-dev

Debian Jessie also includes recent enough versions of these libraries::

  $ apt-get install libghc-base64-bytestring-dev \
                    libghc-lens-dev \
                    libghc-lifted-base-dev
176

177
In Fedora, some of them are available via packages as well::
178

179
  $ yum install ghc ghc-json-devel ghc-network-devel \
180
181
182
                    ghc-parallel-devel ghc-deepseq-devel \
                    ghc-hslogger-devel ghc-text-devel \
                    ghc-regex-pcre-devel
183

184
185
186
187
188
The most recent Fedora doesn't provide ``crypto``, ``inotify``. So these
need to be installed using ``cabal``.

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

  $ apt-get install cabal-install
Michele Tartara's avatar
Michele Tartara committed
191
  $ cabal update
192

193
194
195
196
197
198
Then install the additional native libraries::

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

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

200
201
  $ cabal install json network parallel utf8-string curl hslogger \
                  Crypto text hinotify==0.3.2 regex-pcre \
Petr Pudlak's avatar
Petr Pudlak committed
202
203
                  attoparsec vector base64-bytestring \
                  lifted-base==0.2.0.3 lens==3.10
204

205
206
207
208
Haskell optional features
~~~~~~~~~~~~~~~~~~~~~~~~~

Optionally, more functionality can be enabled if your build machine has
209
a few more Haskell libraries enabled: the ``ganeti-confd`` daemon
Petr Pudlak's avatar
Petr Pudlak committed
210
211
(``--enable-confd``), the monitoring daemon (``--enable-mond``) and
the meta-data daemon (``--enable-metadata``).
212
The extra dependency for these is:
213

214
215
- `snap-server` <http://hackage.haskell.org/package/snap-server>`_, version
  0.8.1 and above.
216

Petr Pudlak's avatar
Petr Pudlak committed
217
This library is available in Debian Wheezy, so you can use either apt::
218

219
  $ apt-get install libghc-snap-server-dev
220

221
or ``cabal``::
222

223
  $ cabal install snap-server
224

225
to install it.
226

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

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

235
Installation of the software
Michael Hanselmann's avatar
Michael Hanselmann committed
236
237
238
----------------------------

To install, simply run the following command::
Iustin Pop's avatar
Iustin Pop committed
239

240
241
242
  $ ./configure --localstatedir=/var --sysconfdir=/etc && \
    make && \
    make install
Iustin Pop's avatar
Iustin Pop committed
243

Michael Hanselmann's avatar
Michael Hanselmann committed
244
245
246
This will install the software under ``/usr/local``. You then need to
copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
247
248
249
250
etc.). Also, Ganeti uses symbolic links in the sysconfdir to determine,
which of potentially many installed versions currently is used. If these
symbolic links should be added by the install as well, add the
option ``--enable-symlinks`` to the ``configure`` call.
Iustin Pop's avatar
Iustin Pop committed
251

252

Iustin Pop's avatar
Iustin Pop committed
253
Cluster initialisation
Michael Hanselmann's avatar
Michael Hanselmann committed
254
----------------------
Iustin Pop's avatar
Iustin Pop committed
255

Michael Hanselmann's avatar
Michael Hanselmann committed
256
257
Before initialising the cluster, on each node you need to create the
following directories:
Iustin Pop's avatar
Iustin Pop committed
258

Michael Hanselmann's avatar
Michael Hanselmann committed
259
260
261
262
263
264
- ``/etc/ganeti``
- ``/var/lib/ganeti``
- ``/var/log/ganeti``
- ``/srv/ganeti``
- ``/srv/ganeti/os``
- ``/srv/ganeti/export``
Iustin Pop's avatar
Iustin Pop committed
265
266

After this, use ``gnt-cluster init``.
Michael Hanselmann's avatar
Michael Hanselmann committed
267
268
269
270
271
272

.. vim: set textwidth=72 syntax=rst :
.. Local Variables:
.. mode: rst
.. fill-column: 72
.. End: