INSTALL 11.2 KB
Newer Older
1 2
Ganeti quick installation guide
===============================
3

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
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:
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).
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``)
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)
33
- `Python <http://www.python.org/>`_, version 2.6 or above, not 3.0
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
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/>`_
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::
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

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``
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

126
- `GHC <http://www.haskell.org/ghc/>`_ version 7 or higher
127 128 129
- or even better, `The Haskell Platform
  <http://hackage.haskell.org/platform/>`_ which gives you a simple way
  to bootstrap Haskell
130 131 132
- `cabal-install <http://hackage.haskell.org/package/json>`_ and
  `Cabal <http://hackage.haskell.org/package/json>`_, the Common Architecture
  for Building Haskell Applications and Libraries (executable and library)
133 134 135
- `json <http://hackage.haskell.org/package/json>`_, a JSON library
- `network <http://hackage.haskell.org/package/network>`_, a basic
  network library
136 137
- `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
  programming library (note: tested with up to version 3.x)
138 139 140
- `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
141
- `text <http://hackage.haskell.org/package/text>`_
142 143
- `deepseq <http://hackage.haskell.org/package/deepseq>`_,
  usually comes with the GHC compiler
144 145
- `curl <http://hackage.haskell.org/package/curl>`_, tested with
  versions 1.3.4 and above
146
- `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
147
  above.
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
154 155
- `attoparsec <http://hackage.haskell.org/package/attoparsec>`_,
  version 0.10 and above
156 157
- `vector <http://hackage.haskell.org/package/vector>`_
- `process <http://hackage.haskell.org/package/process>`_, version 1.0.1.1 and
158 159 160 161
  above; usually comes with the GHC compiler
- `base64-bytestring
  <http://hackage.haskell.org/package/base64-bytestring>`_,
  version 1.0.0.0 and above
162 163
- `lifted-base <http://hackage.haskell.org/package/lifted-base>`_,
  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 170
  $ apt-get install ghc cabal-install libghc-cabal-dev \
                    libghc-json-dev libghc-network-dev \
171
                    libghc-parallel-dev \
172
                    libghc-utf8-string-dev libghc-curl-dev \
173 174 175 176
                    libghc-hslogger-dev \
                    libghc-crypto-dev libghc-text-dev \
                    libghc-hinotify-dev libghc-regex-pcre-dev \
                    libpcre3-dev \
177
                    libghc-attoparsec-dev libghc-vector-dev \
178 179 180 181 182 183 184
                    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
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 190 191
                    ghc-parallel-devel ghc-deepseq-devel \
                    ghc-hslogger-devel ghc-text-devel \
                    ghc-regex-pcre-devel
192

193 194 195 196
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
197
install the Haskell platform. Then run::
198

Michele Tartara's avatar
Michele Tartara committed
199
  $ cabal update
200

201 202 203 204
Then install the additional native libraries::

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

205 206 207
And finally the libraries required for building the packages via ``cabal``
(it will automatically pick only those that are not already installed via your
distribution packages)::
208

209
  $ cabal install --only-dependencies cabal/ganeti.template.cabal
210

211 212 213 214
Haskell optional features
~~~~~~~~~~~~~~~~~~~~~~~~~

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``).
Aaron Karper's avatar
Aaron Karper committed
218
The extra dependencies for these are:
219

220 221
- `snap-server` <http://hackage.haskell.org/package/snap-server>`_, version
  0.8.1 and above.
222 223 224
- `case-insensitive`
  <http://hackage.haskell.org/package/case-insensitive>`_, version
  0.4.0.1 and above (it's also a dependency of ``snap-server``).
Aaron Karper's avatar
Aaron Karper committed
225 226
- `PSQueue <http://hackage.haskell.org/package/PSQueue>`_,
  version 1.0 and above.
227

Aaron Karper's avatar
Aaron Karper committed
228
These libraries are available in Debian Wheezy or later, so you can use
229
either apt::
230

Aaron Karper's avatar
Aaron Karper committed
231
  $ apt-get install libghc-snap-server-dev libghc-psqueue-dev
232

233
or ``cabal``::
234

235 236
  $ cabal install --only-dependencies cabal/ganeti.template.cabal \
                  --flags="confd mond metad"
237

Aaron Karper's avatar
Aaron Karper committed
238
to install them.
239

240 241 242 243 244
.. _cabal-note:
.. note::
  Make sure that your ``~/.cabal/bin`` directory (or whatever else
  is defined as ``bindir``) is in your ``PATH``.

245
Installation of the software
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

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
264
----------------------
Iustin Pop's avatar
Iustin Pop committed
265

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

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``.
277 278 279 280 281 282

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