X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/daa4dcc1541265b833210b1772c046df4d981ffa..6386c5460133dc532106705af481f55bd5f1fb03:/INSTALL diff --git a/INSTALL b/INSTALL index 8cb52ff..fa9ca65 100644 --- a/INSTALL +++ b/INSTALL @@ -2,13 +2,16 @@ Ganeti quick installation guide =============================== Please note that a more detailed installation procedure is described in -the :doc:`install`. A glossary of terms can be found in the -:doc:`glossary`. +the :doc:`install`. Refer to it if you are setting up Ganeti the first time. +This quick installation guide is mainly meant as reference for experienced +users. A glossary of terms can be found in the :doc:`glossary`. Software Requirements --------------------- +.. highlight:: shell-example + Before installing, please verify that you have the following programs: - `Xen Hypervisor `_, version 3.0 or above, if @@ -16,79 +19,84 @@ 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 `_ - `iproute2 `_ - `arping `_ (part of iputils) - `ndisc6 `_ (if using IPv6) -- `Python `_, version 2.4 or above, not 3.0 +- `Python `_, version 2.6 or above, not 3.0 - `Python OpenSSL bindings `_ - `simplejson Python module `_ - `pyparsing Python module `_, version 1.4.6 or above -- `pyinotify Python module `_ +- `pyinotify Python module `_ - `PycURL Python module `_ -- `ctypes Python module - `_, if running on - python 2.4 (optional, used for node daemon memory locking) - `socat `_, see :ref:`note ` below -- `Paramiko `_, if you want automated SSH - setup; optional otherwise but manual setup of the nodes required +- `Paramiko `_, if you want to use + ``ganeti-listrunner`` - `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`` +- `fping `_ +- `Python IP address manipulation library + `_ +- `Bitarray Python library `_ +- `GNU Make `_ 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 make \ + ndisc6 python python-openssl openssl \ + python-pyparsing python-simplejson python-bitarray \ + python-pyinotify python-pycurl python-ipaddr socat fping - $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \ +For older distributions (eg. Debian Squeeze) the package names are +different.:: + + $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping make \ ndisc6 python python-pyopenssl openssl \ - python-pyparsing python-simplejson \ - python-pyinotify python-pycurl socat \ - python-elementtree + python-pyparsing python-simplejson python-bitarray \ + python-pyinotify python-pycurl python-ipaddr 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: +If bitarray is missing it can be installed from easy-install:: -- `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) + $ easy_install bitarray -All of these are also available as package in Debian/Ubuntu:: +Note that this does not install optional packages:: - $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \ - libghc6-parallel-dev libghc6-curl-dev + $ apt-get install python-paramiko python-affinity qemu-img -Note that more recent version have switched to GHC 7.x and the packages -were renamed:: +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 python-dev + $ cd / && sudo easy_install \ + affinity \ + bitarray \ + ipaddr - $ apt-get install ghc libghc-json-dev libghc-network-dev \ - libghc-parallel-dev libghc-curl-dev -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). +On Fedora to install all required packages except RBD, DRBD and Xen:: + + $ yum install openssh openssh-clients bridge-utils iproute ndisc6 make \ + pyOpenSSL pyparsing python-simplejson python-inotify \ + python-lxm socat fping python-bitarray python-ipaddr + +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. @@ -109,22 +117,137 @@ 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 `_ +- `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) + +Some of these are also available as package in Debian/Ubuntu:: + + $ apt-get install ghc libghc-json-dev libghc-network-dev \ + libghc-parallel-dev libghc-deepseq-dev \ + libghc-utf8-string-dev libghc-curl-dev \ + libghc-hslogger-dev + +Or in older versions of these distributions (using GHC 6.x):: + + $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \ + libghc6-parallel-dev libghc6-deepseq-dev \ + libghc6-curl-dev + +In Fedora, some of them 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 + $ cabal update + +Then install the additional libraries (only the ones not available in your +distribution packages) via ``cabal``:: + + $ cabal install json network parallel utf8-string curl hslogger + +Haskell optional features +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Optionally, more functionality can be enabled if your build machine has +a few more Haskell libraries enabled: the ``ganeti-confd`` and +``ganeti-luxid`` daemon (``--enable-confd``) and the monitoring daemon +(``--enable-mond``). The list of extra dependencies for these is: + +- `Crypto `_, tested with + version 4.2.4 +- `text `_ +- `hinotify `_, tested with + version 0.3.2 +- `regex-pcre `_, + bindings for the ``pcre`` library +- `attoparsec `_ +- `vector `_ +- `snap-server` `_, version + 0.8.1 and above. +- `process `_, version 1.0.1.1 and + above + +These libraries are available in Debian Wheezy (but not in Squeeze), so you +can use either apt:: + + $ apt-get install libghc-crypto-dev libghc-text-dev \ + libghc-hinotify-dev libghc-regex-pcre-dev \ + libghc-attoparsec-dev libghc-vector-dev \ + libghc-snap-server-dev + +or ``cabal``, after installing a required non-Haskell dependency:: + + $ apt-get install libpcre3-dev libcurl4-openssl-dev + $ cabal install Crypto text hinotify==0.3.2 regex-pcre \ + attoparsec vector snap-server + +to install them. + +In case you still use ghc-6.12, note that ``cabal`` would automatically try to +install newer versions of some of the libraries snap-server depends on, that +cannot be compiled with ghc-6.12, so you have to install snap-server on its +own, esplicitly forcing the installation of compatible versions:: + + $ cabal install MonadCatchIO-transformers==0.2.2.0 mtl==2.0.1.0 \ + hashable==1.1.2.0 case-insensitive==0.3 parsec==3.0.1 \ + network==2.3 snap-server==0.8.1 + +The most recent Fedora doesn't provide ``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