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 automated SSH
  45   setup; optional otherwise but manual setup of the nodes required
  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 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
  53 These programs are supplied as part of most Linux distributions, so
  54 usually they can be installed via the standard package manager. Also
  55 many of them will already be installed on a standard machine. On
  56 Debian/Ubuntu, you can use this command line to install all required
  57 packages, except for RBD, DRBD and Xen::
  58
  59   $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
  60                     ndisc6 python python-pyopenssl openssl \
  61                     python-pyparsing python-simplejson \
  62                     python-pyinotify python-pycurl socat \
  63                     python-elementtree qemu
  64
  65 On Fedora to install all required packages except RBD, DRBD and Xen::
  66
  67   $ yum install openssh openssh-clients bridge-utils iproute ndisc6 \
  68                 pyOpenSSL pyparsing python-simplejson python-inotify \
  69                 python-lxml python-paramiko socat qemu-img
  70
  71
  72 If you want to build from source, please see doc/devnotes.rst for more
  73 dependencies.
  74
  75 .. _socat-note:
  76 .. note::
  77   Ganeti's import/export functionality uses ``socat`` with OpenSSL for
  78   transferring data between nodes. By default, OpenSSL 0.9.8 and above
  79   employ transparent compression of all data using zlib if supported by
  80   both sides of a connection. In cases where a lot of data is
  81   transferred, this can lead to an increased CPU usage. Additionally,
  82   Ganeti already compresses all data using ``gzip`` where it makes sense
  83   (for inter-cluster instance moves).
  84
  85   To remedey this situation, patches implementing a new ``socat`` option
  86   for disabling OpenSSL compression have been contributed and will
  87   likely be included in the next feature release. Until then, users or
  88   distributions need to apply the patches on their own.
  89
  90   Ganeti will use the option if it's detected by the ``configure``
  91   script; auto-detection can be disabled by explicitly passing
  92   ``--enable-socat-compress`` (use the option to disable compression) or
  93   ``--disable-socat-compress`` (don't use the option).
  94
  95   The patches and more information can be found on
  96   http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
  97
  98 Haskell requirements
  99 ~~~~~~~~~~~~~~~~~~~~
 100
 101 If you want to enable the `htools` component, which is recommended on
 102 bigger deployments (this give you automatic instance placement, cluster
 103 balancing, etc.), then you need to have a Haskell compiler installed on
 104 your build machine (but this is not required on the machines which are
 105 just going to run Ganeti). More specifically:
 106
 107 - `GHC <http://www.haskell.org/ghc/>`_ version 6.12 or higher
 108 - or even better, `The Haskell Platform
 109   <http://hackage.haskell.org/platform/>`_ which gives you a simple way
 110   to bootstrap Haskell
 111 - `json <http://hackage.haskell.org/package/json>`_, a JSON library
 112 - `network <http://hackage.haskell.org/package/network>`_, a basic
 113   network library
 114 - `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
 115   programming library (note: tested with up to version 3.x)
 116 - `curl <http://hackage.haskell.org/package/curl>`_, bindings for the
 117   curl library, only needed if you want these tools to connect to remote
 118   clusters (as opposed to the local one)
 119
 120 All of these are also available as package in Debian/Ubuntu::
 121
 122   $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
 123                     libghc6-parallel-dev libghc6-curl-dev
 124
 125 Or in Fedora running::
 126
 127   $ yum install ghc ghc-json-devel ghc-network-devel ghc-parallel-devel
 128
 129 The most recent Fedora doesn't provide ``ghc-curl``. So this needs to be
 130 installed using ``cabal`` or alternatively htools can be build without
 131 curl support.
 132
 133 Note that more recent version have switched to GHC 7.x and the packages
 134 were renamed::
 135
 136   $ apt-get install ghc libghc-json-dev libghc-network-dev \
 137                     libghc-parallel-dev libghc-curl-dev
 138
 139 If using a distribution which does not provide them, the first install
 140 the Haskell platform and then install the additional libraries via
 141 ``cabal``::
 142
 143   $ cabal install json network parallel curl
 144
 145 The compilation of the htools components is automatically enabled when
 146 the compiler and the requisite libraries are found. You can use the
 147 ``--enable-htools`` configure flag to force the selection (at which
 148 point ``./configure`` will fail if it doesn't find the prerequisites).
 149
 150 In Ganeti version 2.6, one of the daemons (``ganeti-confd``) is shipped
 151 in two versions: the Python default version (which has no extra
 152 dependencies), and an experimental Haskell version. This latter version
 153 can be enabled via the ``./configure`` flag ``--enable-confd=haskell``
 154 and a few has extra dependencies:
 155
 156 - `hslogger <http://software.complete.org/hslogger>`_, version 1.1 and
 157   above (note that Debian Squeeze only has version 1.0.9)
 158 - `Crypto <http://hackage.haskell.org/package/Crypto>`_, tested with
 159   version 4.2.4
 160 - `text <http://hackage.haskell.org/package/text>`_
 161 - ``bytestring``, which usually comes with the compiler
 162 - `hinotify <http://hackage.haskell.org/package/hinotify>`_
 163
 164 These libraries are available in Debian Wheezy (but not in Squeeze), so
 165 you can use either apt::
 166
 167   $ apt-get install libghc-hslogger-dev libghc-crypto-dev libghc-text-dev \
 168                     libghc-hinotify-dev
 169
 170 or ``cabal``::
 171
 172   $ cabal install hslogger Crypto text hinotify
 173
 174 to install them.
 175
 176 Installation of the software
 177 ----------------------------
 178
 179 To install, simply run the following command::
 180
 181   $ ./configure --localstatedir=/var --sysconfdir=/etc && \
 182     make && \
 183     make install
 184
 185 This will install the software under ``/usr/local``. You then need to
 186 copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
 187 integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
 188 etc.).
 189
 190
 191 Cluster initialisation
 192 ----------------------
 193
 194 Before initialising the cluster, on each node you need to create the
 195 following directories:
 196
 197 - ``/etc/ganeti``
 198 - ``/var/lib/ganeti``
 199 - ``/var/log/ganeti``
 200 - ``/srv/ganeti``
 201 - ``/srv/ganeti/os``
 202 - ``/srv/ganeti/export``
 203
 204 After this, use ``gnt-cluster init``.
 205
 206 .. vim: set textwidth=72 syntax=rst :
 207 .. Local Variables:
 208 .. mode: rst
 209 .. fill-column: 72
 210 .. End: