X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/d9eefcfa73b2f45617103c2bcf52a879cc459ddf..893ad76d18e1a8286247e06c8451bbd4831cff8f:/INSTALL diff --git a/INSTALL b/INSTALL index 960abca..70f7056 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 `_ @@ -42,55 +46,43 @@ Before installing, please verify that you have the following programs: - `affinity Python module `_, optional python package for supporting CPU pinning under KVM - `ElementTree Python module `_, - if running python 2.4 (optional, used by ovfconverter tool) -- `qemu-img `_, if you want to use ovfconverter + 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-elementtree qemu + python-pyinotify python-pycurl socat fping -If you want to also enable the `htools` components, which is recommended -on bigger deployments (they give you automatic instance placement, -cluster balancing, etc.), then you need to have a Haskell compiler -installed. More specifically: +Note that this does not install optional packages:: -- `GHC `_ version 6.10 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) -- `curl `_, bindings for the - curl library, only needed if you want these tools to connect to remote - clusters (as opposed to the local one) + $ apt-get install python-paramiko python-affinity qemu-img -All of these are also available as package in Debian/Ubuntu:: +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 ghc6 libghc6-json-dev libghc6-network-dev \ - libghc6-parallel-dev libghc6-curl-dev + $ apt-get install python-setuptools + $ cd / && sudo easy_install \ + affinity -Note that more recent version have switched to GHC 7.x and the packages -were renamed:: - $ apt-get install ghc libghc-json-dev libghc-network-dev \ - libghc-parallel-dev libghc-curl-dev +On Fedora to install all required packages except RBD, DRBD and Xen:: -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). + $ 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. @@ -111,22 +103,116 @@ 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 +~~~~~~~~~~~~~~~~~~~~ + +If you want to enable the `htools` component, which is recommended on +bigger deployments (this give you automatic instance placement, cluster +balancing, etc.), then you need to have a Haskell compiler installed on +your build machine (but this is not required on the machines which are +just going to run Ganeti). 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) +- `curl `_, bindings for the + curl library, only needed if you want these tools to connect to remote + clusters (as opposed to the local one) +- `bytestring `_ and + `utf8-string `_ + libraries; these usually come with the GHC compiler +- `regex-pcre `_, + bindings for the ``pcre`` library + +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-curl-dev + +Or in Fedora running:: + + $ yum install ghc ghc-json-devel ghc-network-devel ghc-parallel-devel + +The most recent Fedora doesn't provide ``ghc-curl``. So this needs to be +installed using ``cabal`` or alternatively htools can be build without +curl support. + +Note that more recent version have switched to GHC 7.x and the packages +were renamed:: + + $ apt-get install ghc libghc-json-dev libghc-network-dev \ + libghc-parallel-dev libghc-curl-dev \ + libghc-regex-pcre-dev + +If using a distribution which does not provide them, first install +the Haskell platform. You can also install ``cabal`` manualy:: + + $ apt-get install cabal-install + +Then install the additional libraries via +``cabal``:: + + $ cabal install json network parallel curl regex-pcre + +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). + +In Ganeti version 2.6, one of the daemons (``ganeti-confd``) is shipped +in two versions: the Python default version (which has no extra +dependencies), and an experimental Haskell version. This latter version +can be enabled via the ``./configure`` flag ``--enable-confd=haskell`` +and a few has extra dependencies: + +- `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 `_ + +These libraries are available in Debian Wheezy (but not in Squeeze), so +you can use either apt:: + + $ apt-get install libghc-hslogger-dev libghc-crypto-dev libghc-text-dev \ + libghc-hinotify-dev + +or ``cabal``:: + + $ cabal install hslogger Crypto text hinotify + +to install them. + +.. _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