Ganeti quick installation guide

Please note that a more detailed installation procedure is described in the Ganeti installation tutorial. 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 Glossary.

Software Requirements

Before installing, please verify that you have the following programs:

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 RBD, DRBD and Xen:

$ apt-get install lvm2 ssh iproute iputils-arping make m4 \
                  ndisc6 python3 python3-openssl openssl \
                  python3-pyparsing python3-simplejson python3-bitarray \
                  python3-pyinotify python3-pycurl socat fping

Note that the previous instructions don’t install optional packages. To install the optional package, run the following line.:

$ apt-get install python3-paramiko python3-psutil qemu-utils

If you want to run the QA suite, you also need the follwing packages:

$ apt-get install python3-yaml python3-mock

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 / && easy_install \
          psutil \
          bitarray \

On Fedora to install all required packages except RBD, DRBD and Xen:

$ yum install openssh openssh-clients 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-psutil qemu-img

If you want to build from source, please see doc/devnotes.rst for more dependencies.

Note

Ganeti’s import/export functionality uses socat with OpenSSL for transferring data between nodes. By default, OpenSSL 0.9.8 and above employ transparent compression of all data using zlib if supported by both sides of a connection. In cases where a lot of data is transferred, this can lead to an increased CPU usage. Additionally, Ganeti already compresses all data using gzip where it makes sense (for inter-cluster instance moves).

To remedey this situation, patches implementing a new socat option for disabling OpenSSL compression have been contributed and will likely be included in the next feature release. Until then, users or 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 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:

Some of these are also available as package in Debian/Ubuntu:

$ apt-get install ghc ghc-ghci cabal-install \
                  libghc-case-insensitive-dev  libghc-curl-dev \
                  libghc-json-dev libghc-lens-dev \
                  libghc-network-dev libghc-parallel-dev \
                  libghc-utf8-string-dev libghc-deepseq-dev \
                  libghc-hslogger-dev libghc-cryptonite-dev \
                  libghc-text-dev libghc-hinotify-dev \
                  libghc-base64-bytestring-dev libghc-zlib-dev \
                  libghc-regex-pcre-dev libghc-attoparsec-dev
                  libghc-vector-dev libghc-lifted-base-dev \
                  libghc-test-framework-quickcheck2-dev \
                  libghc-test-framework-hunit-dev libghc-temporary-dev \
                  libghc-old-time-dev libghc-old-time-dev \
                  libghc-lifted-base-dev libghc-temporary-dev \
                  libpcre3-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 \
                  ghc-hslogger-devel ghc-text-devel \
                  ghc-regex-pcre-devel

The most recent Fedora doesn’t provide inotify. So these need to be installed using cabal.

If using a distribution which does not provide these libraries, first install the Haskell platform. Then run:

$ cabal update

Then install the additional native libraries:

$ apt-get install libpcre3-dev libcurl4-openssl-dev

And finally the libraries required for building the packages via cabal (it will automatically pick only those that are not already installed via your distribution packages):

$ cabal install --only-dependencies cabal/ganeti.template.cabal

Haskell optional features

Optionally, more functionality can be enabled if your build machine has a few more Haskell libraries enabled: the ganeti-confd daemon (--enable-confd), the monitoring daemon (--enable-monitoring) and the meta-data daemon (--enable-metadata). The extra dependencies for these are:

These libraries are available in Debian Wheezy or later, so you can use either apt:

$ apt-get install libghc-snap-server-dev libghc-psqueue-dev

or cabal:

$ cabal install --only-dependencies cabal/ganeti.template.cabal \
                --flags="confd mond metad"

to install them.

Note

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

This will install the software under /usr/local. Depending on your init system you then need to copy doc/examples/ganeti.initd to /etc/init.d/ganeti or install the respective systemd unit files provided in doc/examples/systemd/. Also, Ganeti uses symbolic links in the sysconfdir to determine, which of potentially many installed versions currently is used. If these symbolic links should be added by the install as well, add the option --enable-symlinks to the configure call.

Cluster initialisation

Before initialising the cluster, on each node you need to create the following directories:

  • /etc/ganeti
  • /var/lib/ganeti
  • /var/log/ganeti
  • /srv/ganeti
  • /srv/ganeti/os
  • /srv/ganeti/export

After this, use gnt-cluster init.