code.grnet.gr Git - ganeti-local/blob - INSTALL

   1 Ganeti quick installation guide
   2 ===============================
   3
   4 Please note that a more detailed installation procedure is described in
   5 the :doc:`install`. A glossary of terms can be found in the
   6 :doc:`glossary`.
   7
   8
   9 Software Requirements
  10 ---------------------
  11
  12 .. highlight:: shell-example
  13
  14 Before installing, please verify that you have the following programs:
  15
  16 - `Xen Hypervisor <http://www.xen.org/>`_, version 3.0 or above, if
  17   running on Xen
  18 - `KVM Hypervisor <http://www.linux-kvm.org>`_, version 72 or above, if
  19   running on KVM. In order to use advanced features, such as live
  20   migration, virtio, etc, an even newer version is recommended (qemu-kvm
  21   versions 0.11.X and above have shown good behavior).
  22 - `DRBD <http://www.drbd.org/>`_, kernel module and userspace utils,
  23   version 8.0.7 or above; note that Ganeti doesn't yet support version 8.4
  24 - `RBD <http://ceph.newdream.net/>`_, kernel modules
  25   (``rbd.ko``/``libceph.ko``) and userspace utils (``ceph-common``)
  26 - `LVM2 <http://sourceware.org/lvm2/>`_
  27 - `OpenSSH <http://www.openssh.com/portable.html>`_
  28 - `bridge utilities <http://www.linuxfoundation.org/en/Net:Bridge>`_
  29 - `iproute2 <http://www.linuxfoundation.org/en/Net:Iproute2>`_
  30 - `arping <http://www.skbuff.net/iputils/>`_ (part of iputils)
  31 - `ndisc6 <http://www.remlab.net/ndisc6/>`_ (if using IPv6)
  32 - `Python <http://www.python.org/>`_, version 2.4 or above, not 3.0
  33 - `Python OpenSSL bindings <http://pyopenssl.sourceforge.net/>`_
  34 - `simplejson Python module <http://code.google.com/p/simplejson/>`_
  35 - `pyparsing Python module <http://pyparsing.wikispaces.com/>`_, version
  36   1.4.6 or above
  37 - `pyinotify Python module <http://trac.dbzteam.org/pyinotify/>`_
  38 - `PycURL Python module <http://pycurl.sourceforge.net/>`_
  39 - `ctypes Python module
  40   <http://starship.python.net/crew/theller/ctypes/>`_, if running on
  41   python 2.4 (optional, used for node daemon memory locking)
  42 - `socat <http://www.dest-unreach.org/socat/>`_, see :ref:`note
  43   <socat-note>` below
  44 - `Paramiko <http://www.lag.net/paramiko/>`_, if you want to use
  45   ``ganeti-listrunner``
  46 - `affinity Python module <http://pypi.python.org/pypi/affinity/0.1.0>`_,
  47   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/>`_
  52 - `Python IP address manipulation library
  53   <http://code.google.com/p/ipaddr-py/>`_
  54 - `Bitarray Python library <http://pypi.python.org/pypi/bitarray/>`_
  55
  56 These programs are supplied as part of most Linux distributions, so
  57 usually they can be installed via the standard package manager. Also
  58 many of them will already be installed on a standard machine. On
  59 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 \
  63                     ndisc6 python python-pyopenssl openssl \
  64                     python-pyparsing python-simplejson \
  65                     python-pyinotify python-pycurl socat fping
  66
  67 Note that this does not install optional packages::
  68
  69   $ apt-get install python-paramiko python-affinity qemu-img
  70
  71 If some of the python packages are not available in your system,
  72 you can try installing them using ``easy_install`` command.
  73 For example::
  74
  75   $ apt-get install python-setuptools
  76   $ cd / && sudo easy_install \
  77             affinity
  78
  79
  80 On Fedora to install all required packages except RBD, DRBD and Xen::
  81
  82   $ yum install openssh openssh-clients bridge-utils iproute ndisc6 \
  83                 pyOpenSSL pyparsing python-simplejson python-inotify \
  84                 python-lxm socat fping
  85
  86 For optional packages use the command::
  87
  88   $ yum install python-paramiko python-affinity qemu-img
  89
  90 If you want to build from source, please see doc/devnotes.rst for more
  91 dependencies.
  92
  93 .. _socat-note:
  94 .. note::
  95   Ganeti's import/export functionality uses ``socat`` with OpenSSL for
  96   transferring data between nodes. By default, OpenSSL 0.9.8 and above
  97   employ transparent compression of all data using zlib if supported by
  98   both sides of a connection. In cases where a lot of data is
  99   transferred, this can lead to an increased CPU usage. Additionally,
 100   Ganeti already compresses all data using ``gzip`` where it makes sense
 101   (for inter-cluster instance moves).
 102
 103   To remedey this situation, patches implementing a new ``socat`` option
 104   for disabling OpenSSL compression have been contributed and will
 105   likely be included in the next feature release. Until then, users or
 106   distributions need to apply the patches on their own.
 107
 108   Ganeti will use the option if it's detected by the ``configure``
 109   script; auto-detection can be disabled by explicitly passing
 110   ``--enable-socat-compress`` (use the option to disable compression) or
 111   ``--disable-socat-compress`` (don't use the option).
 112
 113   The patches and more information can be found on
 114   http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
 115
 116 Haskell requirements
 117 ~~~~~~~~~~~~~~~~~~~~
 118
 119 Starting with Ganeti 2.7, the Haskell GHC compiler and a few base
 120 libraries are required in order to build Ganeti (but not to run and
 121 deploy Ganeti on production machines). More specifically:
 122
 123 - `GHC <http://www.haskell.org/ghc/>`_ version 6.12 or higher
 124 - or even better, `The Haskell Platform
 125   <http://hackage.haskell.org/platform/>`_ which gives you a simple way
 126   to bootstrap Haskell
 127 - `json <http://hackage.haskell.org/package/json>`_, a JSON library
 128 - `network <http://hackage.haskell.org/package/network>`_, a basic
 129   network library
 130 - `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
 131   programming library (note: tested with up to version 3.x)
 132 - `bytestring <http://hackage.haskell.org/package/bytestring>`_ and
 133   `utf8-string <http://hackage.haskell.org/package/utf8-string>`_
 134   libraries; these usually come with the GHC compiler
 135 - `deepseq <http://hackage.haskell.org/package/deepseq>`_
 136
 137 Some of these are also available as package in Debian/Ubuntu::
 138
 139   $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
 140                     libghc6-parallel-dev libghc6-deepseq-dev
 141
 142 Or in newer versions of these distributions (using GHC 7.x)::
 143
 144   $ apt-get install ghc libghc-json-dev libghc-network-dev \
 145                     libghc-parallel-dev  libghc-deepseq-dev \
 146                     libghc-utf8-string-dev
 147
 148 In Fedora, they are available via packages as well::
 149
 150   $ yum install ghc ghc-json-devel ghc-network-devel \
 151                     ghc-parallel-devel ghc-deepseq-devel
 152
 153 If using a distribution which does not provide them, first install
 154 the Haskell platform. You can also install ``cabal`` manually::
 155
 156   $ apt-get install cabal-install
 157
 158 Then install the additional libraries via
 159 ``cabal``::
 160
 161   $ cabal install json network parallel utf8-string
 162
 163 The compilation of the htools components is automatically enabled when
 164 the compiler and the requisite libraries are found. You can use the
 165 ``--enable-htools`` configure flag to force the selection (at which
 166 point ``./configure`` will fail if it doesn't find the prerequisites).
 167
 168
 169 Haskell optional features
 170 ~~~~~~~~~~~~~~~~~~~~~~~~~
 171
 172 Optionally, more functionality can be enabled if your build machine has
 173 a few more Haskell libraries enabled: RAPI access to remote cluster from
 174 htools (``--enable-htools-rapi``), the ``ganeti-confd``
 175 daemon (``--enable-confd``) and the monitoring agent
 176 (``--enable-monitoring``). The list of extra dependencies for these is:
 177
 178 - `curl <http://hackage.haskell.org/package/curl>`_, tested with
 179   versions 1.3.4 and above
 180 - `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
 181   above (note that Debian Squeeze only has version 1.0.9)
 182 - `Crypto <http://hackage.haskell.org/package/Crypto>`_, tested with
 183   version 4.2.4
 184 - `text <http://hackage.haskell.org/package/text>`_
 185 - `hinotify <http://hackage.haskell.org/package/hinotify>`_
 186 - `regex-pcre <http://hackage.haskell.org/package/regex-pcre>`_,
 187   bindings for the ``pcre`` library
 188 - `attoparsec <http://hackage.haskell.org/package/attoparsec>`_
 189
 190 These libraries are available in Debian Wheezy (but not in Squeeze, with
 191 the exception of curl), so you can use either apt::
 192
 193   $ apt-get install libghc-hslogger-dev libghc-crypto-dev libghc-text-dev \
 194                     libghc-hinotify-dev libghc-regex-pcre-dev libghc-curl-dev \
 195                     libghc-attoparsec-dev
 196
 197 or ``cabal``::
 198
 199   $ cabal install hslogger Crypto text hinotify regex-pcre curl \
 200                   attoparsec
 201
 202 to install them.
 203
 204 The most recent Fedora doesn't provide ``curl``, ``crypto``,
 205 ``inotify``. So these need to be installed using ``cabal``, if
 206 desired. The other packages can be installed via ``yum``::
 207
 208   $ yum install ghc-hslogger-devel ghc-text-devel \
 209                 ghc-regex-pcre-devel
 210
 211 .. _cabal-note:
 212 .. note::
 213   If one of the cabal packages fails to install due to unfulfilled
 214   dependencies, you can try enabling symlinks in ``~/.cabal/config``.
 215
 216   Make sure that your ``~/.cabal/bin`` directory (or whatever else
 217   is defined as ``bindir``) is in your ``PATH``.
 218
 219 Installation of the software
 220 ----------------------------
 221
 222 To install, simply run the following command::
 223
 224   $ ./configure --localstatedir=/var --sysconfdir=/etc && \
 225     make && \
 226     make install
 227
 228 This will install the software under ``/usr/local``. You then need to
 229 copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
 230 integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
 231 etc.).
 232
 233
 234 Cluster initialisation
 235 ----------------------
 236
 237 Before initialising the cluster, on each node you need to create the
 238 following directories:
 239
 240 - ``/etc/ganeti``
 241 - ``/var/lib/ganeti``
 242 - ``/var/log/ganeti``
 243 - ``/srv/ganeti``
 244 - ``/srv/ganeti/os``
 245 - ``/srv/ganeti/export``
 246
 247 After this, use ``gnt-cluster init``.
 248
 249 .. vim: set textwidth=72 syntax=rst :
 250 .. Local Variables:
 251 .. mode: rst
 252 .. fill-column: 72
 253 .. End: