X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/e90739d625beb8847becbd5c2cf893d8e2619db3..318853ab71bda7615f3abe5e9a9aaf5445ae44a4:/INSTALL diff --git a/INSTALL b/INSTALL index 0c44f75..03e9363 100644 --- a/INSTALL +++ b/INSTALL @@ -9,6 +9,8 @@ the :doc:`install`. A glossary of terms can be found in the Software Requirements --------------------- +.. highlight:: shell-example + Before installing, please verify that you have the following programs: - `Xen Hypervisor `_, version 3.0 or above, if @@ -16,9 +18,11 @@ Before installing, please verify that you have the following programs: - `KVM Hypervisor `_, 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 - versions 0.11.X or above have shown good behavior). + versions 0.11.X and above have shown good behavior). - `DRBD `_, kernel module and userspace utils, - version 8.0.7 or above + version 8.0.7 or above; note that Ganeti doesn't yet support version 8.4 +- `RBD `_, kernel modules + (``rbd.ko``/``libceph.ko``) and userspace utils (``ceph-common``) - `LVM2 `_ - `OpenSSH `_ - `bridge utilities `_ @@ -28,7 +32,8 @@ Before installing, please verify that you have the following programs: - `Python `_, version 2.4 or above, not 3.0 - `Python OpenSSL bindings `_ - `simplejson Python module `_ -- `pyparsing Python module `_ +- `pyparsing Python module `_, version + 1.4.6 or above - `pyinotify Python module `_ - `PycURL Python module `_ - `ctypes Python module @@ -38,17 +43,46 @@ Before installing, please verify that you have the following programs: ` below - `Paramiko `_, if you want automated SSH setup; optional otherwise but manual setup of the nodes required +- `affinity Python module `_, + optional python package for supporting CPU pinning under KVM +- `ElementTree Python module `_, + if running on python 2.4 (optional, used by the ``ovfconverter`` tool) +- `qemu-img `_, if you want to use ``ovfconverter`` +- `fping `_ 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 -packages, except for DRBD and Xen:: +packages, except for RBD, DRBD and Xen:: $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \ ndisc6 python python-pyopenssl openssl \ python-pyparsing python-simplejson \ - python-pyinotify python-pycurl socat + 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 + + +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 \ + python-lxm socat fping + +For optional packages use the command:: + + $ yum install python-paramiko python-affinity qemu-img If you want to build from source, please see doc/devnotes.rst for more dependencies. @@ -69,22 +103,121 @@ dependencies. distributions need to apply the patches on their own. Ganeti will use the option if it's detected by the ``configure`` - script; auto-detection can be disabled by explicitely passing + script; auto-detection can be disabled by explicitly passing ``--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 +~~~~~~~~~~~~~~~~~~~~ + +Starting with Ganeti 2.7, the Haskell GHC compiler and a few base +libraries are required in order to build Ganeti (but not to run and +deploy Ganeti on production machines). More specifically: + +- `GHC `_ version 6.12 or higher +- or even better, `The Haskell Platform + `_ which gives you a simple way + to bootstrap Haskell +- `json `_, a JSON library +- `network `_, a basic + network library +- `parallel `_, a parallel + programming library (note: tested with up to version 3.x) +- `bytestring `_ and + `utf8-string `_ + libraries; these usually come with the GHC compiler +- `deepseq `_ + +Some of these are also available as package in Debian/Ubuntu:: + + $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \ + libghc6-parallel-dev libghc6-deepseq-dev + +Or in newer versions of these distributions (using GHC 7.x):: + + $ apt-get install ghc libghc-json-dev libghc-network-dev \ + libghc-parallel-dev libghc-deepseq-dev \ + libghc-utf8-string-dev + +In Fedora, they are available via packages as well:: + + $ yum install ghc ghc-json-devel ghc-network-devel \ + ghc-parallel-devel ghc-deepseq-devel + +If using a distribution which does not provide them, first install +the Haskell platform. You can also install ``cabal`` manually:: + + $ apt-get install cabal-install + +Then install the additional libraries via +``cabal``:: + + $ cabal install json network parallel utf8-string + +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). + + +Haskell optional features +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Optionally, more functionality can be enabled if your build machine has +a few more Haskell libraries enabled: RAPI access to remote cluster from +htools (``--enable-htools-rapi``) and enabling the ``ganeti-confd`` +daemon (``--enable-confd``). The list of extra dependencies for these +is: + +- `curl `_, tested with + versions 1.3.4 and above +- `hslogger `_, version 1.1 and + above (note that Debian Squeeze only has version 1.0.9) +- `Crypto `_, tested with + version 4.2.4 +- `text `_ +- `hinotify `_ +- `regex-pcre `_, + bindings for the ``pcre`` library + +These libraries are available in Debian Wheezy (but not in Squeeze, with +the exception of curl), so you can use either apt:: + + $ apt-get install libghc-hslogger-dev libghc-crypto-dev libghc-text-dev \ + libghc-hinotify-dev libghc-regex-pcre-dev libghc-curl-dev + +or ``cabal``:: + + $ cabal install hslogger Crypto text hinotify regex-pcre curl + +to install them. + +The most recent Fedora doesn't provide ``curl``, ``crypto``, +``inotify``. So these need to be installed using ``cabal``, if +desired. The other packages can be installed via ``yum``:: + + $ yum install ghc-hslogger-devel ghc-text-devel \ + ghc-regex-pcre-devel + +.. _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``. Installation of the software ---------------------------- To install, simply run the following command:: - ./configure --localstatedir=/var --sysconfdir=/etc && \ - make && \ - make install + $ ./configure --localstatedir=/var --sysconfdir=/etc && \ + make && \ + make install This will install the software under ``/usr/local``. You then need to copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and