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/>`_
  32 - `pyinotify Python module <http://trac.dbzteam.org/pyinotify/>`_
  33 - `PycURL Python module <http://pycurl.sourceforge.net/>`_
  34 - `ctypes Python module
  35   <http://starship.python.net/crew/theller/ctypes/>`_, if running on
  36   python 2.4 (optional, used for node daemon memory locking)
  37 - `socat <http://www.dest-unreach.org/socat/>`_, see :ref:`note
  38   <socat-note>` below
  39 - `Paramiko <http://www.lag.net/paramiko/>`_, if you want automated SSH
  40   setup; optional otherwise but manual setup of the nodes required
  41
  42 These programs are supplied as part of most Linux distributions, so
  43 usually they can be installed via the standard package manager. Also
  44 many of them will already be installed on a standard machine. On
  45 Debian/Ubuntu, you can use this command line to install all required
  46 packages, except for DRBD and Xen::
  47
  48   $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
  49                     ndisc6 python python-pyopenssl openssl \
  50                     python-pyparsing python-simplejson \
  51                     python-pyinotify python-pycurl socat
  52
  53 If you want to also enable the `htools` components, which is recommended
  54 on bigger deployments (they give you automatic instance placement,
  55 cluster balancing, etc.), then you need to have a Haskell compiler
  56 installed. More specifically:
  57
  58 - `GHC <http://www.haskell.org/ghc/>`_ version 6.10 or higher
  59 - or even better, `The Haskell Platform
  60   <http://hackage.haskell.org/platform/>`_ which gives you a simple way
  61   to bootstrap Haskell
  62 - `json <http://hackage.haskell.org/package/json>`_, a JSON library
  63 - `network <http://hackage.haskell.org/package/network>`_, a basic
  64   network library
  65 - `parallel <http://hackage.haskell.org/package/parallel>`_, version 1.x
  66   or 2.x, a parallel programming library (note: version 3.x is not yet
  67   supported)
  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 If you want to build from source, please see doc/devnotes.rst for more
  78 dependencies.
  79
  80 .. _socat-note:
  81 .. note::
  82   Ganeti's import/export functionality uses ``socat`` with OpenSSL for
  83   transferring data between nodes. By default, OpenSSL 0.9.8 and above
  84   employ transparent compression of all data using zlib if supported by
  85   both sides of a connection. In cases where a lot of data is
  86   transferred, this can lead to an increased CPU usage. Additionally,
  87   Ganeti already compresses all data using ``gzip`` where it makes sense
  88   (for inter-cluster instance moves).
  89
  90   To remedey this situation, patches implementing a new ``socat`` option
  91   for disabling OpenSSL compression have been contributed and will
  92   likely be included in the next feature release. Until then, users or
  93   distributions need to apply the patches on their own.
  94
  95   Ganeti will use the option if it's detected by the ``configure``
  96   script; auto-detection can be disabled by explicitely passing
  97   ``--enable-socat-compress`` (use the option to disable compression) or
  98   ``--disable-socat-compress`` (don't use the option).
  99
 100   The patches and more information can be found on
 101   http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
 102
 103
 104 Installation of the software
 105 ----------------------------
 106
 107 To install, simply run the following command::
 108
 109   ./configure --localstatedir=/var --sysconfdir=/etc && \
 110   make && \
 111   make install
 112
 113 This will install the software under ``/usr/local``. You then need to
 114 copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
 115 integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
 116 etc.).
 117
 118
 119 Cluster initialisation
 120 ----------------------
 121
 122 Before initialising the cluster, on each node you need to create the
 123 following directories:
 124
 125 - ``/etc/ganeti``
 126 - ``/var/lib/ganeti``
 127 - ``/var/log/ganeti``
 128 - ``/srv/ganeti``
 129 - ``/srv/ganeti/os``
 130 - ``/srv/ganeti/export``
 131
 132 After this, use ``gnt-cluster init``.
 133
 134 .. vim: set textwidth=72 syntax=rst :
 135 .. Local Variables:
 136 .. mode: rst
 137 .. fill-column: 72
 138 .. End: