Statistics
| Branch: | Tag: | Revision:

root / INSTALL @ 54f834df

History | View | Annotate | Download (6.1 kB)

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/>`_, version
32
  1.4.6 or above
33
- `pyinotify Python module <http://trac.dbzteam.org/pyinotify/>`_
34
- `PycURL Python module <http://pycurl.sourceforge.net/>`_
35
- `ctypes Python module
36
  <http://starship.python.net/crew/theller/ctypes/>`_, if running on
37
  python 2.4 (optional, used for node daemon memory locking)
38
- `socat <http://www.dest-unreach.org/socat/>`_, see :ref:`note
39
  <socat-note>` below
40
- `Paramiko <http://www.lag.net/paramiko/>`_, if you want automated SSH
41
  setup; optional otherwise but manual setup of the nodes required
42
- `affinity Python module <http://pypi.python.org/pypi/affinity/0.1.0>`_,
43
  optional python package for supporting CPU pinning under KVM
44

    
45
These programs are supplied as part of most Linux distributions, so
46
usually they can be installed via the standard package manager. Also
47
many of them will already be installed on a standard machine. On
48
Debian/Ubuntu, you can use this command line to install all required
49
packages, except for DRBD and Xen::
50

    
51
  $ apt-get install lvm2 ssh bridge-utils iproute iputils-arping \
52
                    ndisc6 python python-pyopenssl openssl \
53
                    python-pyparsing python-simplejson \
54
                    python-pyinotify python-pycurl socat
55

    
56
If you want to also enable the `htools` components, which is recommended
57
on bigger deployments (they give you automatic instance placement,
58
cluster balancing, etc.), then you need to have a Haskell compiler
59
installed. More specifically:
60

    
61
- `GHC <http://www.haskell.org/ghc/>`_ version 6.10 or higher
62
- or even better, `The Haskell Platform
63
  <http://hackage.haskell.org/platform/>`_ which gives you a simple way
64
  to bootstrap Haskell
65
- `json <http://hackage.haskell.org/package/json>`_, a JSON library
66
- `network <http://hackage.haskell.org/package/network>`_, a basic
67
  network library
68
- `parallel <http://hackage.haskell.org/package/parallel>`_, a parallel
69
  programming library (note: tested with up to version 3.x)
70
- `curl <http://hackage.haskell.org/package/curl>`_, bindings for the
71
  curl library, only needed if you want these tools to connect to remote
72
  clusters (as opposed to the local one)
73

    
74
All of these are also available as package in Debian/Ubuntu::
75

    
76
  $ apt-get install ghc6 libghc6-json-dev libghc6-network-dev \
77
                    libghc6-parallel-dev libghc6-curl-dev
78

    
79
Note that more recent version have switched to GHC 7.x and the packages
80
were renamed::
81

    
82
  $ apt-get install ghc libghc-json-dev libghc-network-dev \
83
                    libghc-parallel-dev libghc-curl-dev
84

    
85
The compilation of the htools components is automatically enabled when
86
the compiler and the requisite libraries are found. You can use the
87
``--enable-htools`` configure flag to force the selection (at which
88
point ``./configure`` will fail if it doesn't find the prerequisites).
89

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

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

    
103
  To remedey this situation, patches implementing a new ``socat`` option
104
  for disabling OpenSSL compression have been contributed and will
105
  likely be included in the next feature release. Until then, users or
106
  distributions need to apply the patches on their own.
107

    
108
  Ganeti will use the option if it's detected by the ``configure``
109
  script; auto-detection can be disabled by explicitely passing
110
  ``--enable-socat-compress`` (use the option to disable compression) or
111
  ``--disable-socat-compress`` (don't use the option).
112

    
113
  The patches and more information can be found on
114
  http://www.dest-unreach.org/socat/contrib/socat-opensslcompress.html.
115

    
116

    
117
Installation of the software
118
----------------------------
119

    
120
To install, simply run the following command::
121

    
122
  ./configure --localstatedir=/var --sysconfdir=/etc && \
123
  make && \
124
  make install
125

    
126
This will install the software under ``/usr/local``. You then need to
127
copy ``doc/examples/ganeti.initd`` to ``/etc/init.d/ganeti`` and
128
integrate it into your boot sequence (``chkconfig``, ``update-rc.d``,
129
etc.).
130

    
131

    
132
Cluster initialisation
133
----------------------
134

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

    
138
- ``/etc/ganeti``
139
- ``/var/lib/ganeti``
140
- ``/var/log/ganeti``
141
- ``/srv/ganeti``
142
- ``/srv/ganeti/os``
143
- ``/srv/ganeti/export``
144

    
145
After this, use ``gnt-cluster init``.
146

    
147
.. vim: set textwidth=72 syntax=rst :
148
.. Local Variables:
149
.. mode: rst
150
.. fill-column: 72
151
.. End: