INSTALL 9.43 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 5 6
Please note that a more detailed installation procedure is described in
the :doc:`install`. A glossary of terms can be found in the
:doc:`glossary`.
7 8


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

12 13
.. highlight:: shell-example

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

16 17 18 19 20
- `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
21
  versions 0.11.X and above have shown good behavior).
Michael Hanselmann's avatar
Michael Hanselmann committed
22
- `DRBD <http://www.drbd.org/>`_, kernel module and userspace utils,
23 24 25
  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
26 27 28 29 30
- `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)
31
- `ndisc6 <http://www.remlab.net/ndisc6/>`_ (if using IPv6)
Michael Hanselmann's avatar
Michael Hanselmann committed
32 33 34
- `Python <http://www.python.org/>`_, version 2.4 or above, not 3.0
- `Python OpenSSL bindings <http://pyopenssl.sourceforge.net/>`_
- `simplejson Python module <http://code.google.com/p/simplejson/>`_
35 36
- `pyparsing Python module <http://pyparsing.wikispaces.com/>`_, version
  1.4.6 or above
Michael Hanselmann's avatar
Michael Hanselmann committed
37
- `pyinotify Python module <http://trac.dbzteam.org/pyinotify/>`_
38
- `PycURL Python module <http://pycurl.sourceforge.net/>`_
39 40 41
- `ctypes Python module
  <http://starship.python.net/crew/theller/ctypes/>`_, if running on
  python 2.4 (optional, used for node daemon memory locking)
42 43
- `socat <http://www.dest-unreach.org/socat/>`_, see :ref:`note
  <socat-note>` below
44 45
- `Paramiko <http://www.lag.net/paramiko/>`_, if you want automated SSH
  setup; optional otherwise but manual setup of the nodes required
46 47
- `affinity Python module <http://pypi.python.org/pypi/affinity/0.1.0>`_,
  optional python package for supporting CPU pinning under KVM
48
- `ElementTree Python module <http://effbot.org/zone/element-index.htm>`_,
49
  if running on python 2.4 (optional, used by the ``ovfconverter`` tool)
50
- `qemu-img <http://qemu.org/>`_, if you want to use ``ovfconverter``
51
- `fping <http://fping.sourceforge.net/>`_
Michael Hanselmann's avatar
Michael Hanselmann committed
52 53 54 55 56

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

  $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
60 61
                    ndisc6 python python-pyopenssl openssl \
                    python-pyparsing python-simplejson \
62 63 64 65 66 67 68 69 70 71 72 73 74 75
                    python-pyinotify python-pycurl socat fping

Note that this does not install optional packages::

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

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

  $ apt-get install python-setuptools
  $ cd / && sudo easy_install \
            affinity

Michael Hanselmann's avatar
Michael Hanselmann committed
76

77 78 79 80
On Fedora to install all required packages except RBD, DRBD and Xen::

  $ yum install openssh openssh-clients bridge-utils iproute ndisc6 \
                pyOpenSSL pyparsing python-simplejson python-inotify \
81 82 83
                python-lxm socat fping

For optional packages use the command::
84

85
  $ yum install python-paramiko python-affinity qemu-img
86

87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
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
106
  script; auto-detection can be disabled by explicitly passing
107 108 109 110 111 112 113 114 115 116 117 118 119 120
  ``--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
~~~~~~~~~~~~~~~~~~~~

If you want to enable the `htools` component, which is recommended on
bigger deployments (this give you automatic instance placement, cluster
balancing, etc.), then you need to have a Haskell compiler installed on
your build machine (but this is not required on the machines which are
just going to run Ganeti). More specifically:
121

122
- `GHC <http://www.haskell.org/ghc/>`_ version 6.12 or higher
123 124 125 126 127 128
- 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
129 130
- `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
  programming library (note: tested with up to version 3.x)
131 132 133
- `curl <http://hackage.haskell.org/package/curl>`_, bindings for the
  curl library, only needed if you want these tools to connect to remote
  clusters (as opposed to the local one)
134 135 136
- `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
Iustin Pop's avatar
Iustin Pop committed
137 138
- `regex-pcre <http://hackage.haskell.org/package/regex-pcre>`_,
  bindings for the ``pcre`` library
139

Iustin Pop's avatar
Iustin Pop committed
140
Some of these are also available as package in Debian/Ubuntu::
141 142 143 144

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

145 146 147 148 149 150 151 152
Or in Fedora running::

  $ yum install ghc ghc-json-devel ghc-network-devel ghc-parallel-devel

The most recent Fedora doesn't provide ``ghc-curl``. So this needs to be
installed using ``cabal`` or alternatively htools can be build without
curl support.

153
Note that more recent versions have switched to GHC 7.x and the packages
154 155 156
were renamed::

  $ apt-get install ghc libghc-json-dev libghc-network-dev \
Iustin Pop's avatar
Iustin Pop committed
157
                    libghc-parallel-dev libghc-curl-dev \
158
                    libghc-regex-pcre-dev libghc-utf8-string-dev
159

160 161 162 163 164 165
If using a distribution which does not provide them, first install
the Haskell platform. You can also install ``cabal`` manualy::

  $ apt-get install cabal-install

Then install the additional libraries via
166 167
``cabal``::

168
  $ cabal install json network parallel curl regex-pcre utf8-string
169

170 171 172 173 174
The compilation of the htools components is automatically enabled when
the compiler and the requisite libraries are found. You can use the
``--enable-htools`` configure flag to force the selection (at which
point ``./configure`` will fail if it doesn't find the prerequisites).

175 176 177 178 179
In Ganeti version 2.6, one of the daemons (``ganeti-confd``) is shipped
in two versions: the Python default version (which has no extra
dependencies), and an experimental Haskell version. This latter version
can be enabled via the ``./configure`` flag ``--enable-confd=haskell``
and a few has extra dependencies:
180

181 182 183 184 185
- `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
  above (note that Debian Squeeze only has version 1.0.9)
- `Crypto <http://hackage.haskell.org/package/Crypto>`_, tested with
  version 4.2.4
- `text <http://hackage.haskell.org/package/text>`_
186
- `hinotify <http://hackage.haskell.org/package/hinotify>`_
187

188 189
These libraries are available in Debian Wheezy (but not in Squeeze), so
you can use either apt::
190

191 192
  $ apt-get install libghc-hslogger-dev libghc-crypto-dev libghc-text-dev \
                    libghc-hinotify-dev
193

194 195
or ``cabal``::

196
  $ cabal install hslogger Crypto text hinotify
197

198
to install them.
199

200 201 202 203 204 205 206 207
.. _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``.

208
Installation of the software
Michael Hanselmann's avatar
Michael Hanselmann committed
209 210 211
----------------------------

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

213 214 215
  $ ./configure --localstatedir=/var --sysconfdir=/etc && \
    make && \
    make install
Iustin Pop's avatar
Iustin Pop committed
216

Michael Hanselmann's avatar
Michael Hanselmann committed
217 218 219 220
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``,
etc.).
Iustin Pop's avatar
Iustin Pop committed
221

222

Iustin Pop's avatar
Iustin Pop committed
223
Cluster initialisation
Michael Hanselmann's avatar
Michael Hanselmann committed
224
----------------------
Iustin Pop's avatar
Iustin Pop committed
225

Michael Hanselmann's avatar
Michael Hanselmann committed
226 227
Before initialising the cluster, on each node you need to create the
following directories:
Iustin Pop's avatar
Iustin Pop committed
228

Michael Hanselmann's avatar
Michael Hanselmann committed
229 230 231 232 233 234
- ``/etc/ganeti``
- ``/var/lib/ganeti``
- ``/var/log/ganeti``
- ``/srv/ganeti``
- ``/srv/ganeti/os``
- ``/srv/ganeti/export``
Iustin Pop's avatar
Iustin Pop committed
235 236

After this, use ``gnt-cluster init``.
Michael Hanselmann's avatar
Michael Hanselmann committed
237 238 239 240 241 242

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