INSTALL 11.3 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 45
- `affinity Python module <http://pypi.python.org/pypi/affinity/0.1.0>`_,
  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 49 50
- `Python IP address manipulation library
  <http://code.google.com/p/ipaddr-py/>`_
- `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/>`_
Michael Hanselmann's avatar
Michael Hanselmann committed
53 54 55 56 57

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
58
packages, except for RBD, DRBD and Xen::
Michael Hanselmann's avatar
Michael Hanselmann committed
59

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

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

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

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

  $ easy_install bitarray

77 78
Note that this does not install optional packages::

79
  $ apt-get install python-paramiko python-affinity qemu-utils
80 81 82 83 84

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

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

Michael Hanselmann's avatar
Michael Hanselmann committed
91

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

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

For optional packages use the command::
99

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

102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
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
121
  script; auto-detection can be disabled by explicitly passing
122 123 124 125 126 127 128 129 130
  ``--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
~~~~~~~~~~~~~~~~~~~~

131 132 133
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:
134

135
- `GHC <http://www.haskell.org/ghc/>`_ version 6.12 or higher
136 137 138 139 140 141
- 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
142 143
- `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
  programming library (note: tested with up to version 3.x)
144 145 146
- `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
147
- `deepseq <http://hackage.haskell.org/package/deepseq>`_
148 149
- `curl <http://hackage.haskell.org/package/curl>`_, tested with
  versions 1.3.4 and above
150 151
- `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
  above (note that Debian Squeeze only has version 1.0.9)
152

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

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

160 161 162 163 164 165
Or in older versions of these distributions (using GHC 6.x)::

  $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
                    libghc6-parallel-dev libghc6-deepseq-dev \
                    libghc6-curl-dev

166
In Fedora, some of them are available via packages as well::
167

168 169
  $ yum install ghc ghc-json-devel ghc-network-devel \
                    ghc-parallel-devel ghc-deepseq-devel
170

171
If using a distribution which does not provide them, first install
172
the Haskell platform. You can also install ``cabal`` manually::
173 174

  $ apt-get install cabal-install
Michele Tartara's avatar
Michele Tartara committed
175
  $ cabal update
176

177 178
Then install the additional libraries (only the ones not available in your
distribution packages) via ``cabal``::
179

180
  $ cabal install json network parallel utf8-string curl hslogger
181

182 183 184 185
Haskell optional features
~~~~~~~~~~~~~~~~~~~~~~~~~

Optionally, more functionality can be enabled if your build machine has
Thomas Thrainer's avatar
Thomas Thrainer committed
186
a few more Haskell libraries enabled: the ``ganeti-confd`` and
Thomas Thrainer's avatar
Thomas Thrainer committed
187
``ganeti-luxid`` daemon (``--enable-confd``) and the monitoring daemon
188
(``--enable-mond``). The list of extra dependencies for these is:
189

190 191 192
- `Crypto <http://hackage.haskell.org/package/Crypto>`_, tested with
  version 4.2.4
- `text <http://hackage.haskell.org/package/text>`_
193 194
- `hinotify <http://hackage.haskell.org/package/hinotify>`_, tested with
  version 0.3.2
195 196
- `regex-pcre <http://hackage.haskell.org/package/regex-pcre>`_,
  bindings for the ``pcre`` library
197
- `attoparsec <http://hackage.haskell.org/package/attoparsec>`_
198
- `vector <http://hackage.haskell.org/package/vector>`_
199 200
- `snap-server` <http://hackage.haskell.org/package/snap-server>`_, version
  0.8.1 and above.
201 202
- `process <http://hackage.haskell.org/package/process>`_, version 1.0.1.1 and
  above
203

Michele Tartara's avatar
Michele Tartara committed
204 205
These libraries are available in Debian Wheezy (but not in Squeeze), so you
can use either apt::
206

207
  $ apt-get install libghc-crypto-dev libghc-text-dev \
208
                    libghc-hinotify-dev libghc-regex-pcre-dev \
209
                    libpcre3-dev \
210 211
                    libghc-attoparsec-dev libghc-vector-dev \
                    libghc-snap-server-dev
212

213
or ``cabal``, after installing a required non-Haskell dependency::
214

Guido Trotter's avatar
Guido Trotter committed
215
  $ apt-get install libpcre3-dev libcurl4-openssl-dev
216
  $ cabal install Crypto text hinotify==0.3.2 regex-pcre \
217
                  attoparsec vector snap-server
218

219
to install them.
220

221 222 223
In case you still use ghc-6.12, note that ``cabal`` would automatically try to
install newer versions of some of the libraries snap-server depends on, that
cannot be compiled with ghc-6.12, so you have to install snap-server on its
224
own, explicitly forcing the installation of compatible versions::
225 226 227 228 229

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

230 231 232
The most recent Fedora doesn't provide ``crypto``, ``inotify``. So these
need to be installed using ``cabal``, if desired. The other packages can
be installed via ``yum``::
233 234 235 236

  $ yum install ghc-hslogger-devel ghc-text-devel \
                ghc-regex-pcre-devel

237 238 239 240 241 242 243 244
.. _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``.

245
Installation of the software
Michael Hanselmann's avatar
Michael Hanselmann committed
246 247 248
----------------------------

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

250 251 252
  $ ./configure --localstatedir=/var --sysconfdir=/etc && \
    make && \
    make install
Iustin Pop's avatar
Iustin Pop committed
253

Michael Hanselmann's avatar
Michael Hanselmann committed
254 255 256
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``,
257 258 259 260
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
261

262

Iustin Pop's avatar
Iustin Pop committed
263
Cluster initialisation
Michael Hanselmann's avatar
Michael Hanselmann committed
264
----------------------
Iustin Pop's avatar
Iustin Pop committed
265

Michael Hanselmann's avatar
Michael Hanselmann committed
266 267
Before initialising the cluster, on each node you need to create the
following directories:
Iustin Pop's avatar
Iustin Pop committed
268

Michael Hanselmann's avatar
Michael Hanselmann committed
269 270 271 272 273 274
- ``/etc/ganeti``
- ``/var/lib/ganeti``
- ``/var/log/ganeti``
- ``/srv/ganeti``
- ``/srv/ganeti/os``
- ``/srv/ganeti/export``
Iustin Pop's avatar
Iustin Pop committed
275 276

After this, use ``gnt-cluster init``.
Michael Hanselmann's avatar
Michael Hanselmann committed
277 278 279 280 281 282

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