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 Before installing, please verify that you have the following programs:
  13
  14 - `Xen Hypervisor <http://www.xen.org/>`_, version 3.0 or above, if
  15   running on Xen
  16 - `KVM Hypervisor <http://www.linux-kvm.org>`_, version 72 or above, if
  17   running on KVM. In order to use advanced features, such as live
  18   migration, virtio, etc, an even newer version is recommended (qemu-kvm
  19   versions 0.11.X or above have shown good behavior).
  20 - `DRBD <http://www.drbd.org/>`_, kernel module and userspace utils,
  21   version 8.0.7 or above
  22 - `LVM2 <http://sourceware.org/lvm2/>`_
  23 - `OpenSSH <http://www.openssh.com/portable.html>`_
  24 - `bridge utilities <http://www.linuxfoundation.org/en/Net:Bridge>`_
  25 - `iproute2 <http://www.linuxfoundation.org/en/Net:Iproute2>`_
  26 - `arping <http://www.skbuff.net/iputils/>`_ (part of iputils)
  27 - `ndisc6 <http://www.remlab.net/ndisc6/>`_ (if using IPv6)
  28 - `Python <http://www.python.org/>`_, version 2.4 or above, not 3.0
  29 - `Python OpenSSL bindings <http://pyopenssl.sourceforge.net/>`_
  30 - `simplejson Python module <http://code.google.com/p/simplejson/>`_
  31 - `pyparsing Python module <http://pyparsing.wikispaces.com/>`_, version
  32   1.4.6 or above
  33 - `pyinotify Python module <http://trac.dbzteam.org/pyinotify/>`_
  34 - `PycURL Python module <http://pycurl.sourceforge.net/>`_
  35 - `ctypes Python module
  36   <http://starship.python.net/crew/theller/ctypes/>`_, if running on
  37   python 2.4 (optional, used for node daemon memory locking)
  38 - `socat <http://www.dest-unreach.org/socat/>`_, see :ref:`note
  39   <socat-note>` below
  40 - `Paramiko <http://www.lag.net/paramiko/>`_, if you want automated SSH
  41   setup; optional otherwise but manual setup of the nodes required
  42
  43 These programs are supplied as part of most Linux distributions, so
  44 usually they can be installed via the standard package manager. Also
  45 many of them will already be installed on a standard machine. On
  46 Debian/Ubuntu, you can use this command line to install all required
  47 packages, except for DRBD and Xen::
  48
  49   $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
  50                     ndisc6 python python-pyopenssl openssl \
  51                     python-pyparsing python-simplejson \
  52                     python-pyinotify python-pycurl socat
  53
  54 If you want to also enable the `htools` components, which is recommended
  55 on bigger deployments (they give you automatic instance placement,
  56 cluster balancing, etc.), then you need to have a Haskell compiler
  57 installed. More specifically:
  58
  59 - `GHC <http://www.haskell.org/ghc/>`_ version 6.10 or higher
  60 - or even better, `The Haskell Platform
  61   <http://hackage.haskell.org/platform/>`_ which gives you a simple way
  62   to bootstrap Haskell
  63 - `json <http://hackage.haskell.org/package/json>`_, a JSON library
  64 - `network <http://hackage.haskell.org/package/network>`_, a basic
  65   network library
  66 - `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
  67   programming library (note: tested with up to version 3.x)
  68 - `curl <http://hackage.haskell.org/package/curl>`_, bindings for the
  69   curl library, only needed if you want these tools to connect to remote
  70   clusters (as opposed to the local one)
  71
  72 All of these are also available as package in Debian/Ubuntu::
  73
  74   $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
  75                     libghc6-parallel-dev libghc6-curl-dev
  76
  77 Note that more recent version have switched to GHC 7.x and the packages
  78 were renamed::
  79
  80   $ apt-get install ghc libghc-json-dev libghc-network-dev \
  81                     libghc-parallel-dev libghc-curl-dev
  82
  83 The compilation of the htools components is automatically enabled when
  84 the compiler and the requisite libraries are found. You can use the
  85 ``--enable-htools`` configure flag to force the selection (at which
  86 point ``./configure`` will fail if it doesn't find the prerequisites).
  87
  88 If you want to build from source, please see doc/devnotes.rst for more
  89 dependencies.
  90
  91 .. _socat-note:
  92 .. note::
  93   Ganeti's import/export functionality uses ``socat`` with OpenSSL for
  94   transferring data between nodes. By default, OpenSSL 0.9.8 and above
  95   employ transparent compression of all data using zlib if supported by
  96   both sides of a connection. In cases where a lot of data is
  97   transferred, this can lead to an increased CPU usage. Additionally,
  98   Ganeti already compresses all data using ``gzip`` where it makes sense
  99   (for inter-cluster instance moves).
 100
 101   To remedey this situation, patches implementing a new ``socat`` option
 102   for disabling OpenSSL compression have been contributed and will
 103   likely be included in the next feature release. Until then, users or
 104   distributions need to apply the patches on their own.
 105
 106   Ganeti will use the option if it's detected by the ``configure``
 107   script; auto-detection can be disabled by explicitely passing
 108   ``--enable-socat-compress`` (use the option to disable compression) or
 109   ``--disable-socat-compress`` (don't use the option).
 110
 111   The patches and more information can be found on
 112   http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
 113
 114
 115 Installation of the software
 116 ----------------------------
 117
 118 To install, simply run the following command::
 119
 120   ./configure --localstatedir=/var --sysconfdir=/etc && \
 121   make && \
 122   make install
 123
 124 This will install the software under ``/usr/local``. You then need to
 125 copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
 126 integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
 127 etc.).
 128
 129
 130 Cluster initialisation
 131 ----------------------
 132
 133 Before initialising the cluster, on each node you need to create the
 134 following directories:
 135
 136 - ``/etc/ganeti``
 137 - ``/var/lib/ganeti``
 138 - ``/var/log/ganeti``
 139 - ``/srv/ganeti``
 140 - ``/srv/ganeti/os``
 141 - ``/srv/ganeti/export``
 142
 143 After this, use ``gnt-cluster init``.
 144
 145 .. vim: set textwidth=72 syntax=rst :
 146 .. Local Variables:
 147 .. mode: rst
 148 .. fill-column: 72
 149 .. End: